opReports Configuration
opReports Configuration
The configuration options for opReports are stored in a text file /usr/local/omk/conf/opCommon.nmis.
Configuration items that are not application specific are detailed on the opCommon Configuration page.
Common Settings to Consider Adjusting
The items below are commonly changed by customers.
Section | Name | Original Value | Description |
|---|---|---|---|
opreports | opreports_opcharts_password | nm1888 | opreports needs a user with read only access |
opreports | opreports_url_base | for creating links in emails, reports |
Specific Configuration
The opReports section of opCommon.nmis is for opReports specific configuration items only.
Section | Name | Original Value | Possible Values | Description |
|---|---|---|---|---|
opreports | opreports_application_heading | undef | ||
opreports | opreports_do_cache_known_reports | undef | ||
opreports | default_report_timezone | AEST | ||
opreports | opreports_embedded_graph_size | [600,150] | these are final sizes | |
opreports | opreports_embedded_graph_size_small | [300,75] | these are final sizes | |
opreports | opreports_embedded_nmis_graph_size | [452,113] | these are not final, dynamically adjusted based on graph content | |
opreports | opreports_embedded_nmis_graph_size_small | [300,50] | these are not final, dynamically adjusted based on graph content | |
opreports | opreports_url_base | <url> | ||
opreports | opreports_max_interface_util | |||
opreports | opreports_opcharts_url_base | <url> | base of opCharts server, eg http://localhost:8042 (no slash at the end) | |
opreports | opreports_opcharts_user | nmis | <username> | user needs ro-access |
opreports | opreports_opcharts_password | nm1888 | <password> | |
opreports | opreports_default_css | <omk_public>/omk/css/opReports_report.css | <relative url> | copied into the report output dir if not present; included in zip and emailed reports |
opreports | opreports_default_js | <omk_public>/omk/js/opReports_report.js | <relative url> | copied into the report output dir if not present; included in zip and emailed reports |
opreports | opreports_pdf_css | <omk_public>/omk/css/opReports_report_pdf.css | <filepath> | used to specify a stylesheet to be used when rendering PDF reports (from their HTML source). If not specified, the renderer will use the default styling in |
opreports | opreports_default_closing_image | undef | <filepath> | a custom image (normally branding) to be shown as at the end of a generated PDF report |
opreports | opreports_pdf_orientation | portrait | "landscape" | "portrait" | whether to render the PDF report in landscape or portrait orientation |
opreports | opreports_wkhtmltopdf_path | undef | <filepath> | used to specify the location of the wkhtmltopdf binary. the system will otherwise detect it from expected paths. |
opreports | opreports_custom_files | undef | list of other files (e.g. logos) to copy/include with html reports e.g. [ '/path/to/my/logo.png', '/some/other/file.jpg' ] | |
opreports | opreports_output_dirs | [ '<omk_reports>' ] | <relative filepaths> | authorized output directories for opreports on-demand reports are always saved in <omk_reports_ondemand> |
opreports | opreports_availability_nodata_separate | false | true, false | availability report: treat 'no data' periods as separate from up/down, or include those in up? |
opreports | opreports_availability_average_packetloss | false | true, false | availability report: 'opreports_availability_average_packetloss' defaults to false: |
opreports | opreports_ms_availability_strict | false | true, false | monitored_services report: treat 'no data' periods as 'not down' unless 'opreports_ms_availability_strict' set 'true': defaults to false |
opreports | default_report_keep_for | { 'daily' => 40, 'weekly' => 48*7, 'monthly' => 24*31, 'yearly' => 5*365, 'on-demand' => 42 } | how many days scheduled reports are kept if the schedule doesn't specify a limit and also covers on-demand reports via the pseudo-frequency 'on-demand' | |
opreports | opreports_selftest_rules | { 'last_scheduler' => 3*3600, 'min_diskfree' => 10, 'max_jobage' => 3*3600 } | ||
opreports | report_ups_configured_models | POWERALERT-APC' => { | configuration settings for UPS Configured Models Report: | |
opreports | report_wan_levels | 1' => { | # known extras that can be specified: | |
opreports | report_summary_levels | Low' => { "threshold" => -1, | for the link categorisation in the traffic summary report threshold is compared against utilisation (lowest cat with util > threshold is chosen) | |
opreports | report_jcos_levels | default' => { | for colorisation of the juniper cos report | |
opreports | report_groupedavailability_levels | default' => { | for categorisation and coloration of the grouped availability report | |
opreports | report_node_availability_colors | down' => '#d9534f', | for custom node availability colors. | |
report_snapshot_levels | binary | "Low" => { "color" => "green", "description" => "Low Util", "threshold" => -1 }, | for colorisation in the traffic snapshot report threshold is compared against utilisation (lowest cat with util > threshold is chosen) | |
report_snapshot_levels | quarters | lowest' => { 'color' => "#93cc5e", "description" => "<10%", threshold => -1 }, | for colorisation in the traffic snapshot report threshold is compared against utilisation (lowest cat with util > threshold is chosen) | |
report_snapshot_levels | fifths | "lowest" =>{"color" =>"#004d00", | for colorisation in the traffic snapshot report threshold is compared against utilisation (lowest cat with util > threshold is chosen) | |
report_wan_distributions | Default WAN Distribution Levels Descending | "group4" =>{ | ||
report_wan_distributions | Default WAN Distribution Levels Ascending | "group1" =>{ | groupings for wan utilization distribution reports: | |
opreport_rules | condition_low_wanutil | false | true, false | false: define acceptable utilisation as anything below wantil_high. |
opreport_rules | cpu_veryhigh | 30 | <integer> | |
opreport_rules | cpu_high | 20 | <integer> | |
opreport_rules | cpu_moderate | 12 | <integer> | |
opreport_rules | cpu_exception_threshold | 20 | <integer> | |
opreport_rules | mem_free_verylow | 10 | <integer> | |
opreport_rules | mem_free_low | 25 | <integer> | |
opreport_rules | iomem_free_verylow | 10 | <integer> | |
opreport_rules | iomem_free_low | 25 | <integer> | |
opreport_rules | swap_veryhigh | 50 | <integer> |