Health Check #2693

Closed
opened 2025-12-29 18:21:09 +01:00 by adam · 5 comments
Owner

Originally created by @szechyjs on GitHub (Jun 23, 2019).

Proposed Functionality

Add a health check endpoint.

Use Case

Having a health check endpoint helps with load balancers and monitoring services.

Database Changes

N/A

External Dependencies

Several out of the box options:

Originally created by @szechyjs on GitHub (Jun 23, 2019). ### Proposed Functionality Add a health check endpoint. ### Use Case Having a health check endpoint helps with load balancers and monitoring services. ### Database Changes N/A ### External Dependencies Several out of the box options: - https://github.com/KristianOellegaard/django-health-check - https://github.com/mwarkentin/django-watchman
adam closed this issue 2025-12-29 18:21:09 +01:00
Author
Owner

@jeremystretch commented on GitHub (Jun 24, 2019):

Monitoring is out of scope for NetBox. Please see the documentation.

@jeremystretch commented on GitHub (Jun 24, 2019): Monitoring is out of scope for NetBox. Please see [the documentation](https://netbox.readthedocs.io/en/stable/#what-netbox-is-not).
Author
Owner

@szechyjs commented on GitHub (Jun 24, 2019):

@jeremystretch I think you misunderstood the point of this. This is not to monitor other network assets, this is to have an endpoint within netbox itself that is able to report the health of itself. In other words, is netbox healthy and operational?

@szechyjs commented on GitHub (Jun 24, 2019): @jeremystretch I think you misunderstood the point of this. This is not to monitor other network assets, this is to have an endpoint within netbox itself that is able to report the health of **itself**. In other words, is netbox healthy and operational?
Author
Owner

@jeremystretch commented on GitHub (Jul 3, 2019):

IMO the functionality proposed does not meet the bar for introducing a new dependency (django-watchman).

@jeremystretch commented on GitHub (Jul 3, 2019): IMO the functionality proposed does not meet the bar for introducing a new dependency (`django-watchman`).
Author
Owner

@lampwins commented on GitHub (Jul 3, 2019):

This is why we implemented Prometheus metrics. You don't have to use a Prometheus server to use the exposed metrics as a health page.

@lampwins commented on GitHub (Jul 3, 2019): This is why we implemented Prometheus metrics. You don't have to use a Prometheus server to use the exposed metrics as a health page.
Author
Owner

@jeremystretch commented on GitHub (Jul 30, 2019):

I don't think this belongs in core. Maybe a good candidate for a plugin in a future release.

@jeremystretch commented on GitHub (Jul 30, 2019): I don't think this belongs in core. Maybe a good candidate for a plugin in a future release.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2693