Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating the documentation for missing check_periond definition #59 #91

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion documentation/usersguide/objectdefinitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ A host definition is used to define a physical server, workstation, device, etc.
<tr><td></td><td>retry_interval</td><td>#</td></tr>
<tr><td></td><td>active_checks_enabled</td><td>[0/1]</td></tr>
<tr><td></td><td>passive_checks_enabled</td><td>[0/1]</td></tr>
<tr><td></td><td class="text-danger">check_period</td><td class="text-danger"><i>timeperiod_name</i></td></tr>
<tr><td></td><td class="text-danger">check_period&#10033;&#10033;</td><td class="text-danger"><i>timeperiod_name</i></td></tr>
<tr><td></td><td>obsess_over_host|obsess</td><td>[0/1]</td></tr>
<tr><td></td><td>check_freshness</td><td>[0/1]</td></tr>
<tr><td></td><td>freshness_threshold</td><td>#</td></tr>
Expand Down Expand Up @@ -323,6 +323,9 @@ This directive is used to determine whether or not passive checks are enabled fo
<td valign="top"><strong>check_period</strong>:</td>
<td>
This directive is used to specify the short name of the <a href="#timeperiod">time period</a> during which active checks of this host can be made.

{{ site.note }}If it is not defined, Naemon will check it on a <b><i>as needed basis</i></b>, which can be defined as a 24x7 time frame. This will also give a warning when running the Naemon check config command.{{ site.end }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure exactly what is meant by "which can be defined as a 24x7 time frame" ?

The behavior is when check_period is 0 is documented here: http://www.naemon.org/documentation/usersguide/hostchecks.html so perhaps we could link to that page for more information.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you look even further back and refer to the Nagios documentation (which the core Naemon features are based upon). The check_period is 24x7, but that time period is not technically defined.

If you refer to the http://www.naemon.org/documentation/usersguide/hostchecks.html and http://www.naemon.org/documentation/usersguide/servicechecks.html does not even mention the check period, which seems to be odd.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the check_period is ignored when on-demand checks are made?

Copy link
Contributor Author

@Herkum Herkum Jan 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I recall, on-demand checks can be made outside the check_period.

I believe the check_period prevents checks from being scheduled outside the defined time frame. If there is no a time frame, it just goes ahead and schedules checks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I completely forget about this PR.

If leaving the check_period empty is the same as 24x7, then perhaps we should just write that in the object definition similar to how we have default values for other objects definitions.


</td>
</tr>
<tr>
Expand Down