Child pages
  • opEvents Summary Reports

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
'opevents' => {
  # lots of other directives
  'opevents_report_mininterval' => 900,     # granularity for interval reporting
  'opevents_daily_report_title' => "Daily Summary Report",
  'opevents_daily_report_recipients' => [], # list of email addresses for automatic mailout
  'opevents_weekly_report_title' => "Weekly Summary Report",
  'opevents_weekly_report_recipients' => [], # list of email addresses for automatic mailout
  'opevents_monthly_report_title' => "Monthly Summary Report",
  'opevents_monthly_report_recipients' => [], # list of email addresses for automatic mailout
  # other directives
},

 

 



DirectiveDescription
opevents_daily_report_title,
opevents_weekly_report_title,
opevents_monthly_report_title

This sets the title for the automatically generated summary report for the respective period.
This setting is optional (but highly recommended).
If such a report is emailed to anybody, then the title is also used as the email's Subject.

opevents_daily_report_recipients,
opevents_weekly_report_recipients,
opevents_monthly_report_recipients

This setting is optional. If set to a list of email addresses, then the respective report is emailed to all the listed recipients.
Please note that email addresses must be enclosed in single quotes, e.g.

'opevents_monthly_report_recipients' => [ 'first@recipie.nt', 'other@pers.on' ]
opevents_report_minintervalThis sets the minimum summarisation interval (i.e. the highest available precision). The default is 15 minutes.
Reports can be viewed (and saved) with integral multiples of this interval only.

 


Display and Summarisation options

...

Code Block
$ /usr/local/omk/bin/opeventsdopevents-cli.exepl act=create-report
Usage: opeventsd.pl act=create-report {start=<time/date> end=<time/date> | [daily|weekly|monthly]=true} 
  [topn=N] [summary_int=NM[dhm]] [path=<outputfile.xlsx] [email=X@Y.Z] [title=...]
All standard opEvents time formats can be used for start and end.
If topn or summary_int are given, then the report is summarized 
with these values instead of the defaults for the given report duration.
If one or more email=X options are given, then the report is emailed 
to these addresses.
If daily, weekly or monthly is true, then the start/end is optional and the 
report is emailed to all configured or given email recipients.
If a path is given, then the report is saved in that XLSX file.