techdocsmith commented on code in PR #15613:
URL: https://github.com/apache/druid/pull/15613#discussion_r1439898440
##########
docs/development/extensions-contrib/prometheus.md:
##########
@@ -47,7 +47,7 @@ All the configuration parameters for the Prometheus emitter
are under `druid.emi
| `druid.emitter.prometheus.flushPeriod` | Emit metrics to Pushgateway
every `flushPeriod` seconds. Required if `pushgateway` strategy is used.
| no | 15
|
| `druid.emitter.prometheus.extraLabels` | JSON key-value pairs for
additional labels on all metrics. Keys (label names) must match the regex
`[a-zA-Z_:][a-zA-Z0-9_:]*`. Example: `{"cluster_name": "druid_cluster1", "env":
"staging"}`. | no | none
|
| `druid.emitter.prometheus.deletePushGatewayMetricsOnShutdown` | Flag to
delete metrics from Pushgateway on task shutdown. Works only if `pushgateway`
strategy is used. This feature allows to delete a stale metrics from batch
executed tasks. Otherwise, the Pushgateway will store these stale metrics
indefinitely as there is [no time to live
mechanism](https://github.com/prometheus/pushgateway/issues/117), using the
memory to hold data that was already scraped by Prometheus. | no | false |
-| `druid.emitter.prometheus.waitForShutdownDelay` | Time in milliseconds to
wait for peon tasks to delete metrics from the Pushgateway on shutdown (e.g.
60_000). Applicable only when `pushgateway` strategy is used and
`pushGatewayDeleteOnShutdown` is set to true. Be aware that there's no
guarantee that a peon task will delete metrics from the gateway if the
configured delay is more than the [Peon's
`druid.indexer.task.gracefulShutdownTimeout`](https://druid.apache.org/docs/latest/configuration/#additional-peon-configuration).
It is recommended that this value is 1.2 times the configured Prometheus
`scrape_interval` of Pushgateway. This ensures, that the metrics should be
scraped before the cleanup. | no | none |
+| `druid.emitter.prometheus.waitForShutdownDelay` | Time in milliseconds to
wait for peon tasks to delete metrics from the Pushgateway on shutdown (e.g.
60_000). Applicable only when `pushgateway` strategy is used and
`deletePushGatewayMetricsOnShutdown` is set to true. Be aware that there's no
guarantee that a peon task will delete metrics from the gateway if the
configured delay is more than the [Peon's
`druid.indexer.task.gracefulShutdownTimeout`](https://druid.apache.org/docs/latest/configuration/#additional-peon-configuration).
It is recommended that this value is 1.2 times the configured Prometheus
`scrape_interval` of Pushgateway. This ensures that the metrics would be
scraped before the cleanup. | no | none |
Review Comment:
```suggestion
| `druid.emitter.prometheus.waitForShutdownDelay` | Time in milliseconds to
wait for peon tasks to delete metrics from the Pushgateway on shutdown (e.g.
60_000). Applicable only when `pushgateway` strategy is used and
`deletePushGatewayMetricsOnShutdown` is set to true. There is no guarantee that
a peon task will delete metrics from the gateway if the configured delay is
more than the [Peon's
`druid.indexer.task.gracefulShutdownTimeout`](https://druid.apache.org/docs/latest/configuration/#additional-peon-configuration)
value. For best results, set this value is 1.2 times the configured Prometheus
`scrape_interval` of Pushgateway to ensure that Druid scrapes the metrics
before cleanup. | no | none |
```
Style suggestions
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
