opFlow Configuration
- Mark Unwin
- Jonathan O'Brien (Unlicensed)
Owned by Mark Unwin
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
The items below are commonly changed by customers.
| Section | Name | Original Value | Description |
|---|---|---|---|
| opflow | opflow_conversation_age_days | 30 | for act=purge if not capped |
| opflow | opflow_gui_interface_integrated_index | 1 | |
| opflow | opflow_gui_default_period | 60m | The default period of time to dis0lay statistics in the GUI. |
| opflow | opflow_url_base | http://yourserver.yourdomain/ | for creating links in emails, reports |
| opflow | opflow_gui_refresh_time | 180 | Seconds until GUI refreshes itself. |
| opflow | opflow_resolve_endpoint_dns | false | if false, endpoint addresses are not resolved via dns |
| opflow | opflow_db_query_timeout | 120*1000 | 2 minute DB query timeout. |
Specific Configuration
The opFlow section of opCommon.nmis is for opFlow specific configuration items only.
| Section | Name | Original Value | Possible Values | Description | |
|---|---|---|---|---|---|
| opflow | <opflow_dir> | /var/lib/nfdump | <filepath> | where nfdump inputs are expected, and saved dailies are kept | |
| opflow | opflow_batch_insert_size | 256 | <integer> | ||
| opflow | opflow_check_time | 5 | <integer> | check for ready nfdump files every X seconds | |
| opflow | opflow_conversation_age_days | 30 | <integer> | for act=purge if not capped | |
| opflow | opflow_db_conversations_collection_size | 16106127360 | <integer> | 15 GB | |
| opflow | opflow_db_flows_collection_size | 5368709120 | <integer> | 5 GB | |
| opflow | opflow_db_name | flows | |||
| opflow | opflow_db_query_timeout | 120*1000 | 120 seconds | ||
| opflow | opflow_default_duration | 0.1 | <decimal> | ||
| opflow | opflow_default_flows | 1 | <integer> | ||
| opflow | opflow_default_packets | 1 | <integer> | for NSEL flows that carry only bytes | |
| opflow | opflow_drop_endpoints | 1.1.1.1|1.21.1.1 | |||
| opflow | opflow_endpoint_age_days | 90 | <integer> | how long endpoints w/o activity should be kept | |
| opflow | opflow_gui_agent_custom_button_text | Button Text | Custom agent button | ||
| opflow | opflow_gui_agent_custom_button_url | https://example.com/omk/opCharts/inventory/interfaces | <url> | Custom agent button | |
| opflow | opflow_gui_default_period | 60m | |||
| opflow | opflow_gui_default_summary_type | app_source | "application", "app_source", "app_destination", "app_conversation", "dst_ip", "src_ip", "tos" | ||
| opflow | opflow_gui_display_other | 0 | <integer> | ||
| opflow | opflow_gui_graph_over_time_per_sec | 1 | <integer> | ||
| opflow | opflow_gui_hide_interface_performance_graphs | 0 | <integer> | Option to hide the button Interface Performance Graphs | |
| opflow | opflow_gui_high_flow_volume | 1 | <integer> | ||
| opflow | opflow_gui_interface_integrated_index | 1 | <integer> | ||
| opflow | opflow_gui_no_flows_over_time_graph | 0 | <integer> | ||
| opflow | opflow_gui_octet_decimals | 0 | <integer> | ||
| opflow | opflow_gui_octet_display_multiplier | 1 | <integer> | 0.000000953674316 | |
| opflow | opflow_gui_period_values | ['15m','30m','60m','90m','2h','4h','8h','12h','24h','2d'] | |||
| opflow | opflow_gui_refresh_time | 180 | <integer> | Seconds until GUI refreshes itself. | |
| opflow | opflow_high_volume | 1 | <integer> | insert pre-aggregated flows if set, raw flows if not. | |
| opflow | opflow_input_maxage | 0 | <integer> | if set to positive N, ignore flow files older than N seconds | |
| opflow | opflow_opcharts_password | nm1888 | <password> | ||
| opflow | opflow_opcharts_url_base | <url> | base url of remote opCharts server, eg http://other.host.com (no slash at the end) | ||
| opflow | opflow_opcharts_user | nmis | <username> | ||
| opflow | opflow_opstatus_maxage | 1209600 | <integer> | seconds, 2 weeks | |
| opflow | opflow_raw_files_age_days | 10 | <integer> | how long to keep old nfdump files | |
| opflow | opflow_raw_flows_age_days | 10 | <integer> | as above | |
| opflow | opflow_remote_flow_processing | 0 | <integer> | if flows are proccessed/inserted from a different server set this to 1 | |
| opflow | opflow_reports_default_css | <omk_public>/omk/css/opFlow_report.css | <relative url> | copied into the report output dir if not present | |
| opflow | opflow_reports_default_js | <omk_public>/omk/js/opFlow_report.js | <relative url> | copied into the report output dir if not present | |
| opflow | opflow_reports_keep | 365 | <integer> | days to keep report data | |
| opflow | opflow_reports_keep_topn | 50 | <integer> | maximum for report generation | |
| opflow | opflow_resolve_endpoint_dns | false | true, false | if false, endpoint addresses are not resolved via dns | |
| opflow | opflow_server | nmis | |||
| opflow | opflow_summarisation_interval | 120 | <integer> | bucket size for conversation aggregation | |
| opflow | opflow_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 | ||
| opflow | opflow_url_base | http://yourserver.yourdomain/ | <url> | for creating links in emails, reports | |
| opflow | opflowd_max_processes | 4 | <integer> | ||
| opflow | opflowd_pid | /var/run/opflowd.pid | <filepath> |