This is an automated email from the ASF dual-hosted git repository.
leesf 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 8cb5617 [DOC] Add document for the use of metrics system in Hudi.
(#1769)
8cb5617 is described below
commit 8cb5617d16a46ecae4432c520d7a5fe78fd71b2a
Author: Shen Hong <shenh062...@126.com>
AuthorDate: Thu Jul 23 13:19:35 2020 +0800
[DOC] Add document for the use of metrics system in Hudi. (#1769)
---
docs/_data/navigation.yml | 2 +
docs/_docs/2_6_deployment.md | 18 -----
docs/_docs/2_8_metrics.md | 108 +++++++++++++++++++++++++++
docs/assets/images/hudi_graphite_metrics.png | Bin 0 -> 165146 bytes
docs/assets/images/hudi_jxm_metrics.png | Bin 0 -> 243761 bytes
5 files changed, 110 insertions(+), 18 deletions(-)
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml
index 08ff527..0f8888f 100644
--- a/docs/_data/navigation.yml
+++ b/docs/_data/navigation.yml
@@ -42,6 +42,8 @@ docs:
url: /docs/deployment.html
- title: "Cloud Storage"
url: /docs/cloud.html
+ - title: "Metrics"
+ url: /docs/metrics.html
- title: INFO
children:
- title: "Docs Versions"
diff --git a/docs/_docs/2_6_deployment.md b/docs/_docs/2_6_deployment.md
index cb06d75..df54add 100644
--- a/docs/_docs/2_6_deployment.md
+++ b/docs/_docs/2_6_deployment.md
@@ -527,24 +527,6 @@ Compaction successfully repaired
.....
```
-
-## [Metrics](docs/configurations.html#metrics-configs) {#metrics}
-
-Once the Hudi writer is configured with the right table and environment for
metrics, it produces the following graphite metrics, that aid in debugging hudi
tables
-
- - **Commit Duration** - This is amount of time it took to successfully commit
a batch of records
- - **Rollback Duration** - Similarly, amount of time taken to undo partial
data left over by a failed commit (happens everytime automatically after a
failing write)
- - **File Level metrics** - Shows the amount of new files added, versions,
deleted (cleaned) in each commit
- - **Record Level Metrics** - Total records inserted/updated etc per commit
- - **Partition Level metrics** - number of partitions upserted (super useful
to understand sudden spikes in commit duration)
-
-These metrics can then be plotted on a standard tool like grafana. Below is a
sample commit duration chart.
-
-<figure>
- <img class="docimage" src="/assets/images/hudi_commit_duration.png"
alt="hudi_commit_duration.png" style="max-width: 100%" />
-</figure>
-
-
## Troubleshooting
Section below generally aids in debugging Hudi failures. Off the bat, the
following metadata is added to every record to help triage issues easily using
standard Hadoop SQL engines (Hive/Presto/Spark)
diff --git a/docs/_docs/2_8_metrics.md b/docs/_docs/2_8_metrics.md
new file mode 100644
index 0000000..e5043af
--- /dev/null
+++ b/docs/_docs/2_8_metrics.md
@@ -0,0 +1,108 @@
+---
+title: HoodieMetrics Guide
+keywords: hudi, administration, operation, devops, metrics
+permalink: /docs/metrics.html
+summary: This section offers an overview of metrics in Hudi
+toc: true
+last_modified_at: 2020-06-20T15:59:57-04:00
+---
+
+In this section, we will introduce the `MetricsReporter` and `HoodieMetrics`
in Hudi. You can view the metrics-related configurations
[here](configurations.html#metrics-configs).
+
+## MetricsReporter
+
+MetricsReporter provides APIs for reporting `HoodieMetrics` to user-specified
backends. Currently, the implementations include InMemoryMetricsReporter,
JmxMetricsReporter, MetricsGraphiteReporter and DatadogMetricsReporter. Since
InMemoryMetricsReporter is only used for testing, we will introduce the other
three implementations.
+
+### JmxMetricsReporter
+
+JmxMetricsReporter is an implementation of JMX reporter, which used to report
JMX metrics.
+
+#### Configurations
+The following is an example of `JmxMetricsReporter`. More detaile
configurations can be referenced [here](configurations.html#jmx).
+
+ ```properties
+ hoodie.metrics.on=true
+ hoodie.metrics.reporter.type=JMX
+ hoodie.metrics.jmx.host=192.168.0.106
+ hoodie.metrics.jmx.port=4001
+ ```
+
+#### Demo
+As configured above, JmxMetricsReporter will started JMX server on port 4001.
We can start a jconsole to connect to 192.168.0.106:4001. Below is an
illustration of monitoring Hudi JMX metrics through jconsole.
+<figure>
+ <img class="docimage" src="/assets/images/hudi_jxm_metrics.png"
alt="hudi_jxm_metrics.png" style="max-width: 100%" />
+</figure>
+
+### MetricsGraphiteReporter
+
+MetricsGraphiteReporter is an implementation of Graphite reporter, which
connects to a Graphite server, and send `HoodieMetrics` to it.
+
+#### Configurations
+The following is an example of `MetricsGraphiteReporter`. More detaile
configurations can be referenced [here](configurations.html#graphite).
+
+ ```properties
+ hoodie.metrics.on=true
+ hoodie.metrics.reporter.type=GRAPHITE
+ hoodie.metrics.graphite.host=192.168.0.106
+ hoodie.metrics.graphite.port=2003
+ hoodie.metrics.graphite.metric.prefix=<your metrics prefix>
+ ```
+#### Demo
+As configured above, assuming a Graphite server is running on host
192.168.0.106 and port 2003, a running Hudi job will connect and report metrics
data to it. Below is an illustration of monitoring hudi metrics through
Graphite.
+ <figure>
+ <img class="docimage" src="/assets/images/hudi_graphite_metrics.png"
alt="hudi_graphite_metrics.png" style="max-width: 100%" />
+ </figure>
+
+### DatadogMetricsReporter
+
+DatadogMetricsReporter is an implementation of Datadog reporter.
+A reporter which publishes metric values to Datadog monitoring service via
Datadog HTTP API.
+
+#### Configurations
+The following is an example of `DatadogMetricsReporter`. More detailed
configurations can be referenced [here](configurations.html#datadog).
+
+```properties
+hoodie.metrics.on=true
+hoodie.metrics.reporter.type=DATADOG
+hoodie.metrics.datadog.api.site=EU # or US
+hoodie.metrics.datadog.api.key=<your api key>
+hoodie.metrics.datadog.metric.prefix=<your metrics prefix>
+```
+
+ * `hoodie.metrics.datadog.api.site` will set the Datadog API site, which
determines whether the requests will be sent to api.datadoghq.eu (EU) or
api.datadoghq.com (US). Set this according to your Datadog account settings.
+ * `hoodie.metrics.datadog.api.key` will set the api key.
+ * `hoodie.metrics.datadog.metric.prefix` will help segregate metrics by
setting different prefixes for different jobs. Note that it will use `.` to
delimit the prefix and the metric name. For example, if the prefix is set to
`foo`, then `foo.` will be prepended to the metric name.
+
+#### Demo
+In this demo, we ran a `HoodieDeltaStreamer` job with `HoodieMetrics` turned
on and other configurations set properly.
+
+<figure>
+ <img class="docimage"
src="/assets/images/blog/2020-05-28-datadog-metrics-demo.png"
alt="hudi_datadog_metrics.png" style="max-width: 100%" />
+</figure>
+
+ As shown above, we were able to collect Hudi's action-related metrics like
+
+ * `<prefix>.<table name>.commit.totalScanTime`
+ * `<prefix>.<table name>.clean.duration`
+ * `<prefix>.<table name>.index.lookup.duration`
+
+ as well as `HoodieDeltaStreamer`-specific metrics
+
+ * `<prefix>.<table name>.deltastreamer.duration`
+ * `<prefix>.<table name>.deltastreamer.hiveSyncDuration`
+
+## HoodieMetrics
+
+Once the Hudi writer is configured with the right table and environment for
`HoodieMetrics`, it produces the following `HoodieMetrics`, that aid in
debugging hudi tables
+
+ - **Commit Duration** - The amount of time it took to successfully commit a
batch of records
+ - **Rollback Duration** - Similarly, the amount of time taken to undo partial
data left over by a failed commit (rollback happens automatically after a
failing write)
+ - **File Level metrics** - Shows the amount of new files added, versions,
deleted (cleaned) in each commit
+ - **Record Level Metrics** - Total records inserted/updated etc per commit
+ - **Partition Level metrics** - number of partitions upserted (super useful
to understand sudden spikes in commit duration)
+
+These `HoodieMetrics` can then be plotted on a standard tool like grafana.
Below is a sample commit duration chart.
+
+<figure>
+ <img class="docimage" src="/assets/images/hudi_commit_duration.png"
alt="hudi_commit_duration.png" style="max-width: 100%" />
+</figure>
diff --git a/docs/assets/images/hudi_graphite_metrics.png
b/docs/assets/images/hudi_graphite_metrics.png
new file mode 100644
index 0000000..7617a87
Binary files /dev/null and b/docs/assets/images/hudi_graphite_metrics.png differ
diff --git a/docs/assets/images/hudi_jxm_metrics.png
b/docs/assets/images/hudi_jxm_metrics.png
new file mode 100644
index 0000000..67c2718
Binary files /dev/null and b/docs/assets/images/hudi_jxm_metrics.png differ
