Skip to content

Commit

Permalink
DOCS-10 - Improve findability of operational metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
joel-hamill committed Dec 28, 2017
1 parent a6ecc72 commit 55c87b3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Build products
target/
docs/_build/
.DS_Store

# IntelliJ data
*.iml
Expand Down
6 changes: 6 additions & 0 deletions docs/monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ understand how the proxy is being used and track down specific performance probl
In addition to the metrics defined below, the REST proxy also exposes the
wealth of metrics that are provided by the underlying Jetty server.

.. contents::

Global Metrics
~~~~~~~~~~~~~~

Expand Down Expand Up @@ -90,6 +92,8 @@ one of these values. For example, to find the rate of ``GET /brokers`` API calls
endpoint name ``brokers.list`` with the metric name ``request-rate`` to get
``brokers.list.request-rate``.

============================== ===================================================================
Endpoint Name API Endpoint Method
============================== ===================================================================
``brokers.list`` ``GET /brokers``
``consumer.commit`` ``POST /consumers/{group}/instances/{instance}/offsets``
Expand Down Expand Up @@ -117,6 +121,8 @@ endpoint name ``brokers.list`` with the metric name ``request-rate`` to get

For API v2:

=================================== ======================================================================
Endpoint Name API Endpoint Method
=================================== ======================================================================
``consumer.commit-offsets+v2`` ``POST /consumers/{group}/instances/{instance}/offsets``
with ``Content-Type: application/vnd.kafka.v2+json`` header
Expand Down

0 comments on commit 55c87b3

Please sign in to comment.