This is an automated email from the ASF dual-hosted git repository. bhavanisudha pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/hudi.git
The following commit(s) were added to refs/heads/asf-site by this push: new 05f7aa0 [HUDI-2727] - Docs for Prometheus metrics reporter (#4098) 05f7aa0 is described below commit 05f7aa035c7f0e18e1a31711142fc3c686d0078c Author: Kyle Weller <kywe...@gmail.com> AuthorDate: Wed Nov 24 20:56:19 2021 -0700 [HUDI-2727] - Docs for Prometheus metrics reporter (#4098) * added prometheus metrics reporter docs * updated code samples --- website/docs/metrics.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/website/docs/metrics.md b/website/docs/metrics.md index 8a4766a..0b46442 100644 --- a/website/docs/metrics.md +++ b/website/docs/metrics.md @@ -89,7 +89,40 @@ 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.delete.on.shutdown=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=xxxx +hoodie.metrics.pushgateway.random.job.name.suffix=false +``` + ### UserDefinedMetricsReporter Allows users to define a custom metrics reporter.