Skip to content

Commit 18f176c

Browse files
camilesingtillrohrmann
authored andcommitted
[FLINK-23845][docs] Improve PushGatewayReporter config:deleteOnShutdown description
This closes apache#16823.
1 parent b09978b commit 18f176c

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<td><h5>deleteOnShutdown</h5></td>
1313
<td style="word-wrap: break-word;">true</td>
1414
<td>Boolean</td>
15-
<td>Specifies whether to delete metrics from the PushGateway on shutdown.</td>
15+
<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>
1616
</tr>
1717
<tr>
1818
<td><h5>filterLabelValueCharacters</h5></td>

flink-metrics/flink-metrics-prometheus/src/main/java/org/apache/flink/metrics/prometheus/PrometheusPushGatewayReporterOptions.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,14 @@ public class PrometheusPushGatewayReporterOptions {
5454
ConfigOptions.key("deleteOnShutdown")
5555
.defaultValue(true)
5656
.withDescription(
57-
"Specifies whether to delete metrics from the PushGateway on shutdown.");
57+
Description.builder()
58+
.text(
59+
"Specifies whether to delete metrics from the PushGateway on shutdown."
60+
+ " Flink will try its best to delete the metrics but this is not guaranteed. See %s for more details.",
61+
LinkElement.link(
62+
"https://issues.apache.org/jira/browse/FLINK-13787",
63+
"here"))
64+
.build());
5865

5966
public static final ConfigOption<Boolean> FILTER_LABEL_VALUE_CHARACTER =
6067
ConfigOptions.key("filterLabelValueCharacters")

0 commit comments

Comments
 (0)