...
Configuration
...
Options
When creating and/or editing configuration files, keep the following in mind:
- Lines that start with a '"#"' character are taken considered to be comments and are not processed
- Variable names are case-sensitive
- If you want to configure a process to use a specific module:
The The main configuration file is "shinken.cfg". It is located in the "/etc/shinken/" directory.
Below are listed parameters currently used in the file. For other parameters (not set by default) see Main Advanced Configuration File Advanced.
Default used options
Cfg dir and Cfg files
Format :
cfg_dir=<directory_name>
cfg_file=<file_name>
...
This means that a cfg_dir or cfg_file is considered as a parameter outside of shinken.cfg (or any configuration file directly given to the arbiter as parameter in a command line)
The arbiter handles main configuration files differently than any other files.
Automatic State Retention Update Interval
Format:
retention_update_interval=<minutes>
...
retention_update_interval=60
This setting determines how often the interval (in minutes) that Shinken scheduler will automatically save between automatic retention data backups by the scheduler during normal operation.
If you set this value to 0, it will not save retention data at regular intervals, but it will still save retention data before shutting down or restarting.
Maximum Host/Service Check Spread
Format:
max_service_check_spread=<minutes>
max_host_check_spread=<minutes>
...
This option determines the maximum number of minutes from when Shinken starts that time spread (in minutes) to check all hosts/checks (that which are scheduled to be regularly checked) are checkedfrom Shinken Enterprise's launch. This option will ensure that the initial checks of all hosts/services checks occur within the timeframe you specify. Default value is 30 (minutes).
Service/Host Check Timeout
Format:
service_check_timeout=<seconds>
host_check_timeout=<seconds>
...
This is the maximum number of seconds that Shinken will allow service/host checks to runallowed by Shinken Enterprise to run host/checks. If checks exceed this limit, they are killed and a CRITICAL state is returned. A timeout error will also 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 plugins which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each check normally finishes executing within this time limit. If a check runs longer than this limit, Shinken Enterprise will kill it off thinking it is a runaway processesprocess.
Timeout Exit Status
Format:
timeout_exit_status=[0,1,2,3]
...
timeout_exit_status=2
State set by Shinken Enterprise in case of timeout.
Flap History
Format:
flap_history=<int>
...
This option is used to set the history size of states keep kept by the scheduler to make the flapping calculation. By default, the value is 20 states kept.
The size in memory is for the scheduler daemon : 4Bytes flap_history (nb hosts + nb serviceschecks). For a big environment, it costs 4 20 (1000+10000) - 900Ko. So you can raise it to higher value if you want.
Max Plugins Output Length
Format:
max_plugins_output_length=<int>
...
This option is used to set the max size in bytes for the checks plugins output. So if you saw truncated output like for huge disk check when you have a lot of partitions, raise this value.
Enable problem/impacts states change
Format:
enable_problem_impacts_states_change=<0/1>
...
This option is used to know if we apply or not the state change when a host or service check is impacted by a root problem (like the servicecheck's host going down or a host's parent being down too). The state will be changed by UNKNONW for a service check and UNREACHABLE for a host until their next schedule check. This state change do does not count as a an attempt, it's just for console so the users know user knows that theses these objects got problems and the previous states are not sure.
Disable Old Nagios Parameters Whining
Format:
disable_old_nagios_parameters_whining=<0/1>
...
If 1, disable all notice and warning messages at configuration checking
Timezone Option
Format:
use_timezone=<tz from tz database>
...
This option allows you to override the default timezone that this in which an instance of Shinken Enterprise runs in. Useful if you have multiple instances of Shinken that Enterprise which need to run from the same server, but have different local times associated with them. If not specified, Shinken Enterprise will use the system configured timezone.
Environment Macros Option
Format:
enable_environment_macros=<0/1>
...
enable_environment_macros=0
This option determines whether or not if the Shinken Enterprise daemon will make all standard :ref:`macros <thebasics/macrolist>` available as environment variables to your check, notification, event hander, etc. commands. In large installations this can be problematic because it takes additional CPU to compute the values of all macros and make them available to the environment. It also cost a increase network communication between schedulers and pollers.
...
- 1 = Make macros available as environment variables
Initial States Logging Option
Format:
log_initial_states=<0/1>
...
log_initial_states=1
This variable determines whether or not if Shinken Enterprise will force all initial host and service check states to be logged, even if they result in an OK state. Initial service check and host states are normally only logged when there is a problem on the first check. Enabling this option is useful if you are using an application that scans the log file to determine long-term state statistics for services checks and hosts.
- 0 = Don't log initial states
- 1 = Log initial states
Event Handler during downtimes
Format:
no_event_handlers_during_downtimes=<0/1>
...
no_event_handlers_during_downtimes=1
This option determines whether or not if Shinken Enterprise will run :ref:`event handlers <advanced/eventhandlers>` when the host or service check is in a scheduled downtime.
...
- 1 = Don't launch event handlers
Arbiter daemon part
The following parameters are common to all daemons.
Workdir
Format:
workdir=<directory>
...
This variable specify the working directory of the daemon.
In the arbiter case, if the value is empty, the directory name of lock_file parameter. See below
Arbiter Lock File
Format:
lock_file=<file_name>
...
This option specifies the location of the lock file that Shinken arbiter daemon should create when it runs as a daemon (when started with the "-d" command line argument). This file contains the process id (PID) number of the running arbiter process.
Local Log
Format:
local_log=<filename>
...
This variable specifies the log file for the daemon.
Log Level
Format:
log_level=[DEBUG,INFO,WARNING,ERROR,CRITICAL]
...
This variable specifies which logs will be raised by the arbiter daemon. For others daemons, it can be defined in their local \ d.ini files.
Arbiter Daemon User
Defined in brokerd.ini, brokerd-windows.ini, pollerd.ini, pollerd-windows.ini, reactionnerd.ini, schedulerd.ini and schedulerd-windows.ini.
...
This is used to set the effective user that the . The Arbiter process (main process) should will run as this effective user.
After initial program startup, Shinken Enterprise will drop its effective privileges and run as this user.
Arbiter Daemon user Group
Format:
shinken_group=groupname
...
This is used to set the effective group of the user used to launch the arbiter daemon.
Modules directory
Format:
modules_dir=<direname>
...
Path to the modules directory
Daemon Enabled
Format:
daemon_enabled=[0/1]
...
Set to 0 if you want to make this daemon (arbiter) NOT to run
Use SSL
Format:
use_ssl=[0/1]
Default:
...
Use SSl or not. You have to enable it on other daemons too.
Ca Cert
Format:
ca_cert=<filename>
...
Certification Authority (CA) certificate. Put full paths for certs
Server Cert
Format:
server_cert=<filename>
...
Server certificate for SSL.Put full paths for certs
Server Key
Format:
server_key=<filename>
...
Server key for SSL. Put full paths for certs
Hard SSL Name Check
Format:
hard_ssl_name_check=[0/1]
...
hard_ssl_name_check=0
Enable SSL name check.
HTTP Backend
Format:
http_backend=[auto, cherrypy, swsgiref]
...