You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2021/08/23 21:47:38 UTC
[GitHub] [druid] techdocsmith commented on a change in pull request #11481: Docs - Metrics docs layout and info about query/bytes
techdocsmith commented on a change in pull request #11481:
URL: https://github.com/apache/druid/pull/11481#discussion_r694326119
##########
File path: docs/configuration/index.md
##########
@@ -343,12 +343,15 @@ Coordinator and Overlord log changes to lookups, segment load/drop rules, dynami
### Enabling Metrics
-Druid processes periodically emit metrics and different metrics monitors can be included. Each process can overwrite the default list of monitors.
+Druid processes can be configured to emit [metrics](../operations/metrics.md) regularly from a number of [monitors](#metrics-monitors) via [emitters](#metrics-emitters).
Review comment:
```suggestion
You can configure Druid processes to emit [metrics](../operations/metrics.md) regularly from a number of [monitors](#metrics-monitors) via [emitters](#metrics-emitters).
```
prefer active
##########
File path: docs/configuration/index.md
##########
@@ -343,12 +343,15 @@ Coordinator and Overlord log changes to lookups, segment load/drop rules, dynami
### Enabling Metrics
-Druid processes periodically emit metrics and different metrics monitors can be included. Each process can overwrite the default list of monitors.
+Druid processes can be configured to emit [metrics](../operations/metrics.md) regularly from a number of [monitors](#metrics-monitors) via [emitters](#metrics-emitters).
|Property|Description|Default|
|--------|-----------|-------|
-|`druid.monitoring.emissionPeriod`|How often metrics are emitted.|PT1M|
-|`druid.monitoring.monitors`|Sets list of Druid monitors used by a process. See below for names and more information. For example, you can specify monitors for a Broker with `druid.monitoring.monitors=["org.apache.druid.java.util.metrics.SysMonitor","org.apache.druid.java.util.metrics.JvmMonitor"]`.|none (no monitors)|
+|`druid.monitoring.emissionPeriod`|How often metrics are emitted.|`PT1M`|
Review comment:
```suggestion
|`druid.monitoring.emissionPeriod`| Frequency that Druid emits metrics.|`PT1M`|
```
##########
File path: docs/operations/metrics.md
##########
@@ -49,7 +47,7 @@ Available Metrics
|Metric|Description|Dimensions|Normal Value|
|------|-----------|----------|------------|
|`query/time`|Milliseconds taken to complete a query.|Common: dataSource, type, interval, hasFilters, duration, context, remoteAddress, id. Aggregation Queries: numMetrics, numComplexMetrics. GroupBy: numDimensions. TopN: threshold, dimension.|< 1s|
-|`query/bytes`|number of bytes returned in query response.|Common: dataSource, type, interval, hasFilters, duration, context, remoteAddress, id. Aggregation Queries: numMetrics, numComplexMetrics. GroupBy: numDimensions. TopN: threshold, dimension.| |
+|`query/bytes`|The total number of bytes returned in the query response back to the requesting client by the broker. (Other services report the total bytes for their portion of the query.)|Common: dataSource, type, interval, hasFilters, duration, context, remoteAddress, id. Aggregation Queries: numMetrics, numComplexMetrics. GroupBy: numDimensions. TopN: threshold, dimension.| |
Review comment:
```suggestion
|`query/bytes`|The total number of bytes returned to the requesting client in the query response from the broker. Other services report the total bytes for their portion of the query. |Common: `dataSource`, `type`, `interval`, `hasFilters`, `duration`, `context`, `remoteAddress`, `id`. Aggregation Queries: `numMetrics`, `numComplexMetrics`. GroupBy: `numDimensions`. TopN: `threshold`, `dimension`.| |
```
I'm not sure how we handle this across the docs, but these columns/metrics look like code words, so adding code formatting. Remove if unnecessary.
##########
File path: docs/configuration/index.md
##########
@@ -367,23 +370,31 @@ The following monitors are available:
|`org.apache.druid.server.emitter.HttpEmittingMonitor`|Reports internal metrics of `http` or `parametrized` emitter (see below). Must not be used with another emitter type. See the description of the metrics here: https://github.com/apache/druid/pull/4973.|
|`org.apache.druid.server.metrics.TaskCountStatsMonitor`|Reports how many ingestion tasks are currently running/pending/waiting and also the number of successful/failed tasks per emission period.|
+> Metric monitoring is an essential part of Druid operations. For example, you might configure monitors on all processes for system and JVM information as follows:
+>
+>`druid.monitoring.monitors=["org.apache.druid.java.util.metrics.SysMonitor","org.apache.druid.java.util.metrics.JvmMonitor"]`
-### Emitting Metrics
+> You can overwrite the default list of monitors with the configurations of individual processes.
Review comment:
remove from admonition. Include this as part of the intro.
##########
File path: docs/operations/metrics.md
##########
@@ -37,7 +35,7 @@ All Druid metrics share a common set of fields:
Metrics may have additional dimensions beyond those listed above.
-Most metric values reset each emission period. By default druid emission period is 1 minute, this can be changed by setting the property `druid.monitoring.emissionPeriod`.
+> Most metric values reset each emission period, as specified in [`druid.monitoring.emissionPeriod`](../configuration/index.html#enabling-metrics).
Review comment:
```suggestion
> Most metric values reset each emission period, as specified in `druid.monitoring.emissionPeriod`.
```
We've already linked to enabling metrics. no need to re-link every time.
##########
File path: docs/configuration/index.md
##########
@@ -397,10 +408,9 @@ The Druid servers [emit various metrics](../operations/metrics.md) and alerts vi
|`druid.emitter.http.minHttpTimeoutMillis`|If the speed of filling batches imposes timeout smaller than that, not even trying to send batch to endpoint, because it will likely fail, not being able to send the data that fast. Configure this depending based on emitter/successfulSending/minTimeMs metric. Reasonable values are 10ms..100ms.|0|
|`druid.emitter.http.recipientBaseUrl`|The base URL to emit messages to. Druid will POST JSON to be consumed at the HTTP endpoint specified by this property.|none, required config|
-#### Http Emitter Module TLS Overrides
+##### Http Emitter Module TLS Overrides
-When emitting events to a TLS-enabled receiver, the Http Emitter will by default use an SSLContext obtained via the
-process described at [Druid's internal communication over TLS](../operations/tls-support.md), i.e., the same
+When emitting events to a TLS-enabled receiver, the Http Emitter will by default use an SSLContext obtained via the process described at [Druid's internal communication over TLS](../operations/tls-support.md), i.e., the same
Review comment:
```suggestion
By default, when emitting events to a TLS-enabled receiver, the Http Emitter uses an SSLContext obtained via the process described at [Druid's internal communication over TLS](../operations/tls-support.md), i.e., the same
```
Isn't Http always HTTP?
##########
File path: docs/configuration/index.md
##########
@@ -367,23 +370,31 @@ The following monitors are available:
|`org.apache.druid.server.emitter.HttpEmittingMonitor`|Reports internal metrics of `http` or `parametrized` emitter (see below). Must not be used with another emitter type. See the description of the metrics here: https://github.com/apache/druid/pull/4973.|
|`org.apache.druid.server.metrics.TaskCountStatsMonitor`|Reports how many ingestion tasks are currently running/pending/waiting and also the number of successful/failed tasks per emission period.|
+> Metric monitoring is an essential part of Druid operations. For example, you might configure monitors on all processes for system and JVM information as follows:
Review comment:
Remove from admonition `>` . Make this the introduction to this section before "The following monitors are available". Line 356.
##########
File path: docs/operations/metrics.md
##########
@@ -23,9 +23,7 @@ title: "Metrics"
-->
-Druid generates metrics related to queries, ingestion, and coordination.
-
-Metrics are emitted as JSON objects to a runtime log file or over HTTP (to a service such as Apache Kafka). Metric emission is disabled by default.
+Druid can be [configured](../configuration/index.html#enabling-metrics) to emit metrics that are essential for monitoring query execution, ingestion, coordination, and so on.
Review comment:
```suggestion
You can configure Druid to [emit metrics](../configuration/index.html#enabling-metrics) that are essential for monitoring query execution, ingestion, coordination, and so on.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org