Skip to content

Commit

Permalink
[native] Prestissimo worker metrics documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
karteekmurthys committed Jul 2, 2024
1 parent dcb4ed5 commit 66ce566
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
18 changes: 16 additions & 2 deletions presto-docs/src/main/sphinx/presto_cpp/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
------------------
Expand Down
7 changes: 7 additions & 0 deletions presto-docs/src/main/sphinx/presto_cpp/properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 66ce566

Please sign in to comment.