Commit Graph

27 Commits

Author SHA1 Message Date
Julian Brost 9463c937e6
Fix documentation for parse_performance_data DSL function
The function does not support parsing multiple values at once but instead
generates labels like "foo=1 bar":

  Icinga 2 (version: v2.13.0-729-g8fe957bc2)
  Type $help to view available commands.
  <1> => parse_performance_data("foo=1 bar=2")
  {
  	counter = false
  	crit = null
  	label = "foo=1 bar"
  	max = null
  	min = null
  	type = "PerfdataValue"
  	unit = ""
  	value = 2.000000
  	warn = null
  }

While a function with the documented behavior would probably be more useful,
that change can't be made in a compatible way as this would have to change the
return type from PerfdataValue to Array.
2023-05-22 16:56:43 +02:00
Baptiste Beauplat 905a1dd474
Fix match function signature to match its description 2021-06-17 14:37:51 +02:00
Alexander A. Klimov 6f253f88b5 Sort doc/18-library-reference.md 2020-09-28 17:27:38 +02:00
Michael Friedrich 6118f69c50 Docs: Add get_templates{,s} to Library Reference 2019-11-15 12:53:33 +01:00
Michael Friedrich 5aa07b51a2 Docs: Rename 'custom attribute' to 'custom variable'
refs #6830
2019-07-19 14:38:59 +02:00
Lucas Bremgartner 7f04d4dc63
Docs: fix typo 2019-06-03 09:03:16 +02:00
Michael Friedrich 863af5afb4 Docs: Update version specific changes for 2.11
- Notification commands 2.7 dropped, reference to MTAs added
- Sysconfig variable locations
- Version bumps
2019-04-08 14:08:14 +02:00
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
Michael Friedrich f3cd3eb870 DSL: Implement getenv()
This patch also restores Utility::GetFromEnvironment()
and replaces the hardcoded `getenv()` calls.
2018-11-19 18:11:16 +01:00
Gunnar Beutner a5a0119799 Implement the Dictionary#clear script function 2018-08-02 08:45:19 +02:00
Adam Bolte f3c2a0d235
Fix $ipaddress6$ attribute name typo in the docs
fixes #6329
2018-05-24 17:47:03 +10:00
Gunnar Beutner e361b3c427 Implement support for frozen arrays and dictionaries 2018-01-30 12:22:04 +01: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
Gunnar Beutner 5179faceab Implement new script functions: path_exists, glob and glob_recursive 2017-09-18 13:59:03 +02:00
Michael Friedrich 261bd93c0b Implement get_services(host {name,object}) and add host object support for get_service()
This includes some debug console examples too which involve advanced
map() and filter examples for better readability.

refs #4912
2017-08-28 19:54:26 +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
Michael Friedrich f79332df5c Docs: Update examples for match/regex/cidr_match and mode for arrays (Match{All,Any})
refs #5480
2017-08-11 15:02:41 +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
Michael Friedrich 9371004bd0 Docs: Fix formatting issues and broken URLs 2017-06-07 14:27:28 +02:00
Gunnar Beutner 958d3982c5 Add 'mode' argument for match, regex and cidr_match 2017-05-16 13:22:10 +02:00
Gunnar Beutner dc9f129060 Implement the Array#any and Array#all protoype functions 2017-05-15 15:59:44 +02:00
Gunnar Beutner 1b77f4b336 Implement the Dictionary#values prototype function 2017-05-15 15:54:48 +02:00
Michael Friedrich 1c816ac9ad Update documentation (troubleshooting, monitor Icinga 2, configs, integrations, etc.)
fixes #5137
fixes #5140
fixes #1880
fixes #5142
fixes #5144
2017-04-05 20:13:32 +02:00
Gunnar Beutner 39ca1b8460 Fix: The last example for typeof() is missing the result
fixes #5097
2017-03-28 09:06:27 +02:00
Gunnar Beutner 809de354ff Update documentation for match()
refs #13327
2016-12-07 14:57:19 +01:00
Michael Friedrich 6c975dab5f Docs: Update API and Library Reference chapters
New sub chapters for global functions linked everywhere.
New API examples and clarifications.

fixes #13327
fixes #12449
2016-11-25 15:31:10 +01:00
Michael Friedrich 4a3b33e3f5 Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter
Also apply a new structure.

Deleted the old cluster and client documentation and started "fresh".

This commit also includes various images used in the newly written
"Distributed Monitoring" chapter for better understanding.

fixes #12386
2016-08-14 17:56:38 +02:00