Performance data parameters
Performance Data Processing Option
Format:
process_performance_data=<0/1>
Example:
process_performance_data=1
This value determines if Shinken Enterprise will process host/check performance data.
- 0 = Don't process performance data
- 1 = Process performance data (default)
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 host/check. Orphaned checks are checks which have been launched to pollers but did not get any results reported for a long time.
Since there is no results back, it is not rescheduled in the event queue. This can cause checks to stop being executed. Normally it should happen very rarely - it might happen if an external user or a process killed off the process that was being used to execute a check.
If this option is enabled and Shinken Enterprise does not find results back for a particular check, it will log an error message and reschedule the check. If you see checks that never seem to get rescheduled, enable this option and see if you notice any log messages about orphaned services.
- 0 = Don't check for orphaned service checks
- 1 = Check for orphaned service checks (default)
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 time (in seconds) the state of a previous host check is considered current. Cached host states (from host/check that were performed more recently than the time specified by this value) can hugely improve host check performance. If the value is too high for this option it may result in (temporarily) inaccurate host/check states. A low value may result in a performance hit for host/check. Use a value of 0 if you want to disable host/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 Enterprise will try and detect hosts and checks that are “flapping". Flapping occurs when a host or check changes between states too frequently, resulting in a barrage of notifications being sent out. When Shinken Enterprise detects a flapping host or check, it will temporarily suppress notifications for that host/check until it stops flapping.
More information on how flap detection and handling works can be found here <advanced/flapping>`.
- 0 = Don't enable flap detection (default)
- 1 = Enable flap detection
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/check 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/check 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 to run event handlers & notification. If a 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 Enterprise will kill it off thinking it is a runaway process.
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 if Shinken Enterprise will periodically check the “freshness" of host/check. Enabling this option is useful for helping to ensure that passive checks are received in a timely manner. More information on freshness checking can be found here.
- 0 = Don't check host/check freshness
- 1 = Check host/check freshness (default)
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/check results. If you have disabled host/check freshness checking (with the check_service_freshness option), this option has no effect. More information on freshness checking can be found here.
Notifications Option
Format:
enable_notifications=<0/1>
Example:
enable_notifications=1
This option determines if Shinken Enterprise will send out notifications. If this option is disabled, Shinken will not send out notifications for any host or check.
Values are as follows:
- 0 = Disable notifications
- 1 = Enable notifications (default)
External Command Check Option
Format:
check_external_commands=<0/1>
Example:
check_external_commands=1
This option determines if Shinken Enterprise will check the External Command File for commands that should be executed with the arbiter daemon .
- 0 = Don't check external commands
- 1 = Check external commands (default)
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 if Shinken Enterprise will execute host/check. 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.
- 0 = Don't execute checks
- 1 = Execute checks (default)
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 if Shinken will accept passive host/checks. If this option is disabled, Shinken Enterprise will not accept any passive host/checks.
- 0 = Don't accept passive host/checks
- 1 = Accept passive host/checks (default)
Event Handler Option
Format:
enable_event_handlers=<0/1>
Example:
enable_event_handlers=1
This option determines if Shinken Enterprise will run event handlers.
- 0 = Disable event handlers
- 1 = Enable event handlers (default)
Notification Logging Option
Format:
log_notifications=<0/1>
Example:
log_notifications=1
This variable determines if notification messages are logged. If you have a lot of contacts or regular check 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.
- 0 = Don't log notifications
- 1 = Log notifications
Event Handler Logging Option
Format:
log_event_handlers=<0/1>
Example:
log_event_handlers=1
This variable determines if check and host event handlers are logged. Event handlers are optional commands that can be run whenever a check or hosts changes state. Logging event handlers is most useful when debugging Shinken Enterprise or first trying out your event handler scripts.
- 0 = Don't log event handlers
- 1 = Log event handlers
External Command Logging Option
Format:
log_external_commands=<0/1>
Example:
log_external_commands=1
This variable determines if Shinken Enterprise will log external commands that it receives.
- 0 = Don't log external commands
- 1 = Log external commands (default)
Passive Check Logging Option (Not implemented)
Format:
log_passive_checks=<0/1>
Example:
log_passive_checks=1
This variable determines if Shinken Enterprise will log passive host/checks that it receives from the external commands.
- 0 = Don't log passive checks
- 1 = Log passive checks (default)
Timing Interval Length
Format:
interval_length=<seconds>
Example:
.. _configuration/configmain-advanced:
===========================
Main advanced configuration
===========================
...
.. important:: If you do not know how to change the values of theses parameters, don't touch them :)
(and ask for help on the mailing list).
...
Performance Data Processor Command Timeout
-------------------------------------------
Format:
::
perfdata_timeout=<seconds>
Example:
::
...
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 :ref:`performance data <advanced/perfdata>`.
* 0 = Don't process performance data
* 1 = Process performance data (default)
If you want to use tools like PNP, NagiosGrapher or Graphite set it to 1.
...
Host/Service Performance Data Processing Command
-------------------------------------------------
Format:
::
host_perfdata_command=<configobjects/command>
service_perfdata_command=<configobjects/command>
Example:
::
...
...
Passive Host Checks Are SOFT Option (Not implemented)
------------------------------------------------------
Format:
::
passive_host_checks_are_soft=<0/1>
Example:
::
...
* 0 = Passive host checks are HARD (default)
* 1 = Passive host checks are SOFT
.. _configuration/configmain-advanced#check_for_orphaned_services:
.. _configuration/configmain-advanced#check_for_orphaned_hosts:
Orphaned Host/Service Check Option
-----------------------------------
Format:
::
check_for_orphaned_services=<0/1>
check_for_orphaned_hosts=<0/1>
Example:
::
...
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.
* 0 = Don't check for orphaned service checks
* 1 = Check for orphaned service checks (default)
...
Soft State Dependencies Option (Not implemented)
-------------------------------------------------
Format: soft_state_dependencies=<0/1>
Example: soft_state_dependencies=0
This option determines whether or not Shinken will use soft state information when checking :ref:`host and service dependencies <advanced/dependencies>`. Normally it will only use the latest hard host or service state when checking dependencies. If you want it to use the latest state (regardless of whether its a soft or hard :ref:`state type <thebasics/statetypes>`), enable this option.
* 0 = Don't use soft state dependencies (default)
* 1 = Use soft state dependencies
...
.. _configuration/configmain-advanced#cached_host_check_horizon:
.. _configuration/configmain-advanced#cached_service_check_horizon:
Cached Host/Service Check Horizon
----------------------------------
Format:
::
cached_host_check_horizon=<seconds>
cached_service_check_horizon=<seconds>
Example:
::
...
.. tip:: Nagios default is 15s, but it's a tweak that make checks less accurate. So Shinken use 0s as a default. If you have performances problems and you can't add a new scheduler or poller, increase this value and start to buy a new server because this won't be magical.
Flapping parameters
====================
.. _configuration/configmain-advanced#enable_flap_detection:
Flap Detection Option
----------------------
Format:
::
enable_flap_detection=<0/1>
Example:
::
...
More information on how flap detection and handling works can be found :ref:`here <advanced/flapping>`.
* 0 = Don't enable flap detection (default)
* 1 = Enable flap detection
...
Low Service/Host Flap Threshold
--------------------------------
Format:
::
low_service_flap_threshold=<percent>
low_host_flap_threshold=<percent>
Example:
::
...
High Service/Host Flap Threshold
---------------------------------
Format:
::
high_service_flap_threshold=<percent>
high_host_flap_threshold=<percent>
Example:
::
...
...
Various commands Timeouts
--------------------------
Format:
::
event_handler_timeout=<seconds> # default: 30s
notification_timeout=<seconds> # default: 30s
ocsp_timeout=<seconds> # default: 15s
ochp_timeout=<seconds> # default: 15s
Example:
::
...
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, less for oc*p commands), 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.
...
.. _configuration/configmain-advanced#obsess_over_services:
Obsess Over Services Option
----------------------------
Format:
::
obsess_over_services=<0/1>
Example:
::
...
* 0 = Don't obsess over services (default)
* 1 = Obsess over services
...
Obsessive Compulsive Service Processor Command
-----------------------------------------------
Format:
::
ocsp_command=<configobjects/command>
Example:
::
ocsp_command=obsessive_service_handler
This option allows you to specify a command to be run after every service check, which can be useful in :ref:`distributed monitoring <advanced/distributed>`. This command is executed after any :ref:`event handler <advanced/eventhandlers>` or :ref:`notification <thebasics/notifications>` commands. The command argument is the short name of a :ref:`command definition <configobjects/command>` that you define in your object configuration file.
It's used nearly only for the old school distributed architecture. If you use it, please look at new architecture capabilities that are far efficient than the old one. More information on distributed monitoring can be found :ref:`here <advanced/distributed>`. This command is only executed if the :ref:`Obsess Over Services Option <configuration/configmain-advanced#obsess_over_services>` option is enabled globally and if the "obsess_over_service" directive in the :ref:`service definition <configobjects/service>` is enabled.
...
Obsess Over Hosts Option
-------------------------
Format:
::
obsess_over_hosts=<0/1>
Example:
::
...
* 0 = Don't obsess over hosts (default)
* 1 = Obsess over hosts
...
Obsessive Compulsive Host Processor Command
--------------------------------------------
Format:
::
ochp_command=<configobjects/command>
Example:
::
...
This command is only executed if the :ref:`Obsess Over Hosts Option <configuration/configmain-advanced#obsess_over_hosts>` option is enabled globally and if the "obsess_over_host" directive in the :ref:`host definition <configobjects/host>` is enabled.
...
.. _configuration/configmain-advanced#check_service_freshness:
.. _configuration/configmain-advanced#check_host_freshness:
Host/Service Freshness Checking Option
---------------------------------------
Format:
::
check_service_freshness=<0/1>
check_host_freshness=<0/1>
Example:
::
...
* 0 = Don't check host/service freshness
* 1 = Check host/service freshness (default)
...
Host/Service Freshness Check Interval
--------------------------------------
Format:
::
service_freshness_check_interval=<seconds>
host_freshness_check_interval=<seconds>
Example:
::
...
.. _configuration/configmain-advanced#resource_file:
Resource File
--------------
Defined in shinken.cfg 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$" :ref:`Understanding Macros and How They Work <thebasics/macros>` 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 :ref:`notifications <thebasics/notifications>`. If this option is disabled, Shinken will not send out notifications for any host or service.
Values are as follows:
* 0 = Disable notifications
* 1 = Enable notifications (default)
...
Log Rotation Method (Not fully implemented)
--------------------------------------------
Format:
::
log_rotation_method=<n/h/d/w/m>
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:
* n = None (don't rotate the log - this is the default)
* h = Hourly (rotate the log at the top of each hour)
* d = Daily (rotate the log at midnight each day)
* w = Weekly (rotate the log at midnight on Saturday)
* m = Monthly (rotate the log at midnight on the last day of the month)
.. tip:: From now, only the d (Daily) parameter is managed.
...
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 :ref:`External Command File <configuration/configmain-advanced#command_file>` for commands that should be executed with the **arbiter daemon**. More information on external commands can be found :ref:`here <advanced/extcommands>`.
* 0 = Don't check external commands (default)
* 1 = Check external commands (default)
.. note:: FIX ME : Find the real default value
Scheduling parameters
======================
.. _configuration/configmain-advanced#execute_service_checks:
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.
* 0 = Don't execute service checks
* 1 = Execute service checks (default)
...
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 :ref:`passive service/host checks <thebasics/passivechecks>`. If this option is disabled, Nagios will not accept any passive service/host checks.
* 0 = Don't accept passive service/host checks
* 1 = Accept passive service/host checks (default)
...
Event Handler Option
---------------------
Format:
::
enable_event_handlers=<0/1>
Example:
::
enable_event_handlers=1
This option determines whether or not Shinken will run :ref:`event handlers <advanced/eventhandlers>`.
* 0 = Disable event handlers
* 1 = Enable event handlers (default)
...
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.
* 0 = Don't log notifications
* 1 = Log notifications
...
Event Handler Logging Option
-----------------------------
Format:
::
log_event_handlers=<0/1>
Example:
::
log_event_handlers=1
This variable determines whether or not service and host :ref:`event handlers <advanced/eventhandlers>` 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.
* 0 = Don't log event handlers
* 1 = Log event handlers
...
External Command Logging Option
--------------------------------
Format:
::
log_external_commands=<0/1>
Example:
::
log_external_commands=1
This variable determines whether or not Shinken will log :ref:`external commands <advanced/extcommands>` that it receives.
* 0 = Don't log external commands
* 1 = Log external commands (default)
...
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 :ref:`passive host and service checks <thebasics/passivechecks>` that it receives from the :ref:`external command file <configuration/configmain-advanced#command_file>`.
* 0 = Don't log passive checks
* 1 = Log passive checks (default)
...
Global Host/Service Event Handler Option (Not implemented)
-----------------------------------------------------------
Format:
::
global_host_event_handler=<configobjects/command>
global_service_event_handler=<configobjects/command>
Example:
::
global_host_event_handler=log-host-event-to-db
global_service_event_handler=log-service-event-to-db
This option allows you to specify a host event handler command that is to be run for every host state change. The global event handler is executed immediately prior to the event handler that you have optionally specified in each host definition. The command argument is the short name of a command that you define in your :ref:`Object Configuration Overview <configuration/configobject>`. The maximum amount of time that this command can run is controlled by the :ref:`Event Handler Timeout <configuration/configmain-advanced#event_handler_timeout>` option. More information on event handlers can be found :ref:`here <advanced/eventhandlers>`.
Such commands should not be so useful with the new Shinken distributed architecture. If you use it, look if you can avoid it because such commands will kill your performances.
.. _configuration/configmain-advanced#interval_length:
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).
.. tip:: Set Note that set this option top 1 is not a good thing with Shinken Enterprise. It's not design to be a hard real time (<5seconds) monitoring system. Nearly no one need such hard real time (maybe only the Nuclear center or a market place like the London Exchange...).
All the others :)
==================
...
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 Enterprise will allow you to use most characters in object definitions, but I we recommend not using the characters shown in the example above. Doing may give you problems in the web interface, notification commands, etc.
...