Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/6184#discussion_r200121810
--- Diff: docs/monitoring/metrics.md ---
@@ -700,6 +700,31 @@ Flink metric types are mapped to Prometheus metric
types as follows:
All Flink metrics variables (see [List of all
Variables](#list-of-all-variables)) are exported to Prometheus as labels.
+### PrometheusPushGateway
(org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporter)
+
+In order to use this reporter you must copy
`/opt/flink-metrics-prometheus-{{site.version}}.jar` into the `/lib` folder
+of your Flink distribution.
+
+Parameters:
+
+- `host` - the PushGateway server host
+- `port` - the PushGateway server port
+- `prefix` - (optional) the prefix is used to compose the jobName,
defaults to `flink`. The jobName is used to distinguish different flink clusters
+
+Example configuration:
+
+{% highlight yaml %}
+
+metrics.reporter.promgateway.class:
org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporter
+metrics.reporter.promgateway.host: localhost
+metrics.reporter.promgateway.port: 9091
+metrics.reporter.promgateway.prefix: flink
+
+{% endhighlight %}
+
+PrometheusPushGatewayReporter push metrics to a
[Pushgateway](https://github.com/prometheus/pushgateway). The Pushgateway then
exposes
+these metrics to Prometheus. The working mechanism is different from
PrometheusReporter (see
[PrometheusReporter](#prometheus-orgapacheflinkmetricsprometheusprometheusreporter)).
--- End diff --
I will remove the second sentence as it provides no value, and instead
introduce a link tot he prometheus documentation for pushgateway use-cases.
---
