Add a generic Plugin for polling of JSON status APIs

208 votes

Many applications provide an HTTP API that can be used to query the health status, as is common with Docker containers.

It is about time for a rule-based check with which the JSON output can be evaluated:

Example:
{"status":"UP","components":{"module1":{"status":"UP","details":{"System":"available","Version":"1.5.0","Count":"5"}},"module2":{"status":"UP","details":{"System":"available","Version":"1.5.0","Count":"25"}}},}

* create for each key matching regex R a own Service with Label L as prefix (LABEL_KEY) or use only one Service with Name "LABEL"
* Verify that the key X exists
* Verify that the key X has a value less, equal or grater then N
* Verify that the key X has a value that matches/not matches one or more strings/regex
* Report value y of the key X as performance data

If any of these criteria are not met, report the worst state.

Under consideration Checks&Agents Suggested by: Lars Sörensen (25 May, '22) • Upvoted: 2 days ago • Comments: 13

Comments: 13

31 May, '22
Sascha
Hi Lars,
we have a plugin for this, that will do this. We have many Java Spring Boot Actuator Checks (Application-checks, written by the Application Developers), with we are importing this way.
Regards, Sascha
20 Jun, '22
Lars Sörensen
Hi Sascha

is it available as MKP or on Git?

It would of course be very welcome if Tribe29 includes something like this as an official plugin in their ecosystem to ensure optimal integration with current and future versions of CMK.

Regrads, Lars
06 Jul, '22
Markus
Hi Lars
I upvote your suggestion because the current plugin we are using is not 100% what we would like to have.
https://github.com/T-Systems-MMS/check_springboot_actuator
Event though we are going a step further and separate the checks into
<<<local>>>
0 global_status - UP
0 diskSpace - UP
we would like to have this included in the general build.
Regards
Marc
21 Mar, '23
Doc
A multistep implementation would be nice (wizard)
1. provide url with auth
2. show all json fields
3. decide which fiels should be shown/processed
4. create rule
2
03 Apr, '23
Nirav
Hi Sascha

We are also searching for the same kind of plugin in CheckMK where all spring boot actuator endpoints are exposed and can be displayed in CheckMK, can you please share the project?

Regards,
Nirav
31 Jan, '24
Daniel
@Sasha, any news? Can you share it?
1
05 Apr, '24
Simon Russell
I have a use case where Device42 supplies basic health data for its appliance via JSON. If I could read this data and choose which metrics to monitor it would be perfect. Documentation for Device42 can be found here https://support.device42.com/hc/en-us/articles/360033626413-How-we-can-monitor-Device42

Although the page mentions a Nagios plugin I would rather have this built in natively. I have also not been able to get the plugin to work in our testing.

Thanks,
Simon
1
18 Jul, '24
GK
Yes please add an generic /health endpoint. There is an /version endpoint but it's to limited. Not only for containers this is handy, but also for external monitoring the CheckMK instancens (who monitors the monitor?)
27 Nov, '24
Bastian Kuhn
This Plugin: https://exchange.checkmk.com/p/agent-json does basically the wanted thing.
18 Jan
Bastian Kuhn
Since I got several E-Mails with questions about my plugin, the expected Format there is:
```
{'checks', [{’name': 'My Check', ’status': 'UP', 'data': {'info1': „info', ’infox': 'more info'}]}
```
But this could be easily to adapted.
Details best check on the GitHub Page:
https://github.com/kuhn-ruess/Checkmk-Checks/tree/master/agent_json
1
04 Feb
JQ
I guess this is the format:

```
{
"checks": [
{
"name": "My Check",
"status": "UP",
"data": {
"info1": "info",
"infox": "more info"
}
}
]
}
```
16 Mar
Lars Sörensen
With all due respect to limited resources and competing priorities, it is incomprehensible that such a simple idea with a great benefit is never implemented, while many ideas that are less useful and time-consuming for the majority are implemented with much less support.

This raises the question of why we should vote in favour of any ideas at all if even such simple ideas are never considered by Checkmk. The lack of transparency and communication about why certain ideas are not considered only undermines trust in the feedback system.

It should not be forgotten that, in the end, Checkmk also benefits financially from the services that are generated by such a simple check.
1
2 days ago
Mohamed Saleh Admin
Hi Lars,

Thank you for sharing your feedback. Ideas, votes, comments, and suggestions are very important to us and help shape Checkmk. The Ideas Portal is one of our sources of input when we do product discovery, evaluate trends, and decide which problems to solve next. Even when we don't implement an idea right away, we often use it to understand underlying needs, inform future discussions about our plans, or invest in improvements that set the stage for later changes. Your contributions help us understand what matters most to you and our users, and we highly appreciate and rely on that valuable insight!