robertlynch3 / netbox-healthcheck-plugin

NetBox HealthCheck Plugin

NetBox provides health check monitors that can be queried to make sure that the service is running in good condition.

NetBox exposes metrics at the /healthcheck HTTP endpoint, e.g. https://netbox.local/healthcheck. It allows monitor conditions via HTTP(S), with responses available in HTML and JSON formats.

• Free software: Apache-2.0
• Documentation: https://netbox-community.github.io/netbox-healthcheck-plugin/.

Features

The features the plugin provides should be listed here.

Compatibility

NetBox Version	Plugin Version
3.4	0.1.0

Installing

For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.

While this is still in development and not yet on pypi you can install with pip:

pip install git+https://github.com/arthanson/netbox_healthcheck_plugin

or by adding to your local_requirements.txt or plugin_requirements.txt (netbox-docker):

git+https://github.com/arthanson/netbox_healthcheck_plugin

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py, or if you use netbox-docker, your /configuration/plugins.py file :

PLUGINS = [
    'HealthCheck'
]

PLUGINS_CONFIG = {
    "HealthCheck": {},
}

Setting up Monitoring

NetBox makes use of the django-health-check library, more information on setting up monitors can be found at Setting up Monitoring:

Credits

Based on the NetBox plugin tutorial:

• demo repository
• tutorial

This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin project template.