Files
jupyterhub/docs/source/monitoring/index.rst
Rajat Goyal 65b83f5f00 Update docs/source/monitoring/index.rst
Co-authored-by: Erik Sundell <erik.i.sundell@gmail.com>
2020-09-30 22:08:50 +05:30

12 lines
859 B
ReStructuredText

Monitoring
===================
This section covers details on monitoring the state of your JupyterHub installation.
JupyterHub expose the ``/metrics`` endpoint that returns text describing its current operational state formatted in a way `Prometheus <https://prometheus.io/docs/introduction/overview/>_` understands. Prometheus is a separate open source tool that can be configured to repeatedly poll JupyterHub's ``/metrics`` endpoint to parse and save the momentary state. By doing so, Prometheus can describe JupyterHub's eolving state over time. This evolving state can then be accessed through Prometheus that expose its underlying storage to those allowed to access it, and be presented with dashboards by a tool like `Grafana <https://grafana.com/docs/grafana/latest/getting-started/what-is-grafana/>_`.
.. toctree::
:maxdepth: 2
gen/metrics