Skip to content

Commit 2d883db

Browse files
authored
Merge pull request #466 from Icinga:fix/plugin_doc_creator_metrics_over_time_url
Fix Link to metrics over time docs Fixes link to metric over time for plugin documentation writer
2 parents b9aaaa0 + 167aa4f commit 2d883db

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

lib/core/framework/Publish-IcingaPluginDocumentation.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ function Publish-IcingaPluginDocumentation()
3838
Add-Content -Path $PluginDocFile -Value '';
3939
Add-Content -Path $PluginDocFile -Value 'To test thresholds with different input values, you can use the Framework Cmdlet `Get-IcingaHelpThresholds`.';
4040
Add-Content -Path $PluginDocFile -Value '';
41-
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`.';
41+
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`.';
4242
Add-Content -Path $PluginDocFile -Value '';
4343
Add-Content -Path $PluginDocFile -Value '```powershell';
4444
Add-Content -Path $PluginDocFile -Value 'icinga> icinga { Invoke-IcingaCheckCPU -Warning 20 -Critical 40 -Core _Total -ThresholdInterval 15m }'

0 commit comments

Comments
 (0)