From b13c032c4fc0d53d0d0ab0e3642482dd01b1ba56 Mon Sep 17 00:00:00 2001 From: Ahmet Oeztuerk Date: Fri, 27 Feb 2026 11:19:37 +0100 Subject: [PATCH] add documentation about new host / service check_timeout config options --- src/documentation/usersguide/configmain.md | 14 +++--- .../usersguide/objectdefinitions.md | 49 ++++++++++++++++++- 2 files changed, 54 insertions(+), 9 deletions(-) diff --git a/src/documentation/usersguide/configmain.md b/src/documentation/usersguide/configmain.md index 268b988..486c2c0 100644 --- a/src/documentation/usersguide/configmain.md +++ b/src/documentation/usersguide/configmain.md @@ -1895,11 +1895,11 @@ If you want it to use the latest state (regardless of whether its a soft or hard -This is the maximum number of seconds that Naemon will allow service checks to run. +This is the default value for the maximum number of seconds that Naemon will allow service checks to run. -If checks exceed this limit, they are killed and a CRITICAL state is returned. +If a service [definition](objectdefinitions#service) has its own check_timeout, it will be used instead of service_check_timeout. - A timeout error will also be logged. +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. @@ -1924,17 +1924,17 @@ If a service check runs longer than this limit, Naemon will kill it off thinking -This is the maximum number of seconds that Naemon will allow host checks to run. +This is the default value for the maximum number of seconds that Naemon will allow host checks to run. -If checks exceed this limit, they are killed and a CRITICAL state is returned and the host will be assumed to be DOWN. +If a host [definition](objectdefinitions#host) has its own check_timeout, it will be used instead of host_check_timeout. -A timeout error will also be logged. +If checks exceed this limit, they are killed and a CRITICAL state is returned and the host will be assumed to be DOWN. 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 host check normally finishes executing within this time limit. +It should be set to something high (like 30 seconds or more), so that each host check normally finishes executing within this time limit. If a host check runs longer than this limit, Naemon will kill it off thinking it is a runaway processes. diff --git a/src/documentation/usersguide/objectdefinitions.md b/src/documentation/usersguide/objectdefinitions.md index d8e95fa..7a0c89c 100644 --- a/src/documentation/usersguide/objectdefinitions.md +++ b/src/documentation/usersguide/objectdefinitions.md @@ -95,6 +95,7 @@ define host { hourly_value # hostgroups hostgroup_names check_command command_name + check_timeout # initial_state [o,d,u] max_check_attempts # // [!code error] check_interval # @@ -253,7 +254,28 @@ Thus, Naemon will likely always assume the host is up (it may show up as being i This is useful if you are monitoring printers or other devices that are frequently turned off. -The maximum amount of time that the notification command can run is controlled by the [host_check_timeout](configmain#host_check_timeout) option. + + + + +check_timeout: + +Timeout Naemon will use when performing the host check using its check_command, specified in seconds. + +When unspecified, it will take the default value from [host_check_timeout](configmain#host_check_timeout). + +Override the default host_check_timeout with this option if its fits better for your needs. + +If checks exceed this limit, they are killed and a CRITICAL state is returned and the host will be assumed to be DOWN. 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 30 seconds or more), so that each host check normally finishes executing within this time limit. + +If a host check runs longer than this limit, Naemon will kill it off thinking it is a runaway processes. + @@ -823,6 +845,7 @@ define service { servicegroups servicegroup_names is_volatile [0/1] check_command command_name // [!code error] + check_timeout # initial_state [o,w,u,c] max_check_attempts # // [!code error] check_interval # // [!code error] @@ -969,7 +992,29 @@ Value: `0` = service is not volatile, `1` = service is volatile. This directive is used to specify the *short name* of the [command](#command) that Naemon will run in order to check the status of the service. -The maximum amount of time that the service check command can run is controlled by the [service_check_timeout](configmain#service_check_timeout) option. +The maximum amount of time that the service check command can run is controlled by the check_timeout option. + + + + +check_timeout: + +Timeout Naemon will use when performing the service check using its check_command, specified in seconds. + +When unspecified, it will take the default value from [service_check_timeout](configmain#service_check_timeout). + +Override the default service_check_timeout with this option if its fits better for your needs. + +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 service check normally finishes executing within this time limit. + +If a service check runs longer than this limit, Naemon will kill it off thinking it is a runaway processes. +