Versions Compared

Key

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

Table of Contents

opFlow Configuration

The configuration options for opFlow 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

Some The items below are commonly changed by customers - link to page.

SectionNameOriginal ValueDescription
opflowopflow_conversation_age_days30for act=purge if not capped
opflowopflow_gui_interface_integrated_index1
opflowopflow_gui_default_period60mThe default period of time to dis0lay statistics in the GUI.
opflowopflow_url_basehttp://yourserver.yourdomain/for creating links in emails, reports
opflowopflow_gui_refresh_time180Seconds until GUI refreshes itself.
opflowopflow_resolve_endpoint_dnsfalseif false, endpoint addresses are not resolved via dns
opflowopflow_db_query_timeout120*10002 minute DB query timeout.

Specific Configuration

The opFlow section of opCommon.nmis is for opFlow specific configuration items only.

...

SectionNameOriginal Value
Possible ValuesDescription
opflow<opflow_dir>/var/lib/nfdump
<filepath>where nfdump inputs are expected, and saved dailies are kept
opflowopflow_batch_insert_size256
<integer>
opflowopflow_check_time5
<integer>check for ready nfdump files every X seconds
opflowopflow_conversation_age_days30
<integer>for act=purge if not capped
opflowopflow_db_conversations_collection_size16106127360
<integer>15 GB
opflowopflow_db_flows_collection_size5368709120
<integer>5 GB
opflowopflow_db_nameflows


opflowopflow_db_query_timeout120*1000

120 seconds
opflowopflow_default_duration0.1
<decimal>
opflowopflow_default_flows1
<integer>
opflowopflow_default_packets1
<integer>for NSEL flows that carry only bytes
opflowopflow_drop_endpoints1.1.1.1|1.21.1.1


opflowopflow_endpoint_age_days90
<integer>how long endpoints w/o activity should be kept
opflowopflow_gui_agent_custom_button_textButton Text

Custom agent button
opflowopflow_gui_agent_custom_button_urlhttps://example.com/omk/opCharts/inventory/interfaces
<url>Custom agent button
opflowopflow_gui_default_period60m


opflowopflow_gui_default_summary_typeapp_source
"application", "app_source", "app_destination", "app_conversation", "dst_ip", "src_ip", "tos"
opflowopflow_gui_display_other0
<integer>
opflowopflow_gui_graph_over_time_per_sec1
<integer>
opflowopflow_gui_hide_interface_performance_graphs0
<integer>Option to hide the button Interface Performance Graphs
opflowopflow_gui_high_flow_volume1
<integer>
opflowopflow_gui_interface_integrated_index1
<integer>
opflowopflow_gui_no_flows_over_time_graph0
<integer>
opflowopflow_gui_octet_decimals0
<integer>
opflowopflow_gui_octet_display_multiplier1
<integer>0.000000953674316
opflowopflow_gui_period_values['15m','30m','60m','90m','2h','4h','8h','12h','24h','2d']


opflowopflow_gui_refresh_time180
<integer>Seconds until GUI refreshes itself.
opflowopflow_high_volume1
<integer>insert pre-aggregated flows if set, raw flows if not.
opflowopflow_input_maxage0
<integer>if set to positive N, ignore flow files older than N seconds
opflowopflow_opcharts_passwordnm1888
<password>
opflowopflow_opcharts_url_base

<url>base url of remote opCharts server, eg http://other.host.com (no slash at the end)
opflowopflow_opcharts_usernmis
<username>
opflowopflow_opstatus_maxage1209600
<integer>seconds, 2 weeks
opflowopflow_raw_files_age_days10
<integer>how long to keep old nfdump files
opflowopflow_raw_flows_age_days10
<integer>as above
opflowopflow_remote_flow_processing0
<integer>if flows are proccessed/inserted from a different server set this to 1
opflowopflow_reports_default_css<omk_public>/omk/css/opFlow_report.css
<relative url>copied into the report output dir if not present
opflowopflow_reports_default_js<omk_public>/omk/js/opFlow_report.js
<relative url>copied into the report output dir if not present
opflowopflow_reports_keep365
<integer>days to keep report data
opflowopflow_reports_keep_topn50
<integer>maximum for report generation
opflowopflow_resolve_endpoint_dnsfalse
true, falseif false, endpoint addresses are not resolved via dns
opflowopflow_servernmis


opflowopflow_summarisation_interval120
<integer>bucket size for conversation aggregation
opflowopflow_summary_stages{ 'hourly- => { period => 3600, collection_size => 1073741824, collapse_min_bytes => 1024, collapse_min_pkts => 5} }

what long-term summarizations should be performed, 1GB, collapse all conversations with less than X bytes of traffic in the whole period into one, set to zero/undef to disable, or winnow by minimum number of packets. a match of either criterion will cause collapsing
opflowopflow_url_basehttp://yourserver.yourdomain/
<url>for creating links in emails, reports
opflowopflowd_max_processes4
<integer>
opflowopflowd_pid/var/run/opflowd.pid
<filepath>

...