NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-17 04:58:16 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Add health check endpoint

Browse Source
This commit is contained in:
Jared Szechy 2019-07-02 21:59:01 -04:00
parent 3da9af5a9f
commit 1964ab24f7
No known key found for this signature in database
GPG Key ID: E4188B1F15290E1A
4 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
netbox/netbox/configuration.example.py
View File

@ -166,6 +166,9 @@ TIME_ZONE = 'UTC'
# database be configured and accessible by NetBox. # database be configured and accessible by NetBox.
WEBHOOKS_ENABLED = False WEBHOOKS_ENABLED = False
# The health check endpoint reports if NetBox is operational, Set this to True to enable it.
HEALTH_CHECK_ENABLED = False
# Date/time formatting. See the following link for supported formats: # Date/time formatting. See the following link for supported formats:
# https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date # https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
DATE_FORMAT = 'N j, Y' DATE_FORMAT = 'N j, Y'

4
netbox/netbox/settings.py
View File

@ -92,6 +92,7 @@ SHORT_TIME_FORMAT = getattr(configuration, 'SHORT_TIME_FORMAT', 'H:i:s')
TIME_FORMAT = getattr(configuration, 'TIME_FORMAT', 'g:i a') TIME_FORMAT = getattr(configuration, 'TIME_FORMAT', 'g:i a')
TIME_ZONE = getattr(configuration, 'TIME_ZONE', 'UTC') TIME_ZONE = getattr(configuration, 'TIME_ZONE', 'UTC')
WEBHOOKS_ENABLED = getattr(configuration, 'WEBHOOKS_ENABLED', False) WEBHOOKS_ENABLED = getattr(configuration, 'WEBHOOKS_ENABLED', False)
HEALTH_CHECK_ENABLED = getattr(configuration, 'HEALTH_CHECK_ENABLED', False)
# #
@ -189,6 +190,9 @@ INSTALLED_APPS = [
if WEBHOOKS_ENABLED: if WEBHOOKS_ENABLED:
INSTALLED_APPS.append('django_rq') INSTALLED_APPS.append('django_rq')
if HEALTH_CHECK_ENABLED:
INSTALLED_APPS.append('watchman')
# Middleware # Middleware
MIDDLEWARE = ( MIDDLEWARE = (
'debug_toolbar.middleware.DebugToolbarMiddleware', 'debug_toolbar.middleware.DebugToolbarMiddleware',

5
netbox/netbox/urls.py
View File

@ -79,6 +79,11 @@ if settings.METRICS_ENABLED:
path('', include('django_prometheus.urls')), path('', include('django_prometheus.urls')),
] ]
if settings.HEALTH_CHECK_ENABLED:
_patterns += [
path(r'health/', include('watchman.urls')),
]
# Prepend BASE_PATH # Prepend BASE_PATH
urlpatterns = [ urlpatterns = [
path(r'{}'.format(settings.BASE_PATH), include(_patterns)) path(r'{}'.format(settings.BASE_PATH), include(_patterns))

1
requirements.txt
View File

@ -10,6 +10,7 @@ django-tables2==2.0.6
django-taggit==1.1.0 django-taggit==1.1.0
django-taggit-serializer==0.1.7 django-taggit-serializer==0.1.7
django-timezone-field==3.0 django-timezone-field==3.0
django-watchman==0.17.0
djangorestframework==3.9.4 djangorestframework==3.9.4
drf-yasg[validation]==1.16.0 drf-yasg[validation]==1.16.0
graphviz==0.10.1 graphviz==0.10.1