Performance data parameters

Performance Data Processor Command Timeout

Format:

 

perfdata_timeout=<seconds>

Example:

 

perfdata_timeout=5

This is the maximum number of seconds that Shinken will allow a host performance data processor command  or service performance data processor command to be run. If a command exceeds this time limit it will be killed and a warning will be logged.

 

Performance Data Processing Option

Format:

 

process_performance_data=<0/1>

Example:

 

process_performance_data=1

This value determines whether or not Shinken will process host and service check performance data.

 

Host/Service Performance Data Processing Command

Format:

 

host_perfdata_command=<configobjects/command>
service_perfdata_command=<configobjects/command>

Example:

 

host_perfdata_command=process-host-perfdata
service_perfdata_command=process-service-perfdata

This option allows you to specify a command to be run after every host/service check to process host/service performance data that may be returned from the check. The command argument is the short name of a command definition that you define in your object configuration file. This command is only executed if the Performance Data Processing Option option is enabled globally and if the "process_perf_data" directive in the host definition is enabled.

 

Advanced scheduling parameters

Orphaned Host/Service Check Option 

Format:

 

check_for_orphaned_services=<0/1>
check_for_orphaned_hosts=<0/1>

Example:

 

check_for_orphaned_services=1
check_for_orphaned_hosts=1

This option allows you to enable or disable checks for orphaned service/host checks. Orphaned checks are checks which have been launched to pollers but have not had any results reported in a long time.

Since no results have come back in for it, it is not rescheduled in the event queue. This can cause checks to stop being executed. Normally it is very rare for this to happen - it might happen if an external user or process killed off the process that was being used to execute a check.

If this option is enabled and Shinken finds that results for a particular check have not come back, it will log an error message and reschedule the check. If you start seeing checks that never seem to get rescheduled, enable this option and see if you notice any log messages about orphaned services.

 

 

Performance tuning

Cached Host/Service Check Horizon 

Format:

 

cached_host_check_horizon=<seconds>
cached_service_check_horizon=<seconds>

Example:

 

cached_host_check_horizon=0
cached_service_check_horizon=0

This option determines the maximum amount of time (in seconds) that the state of a previous host check is considered current. Cached host states (from host/service checks that were performed more recently than the time specified by this value) can improve host check performance immensely. Too high of a value for this option may result in (temporarily) inaccurate host/service states, while a low value may result in a performance hit for host/service checks. Use a value of 0 if you want to disable host/service check caching.

 

Flapping parameters 

Flap Detection Option

Format:

 

enable_flap_detection=<0/1>

Example:

 

enable_flap_detection=1

This option determines whether or not Shinken will try and detect hosts and services that are “flapping". Flapping occurs when a host or service changes between states too frequently, resulting in a barrage of notifications being sent out. When Shinken detects that a host or service is flapping, it will temporarily suppress notifications for that host/service until it stops flapping.

More information on how flap detection and handling works can be found here <advanced/flapping>`.



Low Service/Host Flap Threshold

Format:

 

low_service_flap_threshold=<percent>
low_host_flap_threshold=<percent>

Example:

 

low_service_flap_threshold=25.0
low_host_flap_threshold=25.0

This option is used to set the low threshold for detection of host/service flapping. For more information on how flap detection and handling works (and how this option affects things) read this.

 

High Service/Host Flap Threshold

Format:

 

high_service_flap_threshold=<percent>
high_host_flap_threshold=<percent>

Example:

 

high_service_flap_threshold=50.0
high_host_flap_threshold=50.0

This option is used to set the high threshold for detection of host/service flapping. For more information on how flap detection and handling works (and how this option affects things) read this.

 

Various commands Timeouts

Format:

 

event_handler_timeout=<seconds> # default: 30s
notification_timeout=<seconds> # default: 30s

Example:

 

event_handler_timeout=60
notification_timeout=60


This is the maximum number of seconds that Shinken will allow event handlers & notification to be run. If an command exceeds this time limit it will be killed and a warning will be logged.

There is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off commands which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more for notification), so that each event handler command normally finishes executing within this time limit. If an event handler runs longer than this limit, Shinken will kill it off thinking it is a runaway processes.

 

Freshness check 

Host/Service Freshness Checking Option

Format:

 

check_service_freshness=<0/1>
check_host_freshness=<0/1>

Example:

 

check_service_freshness=0
check_host_freshness=0

This option determines whether or not Shinken will periodically check the “freshness" of host/service checks. Enabling this option is useful for helping to ensure that passive service checks are received in a timely manner. More information on freshness checking can be found here.

 

Host/Service Freshness Check Interval

Format:

 

service_freshness_check_interval=<seconds>
host_freshness_check_interval=<seconds>

Example:

 

service_freshness_check_interval=60
host_freshness_check_interval=60

This setting determines how often (in seconds) Shinken will periodically check the “freshness" of host/service check results. If you have disabled host/service freshness checking (with the check_service_freshness option), this option has no effect. More information on freshness checking can be found here.

 

Resource File

Format

 

resource_file=<file_name>

Example:

 

resource_file=/etc/shinken/resource.cfg

This is used to specify an optional resource file that can contain "$USERn$" Understanding Macros/Data and How They Work definitions. "$USERn$" macros are useful for storing usernames, passwords, and items commonly used in command definitions (like directory paths).
A classical variable used is $USER1$, used to store the plugins path, "/usr/lib/nagios/plugins" on a classic installation.

 

Notifications Option

Format:

 

enable_notifications=<0/1>

Example:

 

enable_notifications=1

This option determines whether or not Shinken will send out notifications. If this option is disabled, Shinken will not send out notifications for any host or service.

Values are as follows:

 

Log Rotation Method (Not fully implemented)

Format:

 

log_rotation_method=<d>

Example:

 

log_rotation_method=d

This is the rotation method that you would like Shinken to use for your log file on the broker server . Values are as follows:

 

 

External Command Check Option

Format:

 

check_external_commands=<0/1>

Example:

 

check_external_commands=1

This option determines whether or not Shinken will check the External Command File for commands that should be executed with the arbiter daemon .

 

Scheduling parameters

Service/Host Check Execution Option

Format:

 

execute_service_checks=<0/1>
execute_host_checks=<0/1>

Example:

 

execute_service_checks=1
execute_host_checks=1

This option determines whether or not Shinken will execute service/host checks. Do not change this option unless you use a old school distributed architecture. And even if you do this, please change your architecture with a cool new one far more efficient.



Passive Service/Host Check Acceptance Option

Format:

 

accept_passive_service_checks=<0/1>
accept_passive_host_checks=<0/1>

Example:

 

accept_passive_service_checks=1
accept_passive_host_checks=1

This option determines whether or not Shinken will accept passive service/host checks. If this option is disabled, Nagios will not accept any passive service/host checks.

 

Event Handler Option

Format:

 

enable_event_handlers=<0/1>

Example:

 

enable_event_handlers=1

This option determines whether or not Shinken will run event handlers.

 

Notification Logging Option

Format:

 

log_notifications=<0/1>

Example:

 

log_notifications=1

This variable determines whether or not notification messages are logged. If you have a lot of contacts or regular service failures your log file will grow (let say some Mo by day for a huge configuration, so it's quite OK for nearly every one to log them). Use this option to keep contact notifications from being logged.

 

Event Handler Logging Option

Format:

 

log_event_handlers=<0/1>

Example:

 

log_event_handlers=1

This variable determines whether or not service and host event handlers are logged. Event handlers are optional commands that can be run whenever a service or hosts changes state. Logging event handlers is most useful when debugging Shinken or first trying out your event handler scripts.

 

External Command Logging Option

Format:

 

log_external_commands=<0/1>

Example:

 

log_external_commands=1

This variable determines whether or not Shinken will log external commands that it receives.

 

Passive Check Logging Option (Not implemented)

Format:

 

log_passive_checks=<0/1>

Example:

 

log_passive_checks=1

This variable determines whether or not Shinken will log passive host and service checks that it receives from the external commands.

Timing Interval Length

Format:

 

interval_length=<seconds>

Example:

 

interval_length=60

This is the number of seconds per “unit interval" used for timing in the scheduling queue, re-notifications, etc. "Units intervals" are used in the object configuration file to determine how often to run a service check, how often to re-notify a contact, etc.

The default value for this is set to 60, which means that a "unit value" of 1 in the object configuration file will mean 60 seconds (1 minute).

Note that set this option top 1 is not a good thing with Shinken. It's not design to be a hard real time (<5seconds) monitoring system.

 

 

Others

Illegal Object Name Characters

Format:

 

illegal_object_name_chars=<chars...>

Example:

 

illegal_object_name_chars=`-!$%^&*"|'<>?,()=

This option allows you to specify illegal characters that cannot be used in host names, service descriptions, or names of other object types. Shinken will allow you to use most characters in object definitions, but I recommend not using the characters shown in the example above. Doing may give you problems in the web interface, notification commands, etc.