Check API v2: Check Manual For Custom Checkmk Based Check

Checkmk Dev&Exchange
1

Hi,

I have not found the directory yet where to place the check manual for my own custom check plugins written for v2 of the check api. I neither found something about that in Writing agent-based check plug-ins nor in Guidelines for coding check plug-ins.

It must be something different from the old place under ~/local/share/check_mk/checkman because User Messages under Version 2.3.0p33 say:

Check man page uses an API (legacy) which is marked as deprecated in Checkmk 2.3.0 and will be removed in Checkmk 2.4.0 (File: local/share/check_mk/checkman/PLUGINNAME)

Thank you in advance for your help!
Zille

2

it is a checkman directory inside the collection, on the same level as the agent_based and rulesets directories.

3

Thank you for the quick help. That is the right place to put the manuals.

One further question:
The manuals are written in YAML, although they must not have an .yml ending. E.g.:

title:
Check the status Powershell DSC Rollout on Windows Server
agents:
windows
…

The output in the GUI shows just one line, which is hard to read. I wonder how to make it readable. Do you have a hint for me?

4

Just a notice to the code I posted:
The editor here erased the indentation. So missing YAML indentation in my check manual is NOT the problem.

5

It’s actually not YAML. Just the header looks like YAML.

You can force a line break with <br> and separate paragraphs with an empty line. That’s it.

1 Like
6

Thank you Dirk for all the useful information. Thank you, Robert, as well. Now I have everything I need to work with the new v2 Check API.

1 Like