Commit Graph

23 Commits

Author SHA1 Message Date
Michael Insel 081d88436f Unify documentation code formatting
This unifies the documentation code formatting to use only backticks.
2019-03-26 09:11:03 +01:00
Lee Garrett 0a582905c5 Typo and link fix 2019-03-05 17:40:14 +01:00
fluxX04 114da89ef0 update apache status command to be identical according the itl 2018-11-15 09:54:58 +01:00
Markus Frosch 9fbc40615a Improve path handling in cmake and daemon 2018-08-07 14:10:26 +02:00
Max Rosin 5da0f41b3f some minor fixes in the flapping documentation
- change "ware weighted" to "are weighted"
- remove an unintended line break
- remove a comma
2018-06-15 13:22:02 +02:00
Michael Friedrich 0bcda04171 Remove the import of 'legacy-timeperiod' in the docs
2.6.0 introduced default template imports for config objects
where this isn't necessary anymore. It also confuses the reader.
2018-06-15 10:48:19 +02:00
Michael Friedrich 008e40eda5 Enhance advanced topics with (scheduled) downtimes 2018-04-27 16:23:36 +02:00
Jean Flach b15203e878 Update volatile docs 2018-04-12 18:09:40 +02:00
Michael Friedrich 8dd8af0512 Explain how to register functions in the global scope 2018-02-06 13:09:08 +01:00
Michael Friedrich 211a07f49a Add 'ttl' support for check result freshness via REST API
The `process-check-result` action can now optionally set the
`ttl` parameter. This overrules the configured freshness
check (check_interval).

The main idea behind this is to allow the external sender
to specify when the next check result is coming in.

For example, a backup script which should be run every
24h can specify the exact expected next check result.

The addition to the CheckResult class is necessary to
forward the check result throughout the cluster and
calculate the `next_check` value on each node. This
allows us to send in a check result on a satellite,
and the master determines the freshness and possible
notifications/state changes for Icinga Web 2.
2018-01-15 13:54:11 +01:00
cstegm b72bdfe5af
Update 08-advanced-topics.md
fixed typo
2018-01-11 16:48:40 +01:00
Gunnar Beutner 55b1cce248
Merge pull request #5744 from Icinga/feature/embedded-dummy-check
Implement DummyCheckTask and move dummy into embedded in-memory checks
2017-11-27 10:25:43 +01:00
Michael Friedrich 77851c0a48 Fix wrong anchors in the documentation
refs #5732
2017-11-15 11:12:32 +01:00
Michael Friedrich 6d9a0b7145 Implement DummyCheckTask and move dummy into embedded in-memory checks
This replaces the previous "dummy" CheckCommand, and the user won't
notice it. Provided performance data will be parsed the same way.

This saves a shell fork and check_dummy execution.

We're relying on this when creating cluster checks with Icinga 2 DSL
and more. If one does not have the plugins installed, this then also works.

fixes #5740
2017-11-09 20:19:31 +01:00
RobinOBrien 1eb97a88a9
Merge branch 'master' into fix/small-documentation-fix 2017-10-31 10:18:57 +02:00
Robin O'Brien 31a35a5966 Fixed grammer and spelling mistakes 2017-10-30 18:02:42 +02:00
bascarsija 4433ecea52 fixes minor typos in flapping detection documentation
refs #5703
2017-10-25 12:54:01 -07:00
Jean Flach a21ffd6fe4 Fix flapping
Re-implement flapping following the 'old way' of just observing the last
20 stage changes.

refs #4982
2017-10-24 15:54:05 +02:00
Michael Friedrich 1da5c53fee Enhance Monitoring Basics in the documentation
This commit adds documentation for

* custom attributes value types and nested dictionaries
* better introduction into apply rules and usage examples
* better apply for iterations and explanations
* notifications with users on the host/service objects explained in a dedicated chapter
* command arguments and set_if - which values are supported
* macro() as scoped function
* alternative host check command

This also changes all code and config snippets to use
three backticks instead of four spaces indent.

fixes #5663
fixes #5664
fixes #5665
fixes #5666
fixes #5667
fixes #5186
fixes #5060
fixes #5662
2017-10-10 21:08:19 +02:00
Michael Friedrich 2d8607d6b0 Enhance documentation with more details on value types for object attributes
Main focus: Object attributes and their value types. Originates from the
API Event Streams patch to document their value types. Now applied to
the entire configuration objects chapter.

The API chapter and their value types has been changed to capitalized
type identifiers.

Value types are now explicitly told about inside monitoring basics. This
has been adopted into the Icinga 2 training material a long time ago
and finds its way into the docs too.

The CheckResult and PerfdataValue value types have been moved into the
advanced topics chapter. mkdocs doesn't like multiple `#` headings in one file
and did just hide it.

Also moved the Influxdb details into the features documentation where it
belongs.

Many small references and URLs to other chapters added.
E.g. dedicated chapters for object accessor examples, to better link against
time dependent thresholds.

Can serve as patch basis and reference for ITL documentation where the
value types are missing too.

This commit also fixes the non-requirement of "legacy-timeperiod" which
also is a default template import since 2.6.

This also fixes the state mapping issue.

fixes #4015
2017-10-10 17:52:49 +02:00
Michael Friedrich 522eea1863 Fix wrong sub chapter for external checks 2017-08-18 17:13:59 +02:00
Michael Friedrich 75a41741c5 Docs: Update freshness checks; add chapter for external check results
This also adds a nice example for freshness checks with unknown runtime details.
2017-08-18 17:02:43 +02:00
Blerim Sheqa eb88217e2d Update docs for better compatibility with mkdocs
* Rename files to allow easy ordering
* Update links inside markdown according to new file names
* Move HTML links (<a>...</a>) to the end of the header lines
  * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC
  * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00