This is an automated email from the ASF dual-hosted git repository.
jtuglu1 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new 29eaed52c6c fix: adjust docs for query/segments/count metric (#19639)
29eaed52c6c is described below
commit 29eaed52c6c894a8bc3315d5bb732824bbe0928e
Author: jtuglu1 <[email protected]>
AuthorDate: Mon Jun 29 20:35:01 2026 -0700
fix: adjust docs for query/segments/count metric (#19639)
Follow-up from #19624 to explicitly call out this new metric is not enabled
by default.
---
docs/operations/metrics.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/operations/metrics.md b/docs/operations/metrics.md
index a3390f86a2a..f4757760b71 100644
--- a/docs/operations/metrics.md
+++ b/docs/operations/metrics.md
@@ -64,7 +64,7 @@ Most metric values reset each emission period, as specified
in `druid.monitoring
|`query/failed/count`|Number of failed queries.|This metric is only available
if the `QueryCountStatsMonitor` module is included.| |
|`query/interrupted/count`|Number of queries interrupted due to
cancellation.|This metric is only available if the `QueryCountStatsMonitor`
module is included.| |
|`query/timeout/count`|Number of timed out queries.|This metric is only
available if the `QueryCountStatsMonitor` module is included.| |
-|`query/segments/count`|Number of segments that will be touched by the query.
The Broker makes a plan to distribute the query to realtime tasks and
historicals based on a snapshot of segment distribution state. If there are
some segments moved after this snapshot is created, certain historicals and
realtime tasks can report those segments as missing to the Broker. The Broker
will resend the query to the new servers that serve those segments after move.
In this case, those segments can be [...]
+|`query/segments/count`|This metric is not enabled by default. Number of
segments that will be touched by the query. The Broker makes a plan to
distribute the query to realtime tasks and historicals based on a snapshot of
segment distribution state. If there are some segments moved after this
snapshot is created, certain historicals and realtime tasks can report those
segments as missing to the Broker. The Broker will resend the query to the new
servers that serve those segments after mo [...]
|`query/priority`|Assigned lane and priority, only if Laning strategy is
enabled. Refer to [Laning
strategies](../configuration/index.md#laning-strategies)|`lane`, `dataSource`,
`type`|0|
|`sqlQuery/time`|Milliseconds taken to complete a SQL query.|`id`,
`nativeQueryIds`, `dataSource`, `remoteAddress`, `success`, `engine`,
`statusCode`|< 1s|
|`sqlQuery/planningTimeMs`|Milliseconds taken to plan a SQL to native
query.|`id`, `nativeQueryIds`, `dataSource`, `remoteAddress`, `success`,
`engine`| |
@@ -107,7 +107,7 @@ Most metric values reset each emission period, as specified
in `druid.monitoring
|Metric|Description|Dimensions|Normal value|
|------|-----------|----------|------------|
|`query/time`|Milliseconds taken to complete a query.|<p>Common: `dataSource`,
`type`, `interval`, `hasFilters`, `duration`, `context`, `remoteAddress`, `id`,
`statusCode`.</p><p> Aggregation Queries: `numMetrics`,
`numComplexMetrics`.</p><p> GroupBy: `numDimensions`.</p><p> TopN: `threshold`,
`dimension`.</p>|< 1s|
-|`query/segments/count`|Number of segments this Historical scans for a
query.|<p>Common: `dataSource`, `type`, `interval`, `hasFilters`, `duration`,
`context`, `remoteAddress`, `id`.</p><p> Aggregation Queries: `numMetrics`,
`numComplexMetrics`.</p><p> GroupBy: `numDimensions`.</p><p> TopN: `threshold`,
`dimension`.</p>|Varies|
+|`query/segments/count`|This metric is not enabled by default. Number of
segments this Historical scans for a query.|<p>Common: `dataSource`, `type`,
`interval`, `hasFilters`, `duration`, `context`, `remoteAddress`, `id`.</p><p>
Aggregation Queries: `numMetrics`, `numComplexMetrics`.</p><p> GroupBy:
`numDimensions`.</p><p> TopN: `threshold`, `dimension`.</p>|Varies|
|`query/segment/time`|Milliseconds taken to query individual segment. Includes
time to page in the segment from disk.|`id`, `status`, `segment`,
`vectorized`.|several hundred milliseconds|
|`query/wait/time`|Milliseconds spent waiting for a segment to be
scanned.|`id`, `segment`|< several hundred milliseconds|
|`segment/scan/pending`|Number of segments in queue waiting to be
scanned.||Close to 0|
@@ -142,7 +142,7 @@ to represent the task ID are deprecated and will be removed
in a future release.
|Metric|Description|Dimensions|Normal value|
|------|-----------|----------|------------|
|`query/time`|Milliseconds taken to complete a query.|<p>Common: `dataSource`,
`type`, `interval`, `hasFilters`, `duration`, `context`, `remoteAddress`, `id`,
`statusCode`.</p><p> Aggregation Queries: `numMetrics`,
`numComplexMetrics`.</p><p> GroupBy: `numDimensions`.</p><p> TopN: `threshold`,
`dimension`.</p>|< 1s|
-|`query/segments/count`|Number of segments this Peon scans for a
query.|<p>Common: `dataSource`, `type`, `interval`, `hasFilters`, `duration`,
`context`, `remoteAddress`, `id`.</p><p> Aggregation Queries: `numMetrics`,
`numComplexMetrics`.</p><p> GroupBy: `numDimensions`. </p><p>TopN: `threshold`,
`dimension`.</p>|Varies|
+|`query/segments/count`|This metric is not enabled by default. Number of
segments this Peon scans for a query.|<p>Common: `dataSource`, `type`,
`interval`, `hasFilters`, `duration`, `context`, `remoteAddress`, `id`.</p><p>
Aggregation Queries: `numMetrics`, `numComplexMetrics`.</p><p> GroupBy:
`numDimensions`. </p><p>TopN: `threshold`, `dimension`.</p>|Varies|
|`query/wait/time`|Milliseconds spent waiting for a segment to be
scanned.|`id`, `segment`|several hundred milliseconds|
|`segment/scan/pending`|Number of segments in queue waiting to be
scanned.||Close to 0|
|`segment/scan/active`|Number of segments currently scanned. This metric also
indicates how many threads from `druid.processing.numThreads` are currently
being used.||Close to `druid.processing.numThreads`|
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
