hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-10 19:43:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2891 from rajat404/auto-gen-docs

Browse Source 
Generate prometheus metrics docs
This commit is contained in:
Erik Sundell
2020-10-01 11:40:05 +02:00
committed by GitHub
parent 1244533387 8c30724f17
commit 9f8c1decc4
7 changed files with 89 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/reference/index.rst
View File

@@ -16,6 +16,7 @@ what happens under-the-hood when you deploy and configure your JupyterHub.
proxy
separate-proxy
rest
monitoring
database
templates
../events/index

20
docs/source/reference/monitoring.rst Normal file
View File

@@ -0,0 +1,20 @@
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 its current state.
By doing so, Prometheus can describe JupyterHub's evolving 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
metrics