Nagios

Learn about configurations >

• admin_email | string

  Default: root@localhost

  Comma separated list of email addresses used for the admin, used by $ADMINEMAIL$ in notification commands. If specify multiples emails, contactgroup-members will be ignored.

• admin_host_notification_commands | string

  Default: notify-host-by-email

  This directive is used to define a list of the short names of the commands used to notify the default admin contact of a host problem or recovery. Change this or add commands if you have custom notification plugins. Multiple notification commands should be separated by commas. All notification commands are executed when the contact needs to be notified.

• admin_host_notification_options | string

  Default: d,r

  This directive is used to define the host states for which notifications can be sent out to the default admin contact. Valid options are a combination of one or more of the following: d = notify on DOWN host states, u = notify on UNREACHABLE host states, r = notify on host recoveries (UP states), f = notify when the host starts and stops flapping, s = send notifications when host or service scheduled downtime starts and ends. If you specify n (none) as an option, the contact will not receive any type of host notifications.

• admin_host_notification_period | string

  Default: 24x7

  This directive is used to specify the short name of the time period during which the default admin contact can be notified about host problems or recoveries. You can think of this as an "on call" time for host notifications for the contact. Read the documentation on time periods for more information on how this works and potential problems that may result from improper use.

• admin_pager | string

  Default: pageroot@localhost

  Email address used for the admin pager, used by $ADMINPAGER$ in notification commands.

• admin_service_notification_commands | string

  Default: notify-service-by-email

  This directive is used to define a list of the short names of the commands used to notify the default admin contact of a service problem or recovery. Change this or add commands if you have custom notification plugins. Multiple notification commands should be separated by commas. All notification commands are executed when the contact needs to be notified.

• admin_service_notification_options | string

  Default: w,u,c,r

  This directive is used to define the service states for which notifications can be sent out to the default admin contact. Valid options are a combination of one or more of the following: w = notify on WARNING service states, u = notify on UNKNOWN service states, c = notify on CRITICAL service states, r = notify on service recoveries (OK states), f = notify when the service starts and stops flapping. If you specify n (none) as an option, the contact will not receive any type of service notifications.

• admin_service_notification_period | string

  Default: 24x7

  This directive is used to specify the short name of the time period during which the default admin contact can be notified about service problems or recoveries. You can think of this as an "on call" time for service notifications for the contact. Read the documentation on time periods for more information on how this works and potential problems that may result from improper use.

• check_external_commands | int

  Default: 1

  Config variable to enable checking external commands - 0 is disable, 1 is enable.

• check_timeout | int

  Default: 10

  A number of seconds before nrpe checks timeout from not being able to connect to the client or finish execution of the command. Raise this value to combat 'CHECK_NRPE Socket timeout alerts'

• command_check_interval | string

  Default: -1

  How often to check for external commands.

• command_file | string

  Default: /var/lib/nagios3/rw/nagios.cmd

  File that Nagios checks for external command requests.

• contactgroup-members | string

  Default: root

  Comma separated list of contacts to add as members of the admins group.

• daemon_dumps_core | int

  Option to determine if Nagios is allowed to create a core dump.

• debug_file | string

  Default: /var/log/nagios3/nagios.debug

  Path for the debug file.

• debug_level | int

  Specify the debug level for nagios. See the docs for more details.

• debug_verbosity | int

  Default: 1

  How verbose will the debug logs be - 0 is brief, 1 is more detailed and 2 is very detailed.

• email_max_notifications | int

  Specify how many times to send mails for a given alert.

  By default, the notify-host-by-email and notify-service-by-email commands will send email for every notification. If re-notification is enabled, this may not be desireable. (For example, if re-notification is used in conjunction with PagerDuty, it may be desireable to re-notify PagerDuty but not re-send emails.)

  If this is set to a positive integer, these commands will be modified so emails are only sent up to the specified number of times per alert, after which no more emails will be sent. For example, setting this to 1 will make the email commands send email on the first occurance of any alert, but not on any re-notifications.

  If set to 0, the default behavior is maintained.

• enable_livestatus | boolean

  Config variable to enable livestatus module or not.

• enable_pagerduty | boolean

  Config variable to enable pagerduty notifications or not.

• extra_contacts | string

  Define extra contacts for Nagios. They will be appended in the default administrators contact group. This is useful for adding notification integrations with external services. Contacts are passed as a YAML array, and must have a contact name, a command to be executed for host notifications and a command to be executed for service notifications. These commands may use all relevant Nagios macros ($HOSTNAME$, $SERVICENAME$, etc). Refer to the Nagios documentation for more information. Only [A-Za-z0-9_-] contact names are valid. Be careful with commands, since they are not sanitized. Example

  • name: opsteam_email host: /usr/bin/sendmail -s "alert for $HOSTNAME$" opsteam@mycompany.com service: /usr/bin/sendmail -s "alert for $SERVICENAME$" opsteam@mycompany.com
  • name: snmp_collector host: /path/to/snmp/helper .... service: /path/to/snmp/helper ....

• extraconfig | string

  Any additional nagios configuration you would like to add can be set into this element. It will be placed in /etc/nagios3/conf.d/extra.cfg

• flap_detection | boolean

  Default: True

  Enable flap detection on monitored hosts and services.

• livestatus_args | string

  Arguments to be passed to the livestatus module, defaults to empty.

• livestatus_enable_xinetd | boolean

  Expose livestatus socket through a network port using xinetd. NOTE: this socket does not support authentication nor authorization, so exposing it to the network will enable everyone to query it, so it is recommended to limit the hosts that can send queries by listing those hosts in the the livestatus_xinetd_only_from option.

• livestatus_path | string

  Default: /var/lib/nagios3/livestatus/socket

  Default path to livestatus socket, if enabled via enable_livestatus

• livestatus_xinetd_only_from | string

  Default: 127.0.0.1

  List of space-separated IPs that will be able to access livestatus through xinetd. If left empty, only localhost will be able to access it.

• livestatus_xinetd_port | string

  Default: 6557

  Port to be used for livestatus through xinetd.

• load_monitor | string

  Default: 5.0!4.0!3.0!10.0!6.0!4.0

  A string to pass to the Nagios load monitoring command. Default is to report warning at 5.0, 4.0 and 3.0 averages, critical at 10.0, 6.0 and 4.0.

• log_archive_path | string

  Default: /var/log/nagios3/archives

  Path for archived log files

• log_rotation_method | string

  Default: d

  Log rotation method that Nagios should use to rotate the main logfile.

• monitor_self | boolean

  Default: True

  If true, enable monitoring of the nagios unit itself.

• nagios_group | string

  Default: nagios

  The effective group that nagios will run as.

• nagios_host_context | string

  Default: juju

  a string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-postgresql-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.

• nagios_user | string

  Default: nagios

  The effective user that nagios will run as.

• nagiosadmin | string

  Default: nagiosadmin

  Username for Nagios admin user.

• notification_interval | int

  Interval at which to send notifications for an alert. This will be in minutes as long as the global-level config option interval_length remains at the default of 60 seconds.

  The default, 0, means to never re-alert.

• notification_options | string

  Default: w,u,c,r,f,s

  This directive is used to define the service states for which notifications can be created. Valid options are a combination of one or more of the following: w = notify on WARNING service states, u = notify on UNKNOWN service states, c = notify on CRITICAL service states, r = notify on service recoveries (OK states), f = notify when the service starts and stops flapping. s = notify when the scheduled downtime starts and ends. If you specify n (none) as an option, the contact will not receive any type of service notifications.

• nrpe_packet_version | int

  Default: 3

  Defines the nrpe packet version to use

  The valid options are 2 and 3

  https://support.nagios.com/kb/article.php?id=518

• pagerduty_key | string

  Pagerduty API key to use for notifications

• pagerduty_notification_levels | string

  Default: u,c,r,f,s

  A string to use for the service_notification_options in the pagerduty contact configuration. Add w to page for warning events.

• pagerduty_path | string

  Default: /var/lib/nagios3/pagerduty

  Path for Pagerduty notifications to be queued.

• password | string

  Password to use for Nagios administrative access. If not provided, a password will be generated (see documentation for instructions on retrieving the generated password.)

• ro-password | string

  Password to use for read-only Nagios access. If left blank, the nagiosro account will not be created.

• send_traps_to | string

  Defines the IP or Host Name to send snmp traps to. Leave blank (empty) to disable the traps functionality.

• sender_email | string

  The email from which Nagios will try sending emails. If unset, the message will not include an explicit sender address and a default value will be added by the MTA, typically “user@host”.

• service_check_timeout | int

  Default: 60

  Number of seconds Nagios allows for a service check before killing it off. This ties in with service_check_timeout_state. NRPE will alert for the lower of this value or check_timeout. Also note that host_check_timeout is set to 30 seconds, and it's preferred to have service_check_timout greater than host_check_timeout.

• service_check_timeout_state | string

  Default: c

  This setting determines the state Nagios will report when a service check times out - that is does not respond within service_check_timeout seconds. This can be useful if a machine is running at too high a load and you do not want to consider a failed service check to be critical (the default). Valid settings are: c - Critical (default) u - Unknown w - Warning o - OK

• site_name | string

  An unique site name for Nagios deployment

• ssl | string

  Default: off

  Enable SSL communication for Nagios. Possible values are "on", "off", or "only". The "only" option disables All HTTP communication in favor of HTTPS - may play havok with existing nagios deployments.

• ssl_cert | string

  base64 encoded server certificate. If left blank, the certificate and key will be autogenerated as self-signed.

• ssl_chain | string

  base64 encoded chain certificates file. If ssl_cert is blank, this will be ignored.

• ssl_key | string

  base64 encoded server certificate key. If ssl_cert is blank, this is ignored.

• traps_host_notification_options | string

  Default: d,r

  This directive is used to define the host states for which notifications can be sent out to the default traps contact. Valid options are a combination of one or more of the following: d = notify on DOWN host states, u = notify on UNREACHABLE host states, r = notify on host recoveries (UP states), f = notify when the host starts and stops flapping, s = send notifications when host or service scheduled downtime starts and ends. If you specify n (none) as an option, the contact will not receive any type of host notifications.

• traps_service_notification_options | string

  Default: w,u,c,r

  This directive is used to define the service states for which notifications can be sent out to the default traps contact. Valid options are a combination of one or more of the following: w = notify on WARNING service states, u = notify on UNKNOWN service states, c = notify on CRITICAL service states, r = notify on service recoveries (OK states), f = notify when the service starts and stops flapping. If you specify n (none) as an option, the contact will not receive any type of service notifications.

• use_syslog | int

  Default: 1

  Log messages to syslog as well as main file.