diff --git a/presto-docs/src/main/sphinx/presto_cpp/features.rst b/presto-docs/src/main/sphinx/presto_cpp/features.rst index 28c2b2ff77d87..a0d4a69de94b7 100644 --- a/presto-docs/src/main/sphinx/presto_cpp/features.rst +++ b/presto-docs/src/main/sphinx/presto_cpp/features.rst @@ -22,8 +22,8 @@ HTTP endpoints related to tasks are registered to Proxygen in Other HTTP endpoints include: -* POST: v1/memory - * Reports memory, but no assignments are adjusted unlike in Java workers. +* POST: v1/memory: Reports memory, but no assignments are adjusted unlike in Java workers +* GET: v1/info/metrics: Returns worker metrics in Prometheus format * GET: v1/info * GET: v1/status @@ -185,6 +185,20 @@ Old task is defined as a PrestoTask which has not received heartbeat for at leas ``old-task-cleanup-ms``, or is not running and has an end time more than ``old-task-cleanup-ms`` ago. +Worker metrics collection +------------------------- + +Users can enable collection of worker level metrics by setting the property: + +``runtime-metrics-collection-enabled`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* **Type:** ``boolean`` +* **Default value:** ``false`` + + If the Presto C++ server was compiled with + PRESTO_ENABLE_PROMETHEUS_REPORTER set to ON, the server exposes an endpoint ``/v1/info/metrics`` to collect + metrics in prometheus format. + Session Properties ------------------ diff --git a/presto-docs/src/main/sphinx/presto_cpp/properties.rst b/presto-docs/src/main/sphinx/presto_cpp/properties.rst index f9328ee554f5c..d451ecd016b69 100644 --- a/presto-docs/src/main/sphinx/presto_cpp/properties.rst +++ b/presto-docs/src/main/sphinx/presto_cpp/properties.rst @@ -127,6 +127,13 @@ The configuration properties of Presto C++ workers are described here, in alphab The exceeding capacity must allocate from the non-reserved query memory. +``runtime-metrics-collection-enabled`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* **Type:** ``boolean`` +* **Default value:** ``false`` + + Enables collection of worker level metrics. + ``system-memory-gb`` ^^^^^^^^^^^^^^^^^^^^