NetBox HealthCheck Plugin

A NetBox plugin that provides comprehensive health monitoring for your NetBox installation.

Features

This plugin integrates django-health-check with NetBox to provide health monitoring of critical services:

• Database - PostgreSQL connectivity and operations
• Cache - Django cache framework (Redis-backed)
• Redis Instances - Both caching and task queue Redis connections
• Extensible - Add custom health checks via configuration

Health status is exposed at /plugins/netbox_healthcheck_plugin/healthcheck/ with both HTML and JSON response formats for integration with monitoring systems.

Installation

pip install netbox-healthcheck-plugin

Add to your NetBox configuration.py:

PLUGINS = ['netbox_healthcheck_plugin']

PLUGINS_CONFIG = {
    "netbox_healthcheck_plugin": {}
}

Restart NetBox and visit: https://your-netbox/plugins/netbox_healthcheck_plugin/healthcheck/

Compatibility

See COMPATIBILITY.md for detailed version information.

Configuration

Customize which health checks run via PLUGINS_CONFIG:

PLUGINS_CONFIG = {
    "netbox_healthcheck_plugin": {
        "checks": [
            "health_check.Database",
            "health_check.Cache",
            "netbox_healthcheck_plugin.backends.redis.NetBoxRedisCacheHealthCheck",
            "netbox_healthcheck_plugin.backends.redis.NetBoxRedisTasksHealthCheck",
        ]
    }
}

You can add custom health checks or disable specific checks. See the Configuration Guide for more options.

Documentation

Full documentation is available at: https://netbox-community.github.io/netbox-healthcheck-plugin/

• Quickstart
• Configuration Options
• Contributing Guidelines
• Releases

Development

Tests run inside a NetBox checkout using NetBox's test runner, with this repo's testing/configuration.py (see AGENTS.md for the full setup):

pip install -e '.[dev,test]'
export NETBOX_CONFIGURATION=configuration PYTHONPATH="$PWD/testing"
python /path/to/netbox/netbox/manage.py test netbox_healthcheck_plugin.tests

pre-commit install           # lint/format hooks (ruff, djlint, codespell, yamllint)
pre-commit run --all-files

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Source: GitHub Repository

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.