[dev.icinga.com #11905] Improve "Endpoint" documentation

[icinga-migration]

This issue has been migrated from Redmine: https://dev.icinga.com/issues/11905

Created by jschanz on 2016-06-06 14:00:50 +00:00

Assignee: jschanz
Status: Resolved (closed on 2016-06-07 06:30:09 +00:00)
Target Version: 2.5.0
Last Update: 2016-06-16 08:11:41 +00:00 (in Redmine)

Icinga Version: 2.4.10
Backport?: Not yet backported
Include in Changelog: 1

---

see also https://dev.icinga.org/issues/11901

Please add additional content to the Endpoint description in http://docs.icinga.org/icinga2/latest/doc/module/icinga2/chapter/object-types?highlight-search=log\_duration#objecttype-endpoint

The attribute "log_duration" needs a better explanation for the default value.

Now

log_duration    Optional. Duration for keeping replay logs on connection loss. Defaults to 1d.

Should point to something like

log_duration    Optional. Duration for keeping replay logs on connection loss. Defaults to 1d (86400 seconds). Attribute is specified in seconds. If log_duration is set to 0, replaying log is disabled.

Please extend also the example

Replay one day or 86400 seconds

object Endpoint "icinga2b" {
  host = "192.168.5.46"
  port = 5665
  log_duration = 86400
}

or to disable it

object Endpoint "icinga2b" {
  host = "192.168.5.46"
  port = 5665
  log_duration = 0
}

This will be helpful, because there are a lot of wrong hints (0d, 10m, etc.) in several forums.

Changesets

2016-06-07 06:26:31 +00:00 by jschanz 244bdd9

Update documentation for the log_duration attribute

fixes #11905

2016-06-07 06:26:45 +00:00 by gbeutner ac3ae31

Update AUTHORS

refs #11905

[icinga-migration]

Updated by mfriedrich on 2016-06-06 14:15:05 +00:00

• Status changed from New to Feedback
• Assigned to set to jschanz

Please provide a Git patch :)

[icinga-migration]

Updated by gbeutner on 2016-06-07 06:27:09 +00:00

• Status changed from Feedback to Assigned
• Target Version set to 307

[icinga-migration]

Updated by jschanz on 2016-06-07 06:30:09 +00:00

• Status changed from Assigned to Resolved
• Done % changed from 0 to 100

Applied in changeset 244bdd9.

[icinga-migration]

Updated by gbeutner on 2016-06-16 08:11:41 +00:00

• Target Version changed from 307 to 2.5.0