From 7d4a7d4429cfc0eaaf44e92b1d39940fa1600a70 Mon Sep 17 00:00:00 2001 From: Chris Roche Date: Thu, 11 Jan 2018 17:38:05 -0800 Subject: [PATCH 1/4] admin: document /runtime endpoint Signed-off-by: Chris Roche --- docs/root/operations/admin.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 6e02b20d6..4aa49c905 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -164,3 +164,12 @@ The fields are: Outputs /stats in `Prometheus `_ 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. See :ref:`here ` 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. From 000f0c044e0f5982667b2980239c7e21ec46538e Mon Sep 17 00:00:00 2001 From: Chris Roche Date: Fri, 12 Jan 2018 09:36:19 -0800 Subject: [PATCH 2/4] differentiate human-readable from JSON formats Signed-off-by: Chris Roche --- docs/root/operations/admin.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 4aa49c905..ca483d83e 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -167,8 +167,9 @@ The fields are: .. http:get:: /runtime - Outputs all runtime values on demand. See :ref:`here ` for more information on - how these values are configured and utilized. + Outputs all runtime values on demand in a human-readable format. See + :ref:`here ` for more information on how these values are configured + and utilized. .. http:get:: /runtime?format=json From 1570e4426ee15fbb9e1063525a49d9dee75c8b9f Mon Sep 17 00:00:00 2001 From: Chris Roche Date: Fri, 12 Jan 2018 10:23:54 -0800 Subject: [PATCH 3/4] format Signed-off-by: Chris Roche --- docs/root/operations/admin.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index ca483d83e..1cac5da2d 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -167,8 +167,8 @@ The fields are: .. http:get:: /runtime - Outputs all runtime values on demand in a human-readable format. See - :ref:`here ` for more information on how these values are configured + Outputs all runtime values on demand in a human-readable format. See + :ref:`here ` for more information on how these values are configured and utilized. .. http:get:: /runtime?format=json From 3f25df4e90b18956cd238e2856f66df5e5c7e484 Mon Sep 17 00:00:00 2001 From: Chris Roche Date: Tue, 16 Jan 2018 10:47:22 -0800 Subject: [PATCH 4/4] change link per comments Signed-off-by: Chris Roche --- docs/root/operations/admin.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/root/operations/admin.rst b/docs/root/operations/admin.rst index 1cac5da2d..34392811a 100644 --- a/docs/root/operations/admin.rst +++ b/docs/root/operations/admin.rst @@ -168,7 +168,7 @@ The fields are: .. http:get:: /runtime Outputs all runtime values on demand in a human-readable format. See - :ref:`here ` for more information on how these values are configured + :ref:`here ` for more information on how these values are configured and utilized. .. http:get:: /runtime?format=json