You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by vi...@apache.org on 2020/05/28 07:40:38 UTC
[hudi] branch asf-site updated: [HUDI-836] Add configs for Datadog
metrics reporter (#1603)
This is an automated email from the ASF dual-hosted git repository.
vinoyang 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 6755231 [HUDI-836] Add configs for Datadog metrics reporter (#1603)
6755231 is described below
commit 67552318fc4eda528c85aaa84131b1abf6d461ef
Author: Raymond Xu <27...@users.noreply.github.com>
AuthorDate: Thu May 28 00:40:27 2020 -0700
[HUDI-836] Add configs for Datadog metrics reporter (#1603)
---
docs/_docs/2_4_configurations.cn.md | 58 +++++++++++++++++++++++++++++-----
docs/_docs/2_4_configurations.md | 62 +++++++++++++++++++++++++++++++------
2 files changed, 102 insertions(+), 18 deletions(-)
diff --git a/docs/_docs/2_4_configurations.cn.md b/docs/_docs/2_4_configurations.cn.md
index a61ba9a..44108ae 100644
--- a/docs/_docs/2_4_configurations.cn.md
+++ b/docs/_docs/2_4_configurations.cn.md
@@ -443,9 +443,9 @@ Hudi提供了一个选项，可以通过将对该分区中的插入作为对现
#### GRAPHITE
-##### on(metricsOn = true) {#on}
+##### on(metricsOn = false) {#on}
属性：`hoodie.metrics.on` <br/>
-<span style="color:grey">打开或关闭发送指标。默认情况下处于启用状态。</span>
+<span style="color:grey">打开或关闭发送指标。默认情况下处于关闭状态。</span>
##### withReporterType(reporterType = GRAPHITE) {#withReporterType}
属性：`hoodie.metrics.reporter.type` <br/>
@@ -465,9 +465,9 @@ Hudi提供了一个选项，可以通过将对该分区中的插入作为对现
#### JMX
-##### on(metricsOn = true) {#on}
+##### on(metricsOn = false) {#on}
属性：`hoodie.metrics.on` <br/>
-<span style="color:grey">打开或关闭发送指标。默认情况下处于启用状态。</span>
+<span style="color:grey">打开或关闭发送指标。默认情况下处于关闭状态。</span>
##### withReporterType(reporterType = JMX) {#withReporterType}
属性：`hoodie.metrics.reporter.type` <br/>
@@ -481,10 +481,52 @@ Hudi提供了一个选项，可以通过将对该分区中的插入作为对现
属性：`hoodie.metrics.graphite.port` <br/>
<span style="color:grey">要连接的Jmx端口</span>
-##### usePrefix(prefix = "") {#usePrefix}
-属性：`hoodie.metrics.jmx.metric.prefix` <br/>
-<span style="color:grey">适用于所有指标的标准前缀。这有助于添加如数据中心、环境等信息</span>
-
+#### DATADOG
+
+##### on(metricsOn = false) {#on}
+属性：`hoodie.metrics.on` <br/>
+<span style="color:grey">打开或关闭发送指标。默认情况下处于关闭状态。</span>
+
+##### withReporterType(reporterType = DATADOG) {#withReporterType}
+属性： `hoodie.metrics.reporter.type` <br/>
+<span style="color:grey">指标报告者的类型。</span>
+
+##### withDatadogReportPeriodSeconds(period = 30) {#withDatadogReportPeriodSeconds}
+属性： `hoodie.metrics.datadog.report.period.seconds` <br/>
+<span style="color:grey">Datadog报告周期，单位为秒，默认30秒。</span>
+
+##### withDatadogApiSite(apiSite) {#withDatadogApiSite}
+属性： `hoodie.metrics.datadog.api.site` <br/>
+<span style="color:grey">Datadog API站点：EU 或者 US</span>
+
+##### withDatadogApiKey(apiKey) {#withDatadogApiKey}
+属性： `hoodie.metrics.datadog.api.key` <br/>
+<span style="color:grey">Datadog API密匙</span>
+
+##### withDatadogApiKeySkipValidation(skip = false) {#withDatadogApiKeySkipValidation}
+属性： `hoodie.metrics.datadog.api.key.skip.validation` <br/>
+<span style="color:grey">在通过Datadog API发送指标前，选择是否跳过验证API密匙。默认不跳过。</span>
+
+##### withDatadogApiKeySupplier(apiKeySupplier) {#withDatadogApiKeySupplier}
+属性： `hoodie.metrics.datadog.api.key.supplier` <br/>
+<span style="color:grey">Datadog API 密匙提供者，用来在运行时提供密匙。只有当`hoodie.metrics.datadog.api.key`未设定的情况下才有效。</span>
+
+##### withDatadogApiTimeoutSeconds(timeout = 3) {#withDatadogApiTimeoutSeconds}
+属性： `hoodie.metrics.datadog.metric.prefix` <br/>
+<span style="color:grey">Datadog API超时时长，单位为秒，默认3秒。</span>
+
+##### withDatadogPrefix(prefix) {#withDatadogPrefix}
+属性： `hoodie.metrics.datadog.metric.prefix` <br/>
+<span style="color:grey">Datadog指标前缀。将被加在所有指标名称前，以点间隔。例如：如果设成`foo`，`foo.`将被用作实际前缀。</span>
+
+##### withDatadogHost(host) {#withDatadogHost}
+属性： `hoodie.metrics.datadog.metric.host` <br/>
+<span style="color:grey">Datadog指标主机，将和指标数据一并发送。</span>
+
+##### withDatadogTags(tags) {#withDatadogTags}
+属性： `hoodie.metrics.datadog.metric.tags` <br/>
+<span style="color:grey">Datadog指标标签（逗号分隔），将和指标数据一并发送。</span>
+
### 内存配置
控制由Hudi内部执行的压缩和合并的内存使用情况
[withMemoryConfig](#withMemoryConfig) (HoodieMemoryConfig) <br/>
diff --git a/docs/_docs/2_4_configurations.md b/docs/_docs/2_4_configurations.md
index b7ff7d1..f67fbbb 100644
--- a/docs/_docs/2_4_configurations.md
+++ b/docs/_docs/2_4_configurations.md
@@ -400,17 +400,17 @@ Property: `hoodie.compaction.daybased.target` <br/>
Property: `hoodie.compaction.payload.class` <br/>
<span style="color:grey">This needs to be same as class used during insert/upserts. Just like writing, compaction also uses the record payload class to merge records in the log against each other, merge again with the base file and produce the final record to be written after compaction.</span>
-
### Metrics configs
+
Enables reporting on Hudi metrics.
[withMetricsConfig](#withMetricsConfig) (HoodieMetricsConfig) <br/>
-<span style="color:grey">Hudi publishes metrics on every commit, clean, rollback etc.The following sections list the supported reporters.</span>
+<span style="color:grey">Hudi publishes metrics on every commit, clean, rollback etc. The following sections list the supported reporters.</span>
#### GRAPHITE
-##### on(metricsOn = true) {#on}
+##### on(metricsOn = false) {#on}
`hoodie.metrics.on` <br/>
-<span style="color:grey">Turn sending metrics on/off. on by default.</span>
+<span style="color:grey">Turn on/off metrics reporting. off by default.</span>
##### withReporterType(reporterType = GRAPHITE) {#withReporterType}
Property: `hoodie.metrics.reporter.type` <br/>
@@ -430,9 +430,9 @@ Property: `hoodie.metrics.graphite.metric.prefix` <br/>
#### JMX
-##### on(metricsOn = true) {#on}
+##### on(metricsOn = false) {#on}
`hoodie.metrics.on` <br/>
-<span style="color:grey">Turn sending metrics on/off. on by default.</span>
+<span style="color:grey">Turn on/off metrics reporting. off by default.</span>
##### withReporterType(reporterType = JMX) {#withReporterType}
Property: `hoodie.metrics.reporter.type` <br/>
@@ -446,10 +446,52 @@ Property: `hoodie.metrics.jmx.host` <br/>
Property: `hoodie.metrics.jmx.port` <br/>
<span style="color:grey">Jmx port to connect to</span>
-##### usePrefix(prefix = "") {#usePrefix}
-Property: `hoodie.metrics.jmx.metric.prefix` <br/>
-<span style="color:grey">Standard prefix applied to all metrics. This helps to add datacenter, environment information for e.g</span>
-
+#### DATADOG
+
+##### on(metricsOn = false) {#on}
+`hoodie.metrics.on` <br/>
+<span style="color:grey">Turn on/off metrics reporting. off by default.</span>
+
+##### withReporterType(reporterType = DATADOG) {#withReporterType}
+Property: `hoodie.metrics.reporter.type` <br/>
+<span style="color:grey">Type of metrics reporter.</span>
+
+##### withDatadogReportPeriodSeconds(period = 30) {#withDatadogReportPeriodSeconds}
+Property: `hoodie.metrics.datadog.report.period.seconds` <br/>
+<span style="color:grey">Datadog report period in seconds. Default to 30.</span>
+
+##### withDatadogApiSite(apiSite) {#withDatadogApiSite}
+Property: `hoodie.metrics.datadog.api.site` <br/>
+<span style="color:grey">Datadog API site: EU or US</span>
+
+##### withDatadogApiKey(apiKey) {#withDatadogApiKey}
+Property: `hoodie.metrics.datadog.api.key` <br/>
+<span style="color:grey">Datadog API key</span>
+
+##### withDatadogApiKeySkipValidation(skip = false) {#withDatadogApiKeySkipValidation}
+Property: `hoodie.metrics.datadog.api.key.skip.validation` <br/>
+<span style="color:grey">Before sending metrics via Datadog API, whether to skip validating Datadog API key or not. Default to false.</span>
+
+##### withDatadogApiKeySupplier(apiKeySupplier) {#withDatadogApiKeySupplier}
+Property: `hoodie.metrics.datadog.api.key.supplier` <br/>
+<span style="color:grey">Datadog API key supplier to supply the API key at runtime. This will take effect if `hoodie.metrics.datadog.api.key` is not set.</span>
+
+##### withDatadogApiTimeoutSeconds(timeout = 3) {#withDatadogApiTimeoutSeconds}
+Property: `hoodie.metrics.datadog.metric.prefix` <br/>
+<span style="color:grey">Datadog API timeout in seconds. Default to 3.</span>
+
+##### withDatadogPrefix(prefix) {#withDatadogPrefix}
+Property: `hoodie.metrics.datadog.metric.prefix` <br/>
+<span style="color:grey">Datadog metric prefix to be prepended to each metric name with a dot as delimiter. For example, if it is set to `foo`, `foo.` will be prepended.</span>
+
+##### withDatadogHost(host) {#withDatadogHost}
+Property: `hoodie.metrics.datadog.metric.host` <br/>
+<span style="color:grey">Datadog metric host to be sent along with metrics data.</span>
+
+##### withDatadogTags(tags) {#withDatadogTags}
+Property: `hoodie.metrics.datadog.metric.tags` <br/>
+<span style="color:grey">Datadog metric tags (comma-delimited) to be sent along with metrics data.</span>
+
### Memory configs
Controls memory usage for compaction and merges, performed internally by Hudi
[withMemoryConfig](#withMemoryConfig) (HoodieMemoryConfig) <br/>