From 167aa4f2159c0a212346ae589d381325344fc5cf Mon Sep 17 00:00:00 2001 From: Lord Hepipud Date: Mon, 7 Feb 2022 13:23:03 +0100 Subject: [PATCH] Fixes link to metrics over time docs --- lib/core/framework/Publish-IcingaPluginDocumentation.psm1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/core/framework/Publish-IcingaPluginDocumentation.psm1 b/lib/core/framework/Publish-IcingaPluginDocumentation.psm1 index 5aecf460..0632a07e 100644 --- a/lib/core/framework/Publish-IcingaPluginDocumentation.psm1 +++ b/lib/core/framework/Publish-IcingaPluginDocumentation.psm1 @@ -38,7 +38,7 @@ function Publish-IcingaPluginDocumentation() Add-Content -Path $PluginDocFile -Value ''; Add-Content -Path $PluginDocFile -Value 'To test thresholds with different input values, you can use the Framework Cmdlet `Get-IcingaHelpThresholds`.'; Add-Content -Path $PluginDocFile -Value ''; - Add-Content -Path $PluginDocFile -Value 'Each plugin ships with a constant Framework argument `-ThresholdInterval`. This can be used to modify the value your thresholds are compared against from the current, fetched value to one collected over time by the Icinga for Windows daemon. In case you [registered service checks](https://icinga.com/docs/icinga-for-windows/latest/doc/service/10-Register-Service-Checks/) for specific time intervals, you can for example set the argument to `15m` to get the average value of 15m as base for your monitoring values. Please note that in this example, you will require to have collected the `15m` average for `Invoke-IcingaCheckCPU`.'; + Add-Content -Path $PluginDocFile -Value 'Each plugin ships with a constant Framework argument `-ThresholdInterval`. This can be used to modify the value your thresholds are compared against from the current, fetched value to one collected over time by the Icinga for Windows daemon. In case you [Collect Metrics Over Time](https://icinga.com/docs/icinga-for-windows/latest/doc/110-Installation/06-Collect-Metrics-over-Time/) for specific time intervals, you can for example set the argument to `15m` to get the average value of 15m as base for your monitoring values. Please note that in this example, you will require to have collected the `15m` average for `Invoke-IcingaCheckCPU`.'; Add-Content -Path $PluginDocFile -Value ''; Add-Content -Path $PluginDocFile -Value '```powershell'; Add-Content -Path $PluginDocFile -Value 'icinga> icinga { Invoke-IcingaCheckCPU -Warning 20 -Critical 40 -Core _Total -ThresholdInterval 15m }'