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

NetBox Version	Plugin Version	Python Version
4.5+	0.3.0	3.12, 3.13, 3.14
4.0 - 4.4	0.2.0	3.10, 3.11, 3.12
3.4 - 3.7	0.1.x	3.10, 3.11, 3.12

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.backends.CacheBackend",
            "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/

• Installation Guide
• Configuration Options
• Contributing Guidelines
• Changelog

Development

This plugin uses Ruff for linting and formatting:

# Install development dependencies
pip install -e ".[test,docs]"

# Run linting and formatting
ruff check .
ruff format .

# Run tests
pytest

# Install pre-commit hooks
pre-commit install

# Build documentation
mkdocs serve

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.