[GitHub] [hudi] kywe665 commented on a change in pull request #4098: [HUDI-2727] - Docs for Prometheus metrics reporter

[GitBox <gi...@apache.org>]

kywe665 commented on a change in pull request #4098:
URL: https://github.com/apache/hudi/pull/4098#discussion_r756475709



##########
File path: website/docs/metrics.md
##########
@@ -89,7 +89,41 @@ In this demo, we ran a `HoodieDeltaStreamer` job with `HoodieMetrics` turned on
 
  * `<prefix>.<table name>.deltastreamer.duration`
  * `<prefix>.<table name>.deltastreamer.hiveSyncDuration`
- 
+
+### PrometheusMetricsReporter
+[Prometheus](https://prometheus.io/) is an open source systems monitoring and alerting toolkit.
+Prometheus has a [PushGateway](https://prometheus.io/docs/practices/pushing/) that Apache Hudi can leverage for metrics reporting.
+Follow [Prometheus documentation](https://prometheus.io/docs/introduction/first_steps/) for basic setup instructions.
+
+Similar to other supported reporters, the following attributes are required to enable pushgateway reporters:
+
+```scala
+hoodie.metrics.on=true
+hoodie.metrics.reporter.type=PROMETHEUS_PUSHGATEWAY
+```
+
+The following properties are used to configure the address and port number of pushgateway. The default address is
+localhost, and the default port is 9091
+
+```scala
+hoodie.metrics.pushgateway.host=xxxx
+hoodie.metrics.pushgateway.port=9091
+```
+
+You can configure whether to delete the monitoring information from pushgateway at the end of the task, the default is true
+
+```scala
+hoodie.metrics.pushgateway.job.name=xiaomm

Review comment:
       good catch, fixed

##########
File path: website/docs/metrics.md
##########
@@ -89,7 +89,41 @@ In this demo, we ran a `HoodieDeltaStreamer` job with `HoodieMetrics` turned on
 
  * `<prefix>.<table name>.deltastreamer.duration`
  * `<prefix>.<table name>.deltastreamer.hiveSyncDuration`
- 
+
+### PrometheusMetricsReporter
+[Prometheus](https://prometheus.io/) is an open source systems monitoring and alerting toolkit.
+Prometheus has a [PushGateway](https://prometheus.io/docs/practices/pushing/) that Apache Hudi can leverage for metrics reporting.
+Follow [Prometheus documentation](https://prometheus.io/docs/introduction/first_steps/) for basic setup instructions.
+
+Similar to other supported reporters, the following attributes are required to enable pushgateway reporters:
+
+```scala
+hoodie.metrics.on=true
+hoodie.metrics.reporter.type=PROMETHEUS_PUSHGATEWAY
+```
+
+The following properties are used to configure the address and port number of pushgateway. The default address is
+localhost, and the default port is 9091
+
+```scala
+hoodie.metrics.pushgateway.host=xxxx
+hoodie.metrics.pushgateway.port=9091
+```
+
+You can configure whether to delete the monitoring information from pushgateway at the end of the task, the default is true
+
+```scala
+hoodie.metrics.pushgateway.job.name=xiaomm
+hoodie.metrics.pushgateway.random.job.name.suffix=false
+```
+
+You can configure the task name prefix and whether a random suffix is required. The default is true
+
+```scala
+hoodie.metrics.pushgateway.job.name=xiaomm

Review comment:
       fixed




-- 
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: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org