tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-09-23 17:57:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Add verbose tip for plugin creation

Browse Source
This commit is contained in:
Michael Friedrich 2019-06-05 11:21:07 +02:00
parent 97f5663872
commit 78b04cb6cf
1 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
doc/05-service-monitoring.md
View File

@ -438,8 +438,17 @@ Testcase 5: Transactions fine.
``` ```
If the extended output shouldn't be visible in your monitoring, but only for testing, If the extended output shouldn't be visible in your monitoring, but only for testing,
it is recommended to implement the `-v` or `--verbose` plugin parameter to allow it is recommended to implement the `--verbose` plugin parameter to allow
developers and users to debug further. developers and users to debug further. Check [here](05-service-monitoring.md#service-monitoring-plugin-api-verbose)
for more implementation tips.
> **Tip**
>
> More debug output also helps when implementing your plugin.
>
> Best practice is to have the plugin parameter and handling implemented first,
> then add it anywhere you want to see more, e.g. from initial database connections
> to actual query results.
#### Status <a id="service-monitoring-plugin-api-status"></a> #### Status <a id="service-monitoring-plugin-api-status"></a>
@ -508,9 +517,35 @@ __version__ = '0.9.1'
if __name__ == '__main__': if __name__ == '__main__':
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
parser.add_argument('-V', '--version', action='version', version='%(prog)s v' + sys.modules[__name__].__version__) parser.add_argument('-V', '--version', action='version', version='%(prog)s v' + sys.modules[__name__].__version__)
``` ```
#### Verbose <a id="service-monitoring-plugin-api-verbose"></a>
Plugins should provide a verbose mode with `-v` or `--verbose` in order
to show more detailed log messages. This helps to debug and analyse the
flow and execution steps inside the plugin.
Ensure to add the parameter prior to implementing the check logic into
the plugin.
Example in Python taken from [check_tinkerforge](https://github.com/NETWAYS/check_tinkerforge/blob/master/check_tinkerforge.py):
```
import argparse
import signal
import sys
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('-v', '--verbose', action='store_true')
if args.verbose:
print("Verbose debug output")
```
### Create a new Plugin <a id="service-monitoring-plugin-new"></a> ### Create a new Plugin <a id="service-monitoring-plugin-new"></a>
Sometimes an existing plugin does not satisfy your requirements. You Sometimes an existing plugin does not satisfy your requirements. You
@ -582,6 +617,10 @@ The following examples should help you to start implementing your own ideas.
There is a variety of plugins available. This collection is not complete -- There is a variety of plugins available. This collection is not complete --
if you have any updates, please send a documentation patch upstream. if you have any updates, please send a documentation patch upstream.
Please visit our [community forum](https://community.icinga.com) which
may provide an answer to your use case already. If not, do not hesitate
to create a new topic.
### General Monitoring <a id="service-monitoring-general"></a> ### General Monitoring <a id="service-monitoring-general"></a>
If the remote service is available (via a network protocol and port), If the remote service is available (via a network protocol and port),