Prometheus exporter for kobo hub
Project description
Prometheus exporter for kobo hub.
Overview
The kobo framework provides, among other things, a Django-based "hub" web service which is used to manage tasks and workers.
django-kobo-exporter is a Django app which may be installed to a kobo hub in order to add a prometheus-compatible metrics endpoint exposing kobo metrics.
Usage
- Ensure
django-kobo-exporter
is installed, e.g.
pip install django-kobo-exporter
- In your app's settings, add
kobo_exporter
toINSTALLED_APPS
, e.g.
INSTALLED_APPS = [
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'kobo.django.auth',
'django.contrib.messages',
'django.contrib.admin',
'django.contrib.staticfiles',
'kobo.django.xmlrpc',
'kobo.hub',
# added here
'kobo_exporter',
# your app's own stuff below...
...,
]
- Mount
kobo_exporter.urls
somewhere in your project.
/kobo_exporter/
is recommended; for example, in your root urlpatterns:
from django.urls import include, path
urlpatterns = [
# ... snip ...
path('kobo_exporter/', include('kobo_exporter.urls')),
# ... snip ...
]
- Access metrics at
<your_service>/kobo_exporter/metrics
.
The metrics endpoint will provide basic information on workers, as in example:
# HELP kobo_worker_enabled 1 if worker is enabled
# TYPE kobo_worker_enabled gauge
kobo_worker_enabled{worker="localhost"} 1.0
kobo_worker_enabled{worker="pub-dev-pubd7"} 1.0
# HELP kobo_worker_ready 1 if worker is ready
# TYPE kobo_worker_ready gauge
kobo_worker_ready{worker="localhost"} 1.0
kobo_worker_ready{worker="pub-dev-pubd7"} 1.0
# HELP kobo_worker_load Current load of worker (sum of task weights)
# TYPE kobo_worker_load gauge
kobo_worker_load{worker="localhost"} 0.0
kobo_worker_load{worker="pub-dev-pubd7"} 0.0
# HELP kobo_worker_max_load Maximum permitted load of worker
# TYPE kobo_worker_max_load gauge
kobo_worker_max_load{worker="localhost"} 60.0
kobo_worker_max_load{worker="pub-dev-pubd7"} 60.0
# HELP kobo_worker_open_tasks Current number of OPEN tasks for worker
# TYPE kobo_worker_open_tasks gauge
kobo_worker_open_tasks{worker="localhost"} 0.0
kobo_worker_open_tasks{worker="pub-dev-pubd7"} 0.0
# HELP kobo_worker_last_seen_seconds Time of worker's last communication with hub
# TYPE kobo_worker_last_seen_seconds gauge
kobo_worker_last_seen_seconds{worker="localhost"} 1.625644554e+09
kobo_worker_last_seen_seconds{worker="pub-dev-pubd7"} 0.0
License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-kobo-exporter-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ebe1cbdb1ef898816688587eb4aa3134a8ca66027d8b4c15731ee187dafa1f7 |
|
MD5 | 25119fc2d8c9b8ab2de76950d4836c4d |
|
BLAKE2b-256 | b362a84204786ac6181b03cdb69cbf4921a730c1f617d1a95268c7dbd5273b43 |
Hashes for django_kobo_exporter-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18931d3df69f8007bb9695192d01f2dce3f04c69b40b4cea180cf17de3a755c7 |
|
MD5 | d751d3333bd85b06979170d0d95f0425 |
|
BLAKE2b-256 | 1f911e57c4ba965b0cd19a51ccab15e00dd354fb872e8552cc8830d59c26d4df |