Skip to content

Latest commit

 

History

History
82 lines (64 loc) · 1.9 KB

README.md

File metadata and controls

82 lines (64 loc) · 1.9 KB
Raw

About check_springboot_actuator

This is an Nagios/Icinga check plugin for Spring Boot applications using the actuator framework. The check inspects the response from the health and metrics endpoints.

Features

The check checks the status field from the health endpoint for

  • global status
  • cassandra status
  • diskSpace status
  • db
  • dataSource status
  • elasticsearch status
  • jms status
  • mail status
  • mongo status
  • rabbit status
  • redis status
  • solr status
  • vault
  • livenessState status
  • readinessState status
  • ping status
  • couchbase status
  • hazelcast status
  • influxdb status
  • ldap status
  • neo4j status

The check aggregates metrics for the counter.status data from the metrics endpoints.

License

check_springboot_actuator is licensed under the terms of the MIT license as described in the LICENSE file.

Requirements

check_springboot_actuator runs on Python 2.7 and 3.x. It was originaly build for RHEL/CentOS 7 with EPEL repositories enabled:

yum -y install epel-release
yum -y install pynag python-requests

check_springboot_actuator will run on newer OS releases with Python 3. Dependencies can be installed using a package manager or via pip:

python3 -m pip install -r requirements.txt

Usage

The check can be run from a shell either using ./check_springboot_actuator.py or python3 check_springboot_actuator.py depending on your OS and Python version.

Development

Dependency update

Minimum dependency versions are defined in requirements.in. The requirements.txt file has been generated by pip-compile. Perform the following steps to update requirements.txt to newer dependency versions:

python3 -m pip install -U pip-tools
pip-compile --upgrade