Skip to content

admin: document /runtime endpoint #414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 4 commits into from
Jan 16, 2018
Merged

admin: document /runtime endpoint #414

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d4a7d4
admin: document /runtime endpoint
Jan 12, 2018
000f0c0
differentiate human-readable from JSON formats
Jan 12, 2018
1570e44
format
Jan 12, 2018
3f25df4
change link per comments
Jan 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/root/operations/admin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,3 +164,13 @@ The fields are:
Outputs /stats in `Prometheus <https://prometheus.io/docs/instrumenting/exposition_formats/>`_
v0.0.4 format. This can be used to integrate with a Prometheus server. Currently, only counters and
gauges are outputed. Histograms will be outputed in a future update.

.. http:get:: /runtime

Outputs all runtime values on demand in a human-readable format. See
:ref:`here <arch_overview_runtime>` for more information on how these values are configured
and utilized.

.. http:get:: /runtime?format=json

Outputs /runtime in JSON format. This can be used for programmatic access of runtime values.