You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tr...@apache.org on 2021/08/25 07:54:15 UTC
[flink] branch release-1.13 updated: [FLINK-23845][docs] Improve
PushGatewayReporter config:deleteOnShutdown description
This is an automated email from the ASF dual-hosted git repository.
trohrmann pushed a commit to branch release-1.13
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/release-1.13 by this push:
new fbc78c8 [FLINK-23845][docs] Improve PushGatewayReporter config:deleteOnShutdown description
fbc78c8 is described below
commit fbc78c8eb1f5fa781363d70ff549920e2f48c238
Author: camile.sing <ca...@gmail.com>
AuthorDate: Sat Aug 14 16:04:13 2021 +0800
[FLINK-23845][docs] Improve PushGatewayReporter config:deleteOnShutdown description
This closes #16823.
---
.../prometheus_push_gateway_reporter_configuration.html | 2 +-
.../metrics/prometheus/PrometheusPushGatewayReporterOptions.java | 9 ++++++++-
2 files changed, 9 insertions(+), 2 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration.html b/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration.html
index 5351480..ac53e5e 100644
--- a/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration.html
+++ b/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration.html
@@ -12,7 +12,7 @@
<td><h5>deleteOnShutdown</h5></td>
<td style="word-wrap: break-word;">true</td>
<td>Boolean</td>
- <td>Specifies whether to delete metrics from the PushGateway on shutdown.</td>
+ <td>Specifies whether to delete metrics from the PushGateway on shutdown. Flink will try its best to delete the metrics but this is not guaranteed. See <a href="https://issues.apache.org/jira/browse/FLINK-13787">here</a> for more details.</td>
</tr>
<tr>
<td><h5>filterLabelValueCharacters</h5></td>
diff --git a/flink-metrics/flink-metrics-prometheus/src/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java b/flink-metrics/flink-metrics-prometheus/src/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java
index c73301a..4033eb3 100644
--- a/flink-metrics/flink-metrics-prometheus/src/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java
+++ b/flink-metrics/flink-metrics-prometheus/src/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java
@@ -54,7 +54,14 @@ public class PrometheusPushGatewayReporterOptions {
ConfigOptions.key("deleteOnShutdown")
.defaultValue(true)
.withDescription(
- "Specifies whether to delete metrics from the PushGateway on shutdown.");
+ Description.builder()
+ .text(
+ "Specifies whether to delete metrics from the PushGateway on shutdown."
+ + " Flink will try its best to delete the metrics but this is not guaranteed. See %s for more details.",
+ LinkElement.link(
+ "https://issues.apache.org/jira/browse/FLINK-13787",
+ "here"))
+ .build());
public static final ConfigOption<Boolean> FILTER_LABEL_VALUE_CHARACTER =
ConfigOptions.key("filterLabelValueCharacters")