opEvents Configuration

The configuration options for opEvents are stored in a json formatted text file: /usr/local/omk/conf/opCommon.json.

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
opevents	opevents_event_status_values	[{'status' : 'Detected'},{'status' : 'Investigating'},{'status' : 'Resolved'}]	Values which the operator can select. If enabled or the event has the status property, a select box will be rendered in the event context panel. To configure to work for your team, decide on what fields you want to include in your status.
opevents	opevents_url_base	http://yourserver.yourdomain	For creating links in emails
opevents	opevents_max_period_value	90d	If N[dhm], any requests for longer periods are truncated
opevents	opeventsd_restart_on_config_change	false	Should the daemon restart if a config change is detected, such as EventActions.json. Recommended to only be turned on in test environments
opevents	opevents_hostname	localhost	For the hostname in the syslog events

Specific Configuration

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

Section	Name	Original Value	Possible Values	Description
opevents	black_list_enabled	true	true, false
opevents	log_archive_enabled	true	true, false
opevents	nmis_non_stateful_events	Node Configuration Change\|Node Reset
opevents	opevents_action_max_runtime	30	<integer>	how long an asynchronous policy action process may run (Seconds value)
opevents	opevents_action_policy	<omk_conf>/EventActions.nmis	<relative filepath>
opevents	opevents_application_heading
opevents	opevents_archivelogs_purge_older_than	365d		archive logs (format NN[dhm]..., plain N means N minutes. 0 or undef means no purging).
opevents	opevents_auto_acknowledge	true	true, false	auto-acknowledge the down event on state down->up or not?
opevents	opevents_auto_acknowledge_up	true	true, false	if opevents_auto_acknowledge is on, also acknowledge the up event?
opevents	opevents_auto_create_nodes	false	true, false	If true an event from a node that does not exists then opEvents will automatically create a node entry.
opevents	opevents_contacts	<omk_conf>/Contacts.nmis
opevents	opevents_correlation_node	global		Node Name that will appear in correlated events
opevents	opevents_daily_report_recipients			Who to send Daily Event Reports to, email setup is required
opevents	opevents_daily_report_title	Daily Summary Report
opevents	opevents_debug	0	<integer>	for troubleshooting purposes, use to increase log verbosity. Make sure to change back to default as log will ballon
opevents	opevents_emails	<omk_conf>/EventEmails.nmis	<relative filepath>	Where to find opEvent Email templates
opevents	opevents_event_rules	<omk_conf>/EventRules.nmis	<relative filepath>
opevents	opevents_event_status_default_value			For use with "opevents_event_status_values"
opevents	opevents_event_status_enabled	false	true, false	If true opevents_event_status_values will be added to events
opevents	opevents_event_status_values	[{'status' : 'Detected'},{'status' : 'Investigating'},{'status' : 'Resolved'}]		An array
opevents	opevents_events_purge_older_than	180d		events and actions (format NN[dhm]..., plain N means N minutes. 0 or undef means no purging).
opevents	opevents_flap_name	event.stateful Flap		node.X, event.Y and macro.Z are substituted
opevents	opevents_gui_console_default_period	2h		Events in the last X timeframe will be loaded
opevents	opevents_gui_console_pagination	[10,10]		How many rows to load. Separate for top and bottom panels
opevents	opevents_gui_current_events_priorities	[3,10]	3, 4, 5, 6, 7, 8, 9, 10	Only priorities 3..10 are included in current events view
opevents	opevents_gui_dashboard_default_period	2h		Events in the last X timeframe will be loaded
opevents	opevents_gui_dashboard_pagination	10	<integer>	Default records per page for dashboard, event list and event console pages
opevents	opevents_gui_default_period	2h		Default period for the gui screens: general and node/event context pages
opevents	opevents_gui_event_context_period	2h		How much time before/after an event to consider for context
opevents	opevents_gui_event_context_summary_list
opevents	opevents_gui_event_node_summary_list	["name","group","location","customer","businessService","host"]		Default list for opevents' mail template use, also gui for event-related node context
opevents	opevents_gui_events_coloring	true	true, false	Color events by severity
opevents	opevents_gui_events_pagination	25	<integer>
opevents	opevents_gui_node_summary_list	["name","group","location","customer","businessService","host"]		Default property list for opevents' gui, for node context
opevents	opevents_gui_period_values	['15m','30m','1h','90m','2h','4h','8h','12h','1d', '2d', '15d', '30d', '60d', '90d' ]
opevents	opevents_hostname	localhost	<hostname>	For the hostname in the syslog events
opevents	opevents_import_node_interfaces	true	true, false
opevents	opevents_import_nodes_activated	true	true, false
opevents	opevents_kb_link_title	KB Lookup
opevents	opevents_kb_link_url	https://community.opmantek.com/x/%s	<url>
opevents	opevents_list_rules	<omk_conf>/EventListRules.nmis	<relative filepath>
opevents	opevents_logs			See Documentation
opevents	opevents_max_action_queue_age	3600	<integer>	Abort action processing if action queued longer than N seconds (set to zero to disable).
opevents	opevents_max_event_age	7200	<integer>	Ignore input events older than N seconds (set to zero to disable).
opevents	opevents_max_period_value	90d		If N[dhm], any requests for longer periods are truncated
opevents	opevents_max_time_delta	0	<integer>
opevents	opevents_monthly_report_recipients			Who to email Monthly report too, email setup is required
opevents	opevents_monthly_report_title	Monthly Summary Report
opevents	opevents_move_json_logs	<nmis_logs>/json/historic		If set, move consumed json log files into this directory, if unset, remove consumed json log files
opevents	opevents_nmis_rules	<omk_conf>/EventNmisRules.nmis	<relative filepath>
opevents	opevents_no_action_on_flap	true	true, false	skip actions on flap detected?
opevents	opevents_parser_rules	<omk_conf>/EventParserRules.nmis	<relative filepath>	Generic parsers can be defined in this file
opevents	opevents_plugin_max_runtime	5	<integer>	Parser plugins may run that long (Seconds value)
opevents	opevents_rawlogs_purge_older_than	90d		raw logs (format NN[dhm]..., plain N means N minutes. 0 or undef means no purging).
opevents	opevents_refresh_time	120		Seconds value
opevents	opevents_report_mininterval	900		granularity for interval reporting
opevents	opevents_reports_purge_older_than	730d		summary reports (format NN[dhm]..., plain N means N minutes. 0 or undef means no purging).
opevents	opevents_reschedule_action_age	180	<integer>	Reschedule action after X seconds if worker died
opevents	opevents_search_link_title
opevents	opevents_search_link_url	https://duckduckgo.com/html/?q=%s	<url>
opevents	opevents_standard_path	/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin	<filepath>	If you want opeventsd to use a specific path for itself and the programs that it runs in event actions, set it here
opevents	opevents_syslog_rules	<omk_conf>/EventSyslogRules.nmis	<relative filepath>
opevents	opevents_tivoli_rules	<omk_conf>/EventTivoliRules.nmis	<relative filepath>
opevents	opevents_trap_rules	<omk_conf>/EventTrapRules.nmis	<relative filepath>	DEPRECATED
opevents	opevents_url_base	http://yourserver.yourdomain	<url>	For creating links in emails
opevents	opevents_warn_overdue_actions	100	<integer>	Warn if there are more than N overdue queued actions (set to zero to disable).
opevents	opevents_warn_overdue_events	100	<integer>	Warn if there are more than N queued events that are overdue for processing (set to zero to disable).
opevents	opevents_weekly_report_recipients			Who to send Weekly report to
opevents	opevents_weekly_report_title	Weekly Summary Report
opevents	opeventsd	<omk_base>/bin/opeventsd.pl	<relative filepath>
opevents	opeventsd_cache	<omk_var>/opeventsd.nmis	<relative filepath>
opevents	opeventsd_file_cycle	4	<integer>	wake up every N seconds, check for files
opevents	opeventsd_max_cycles		<integer>	parameter will restart the opeventsd daemon every X cycles, so in case there is any issue or if the process is stuck or blocked, after the restart the problem should be solved. It could be adjusted to a longer period - like 300 or 3000 - so the restart can happen only once a day.
opevents	opeventsd_max_processes	10	<integer>	how many workers to run at most, at any time
opevents	opeventsd_pid	/var/run/opeventsd.pid	<filepath>
opevents	opeventsd_queue_cycle	3	<integer>	wake up every N seconds, check for queued events
opevents	opeventsd_restart_on_config_change	false	true, false
opevents	raw_log_black_list	true	true, false
opevents	raw_log_enabled	true	true, false
opevents	state_flap_window	90	<integer>
opevents	state_reorder_window	0	<integer>	If set to positive N, external events may be delayed for up to N seconds for reordering
opevents	white_list_enabled	false	true, false

opEvents

opEvents Configuration Settings

opEvents Configuration

Specific Configuration

Related content