[flink-kubernetes-operator] branch main updated: [docs] Add an example about how to enable Prometheus for FlinkDeployment

[gy...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gyfora pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git


The following commit(s) were added to refs/heads/main by this push:
     new cecde2c4 [docs] Add an example about how to enable Prometheus for FlinkDeployment
cecde2c4 is described below

commit cecde2c4254964e843889f5a025f8105e00507bc
Author: Xin Hao <ha...@gmail.com>
AuthorDate: Wed Aug 24 15:40:58 2022 +0800

    [docs] Add an example about how to enable Prometheus for FlinkDeployment
---
 docs/content/docs/operations/metrics-logging.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/content/docs/operations/metrics-logging.md b/docs/content/docs/operations/metrics-logging.md
index 89cfcab0..d9dabeed 100644
--- a/docs/content/docs/operations/metrics-logging.md
+++ b/docs/content/docs/operations/metrics-logging.md
@@ -113,7 +113,7 @@ defaultConfiguration:
     kubernetes.operator.metrics.reporter.prom.class: org.apache.flink.metrics.prometheus.PrometheusReporter
     kubernetes.operator.metrics.reporter.prom.port: 9999
 ```
-Some metric reporters, including the Prometheus, needs a port to be exposed on the container. This can be achieved be defining a value for the otherwise empty `metrics.port` variable.
+Some metric reporters, including the Prometheus, need a port to be exposed on the container. This can be achieved be defining a value for the otherwise empty `metrics.port` variable.
 Either in the `values.yaml` file:
 ```yaml
 metrics:
@@ -194,3 +194,15 @@ spec:
       rootLogger.appenderRef.file.ref = LogFile
       ...
 ```
+
+### FlinkDeployment Prometheus Configuration
+
+The following example shows how to enable the Prometheus metric reporter for the FlinkDeployment:
+
+```yaml
+spec:
+  ...
+  flinkConfiguration:
+    metrics.reporter.prom.class: org.apache.flink.metrics.prometheus.PrometheusReporter
+    metrics.reporter.prom.port: 9249-9250
+```