Update metric docs

palantir · Oct 3, 2023 · fe26204 · fe26204
1 parent 66ba6bd
commit fe26204
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/dialogue-clients/metrics.md b/dialogue-clients/metrics.md
@@ -71,7 +71,7 @@ Dialogue-specific metrics that are not necessarily applicable to other client im
 - `dialogue.client.request.queued.time` tagged `channel-name` (timer): Time spent waiting in the queue before execution.
 - `dialogue.client.request.endpoint.queued.time` tagged `channel-name`, `service-name`, `endpoint` (timer): Time spent waiting in the queue before execution on a specific endpoint due to server QoS.
 - `dialogue.client.request.sticky.queued.time` tagged `channel-name` (timer): Time spent waiting in the sticky queue before execution attempt.
-- `dialogue.client.requests.size` (histogram): Size of requests
+- `dialogue.client.requests.size` (histogram): Histogram of the sizes of requests larger than a threshold (1 MiB).
   - `repeatable` values (`true`,`false`)
   - `channel-name`
   - `service-name`

diff --git a/dialogue-core/src/main/metrics/dialogue-core-metrics.yml b/dialogue-core/src/main/metrics/dialogue-core-metrics.yml
@@ -64,7 +64,7 @@ namespaces:
         - name: channel-name
         - name: service-name
         - name: endpoint
-        docs: Size of requests
+        docs: Histogram of the sizes of requests larger than a threshold (1 MiB).
       # Note: the 'dialogue.client.create' metric is also defined in the apache metrics.
       create:
         type: meter