NetBox plugin for HealthCheck.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for netboxlabs-publisher from gravatar.com netboxlabs-publisher Avatar for worldnomad from gravatar.com worldnomad

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

NetBox HealthCheck Plugin

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

Version Python Versions License

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/

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

License

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

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for netboxlabs-publisher from gravatar.com netboxlabs-publisher Avatar for worldnomad from gravatar.com worldnomad

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.3.0

0.2.0

0.1.5b1 pre-release

0.1.4

0.1.2

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_healthcheck_plugin-0.3.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_healthcheck_plugin-0.3.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file netbox_healthcheck_plugin-0.3.0.tar.gz.

File metadata

File hashes

Hashes for netbox_healthcheck_plugin-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fafcebf37d9e0e239a1e8636aad95cdf21f94d383aa7b4afcff8299d00d108af
MD5 3806902b314a5efe1815cf47f6090181
BLAKE2b-256 0779d44dd7eb08934fca985383844b2eed0a7d8accaecc02fb0a3c017b79ff29

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_healthcheck_plugin-0.3.0.tar.gz:

Publisher: publish-pypi.yml on netbox-community/netbox-healthcheck-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_healthcheck_plugin-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_healthcheck_plugin-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 049ebdcb80fc53c0262a5432bec8dd649ebb406e3f9ca4a1a9323c2172eed382
MD5 b5fd5d6709879904cd88ee5bc01e0f76
BLAKE2b-256 aa30288c6fe05dfebfe14a6cefb8689940b22cc49775f002a5d8c1670c39e109

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_healthcheck_plugin-0.3.0-py3-none-any.whl:

Publisher: publish-pypi.yml on netbox-community/netbox-healthcheck-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page