This is an automated email from the ASF dual-hosted git repository. gaoyunhaii pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push: new 5176669bc0e [FLINK-25705][docs]Translate "Metric Reporters" page of "Deployment" in to Chinese. 5176669bc0e is described below commit 5176669bc0ee678f21934f239d2b34a59102b1b8 Author: Chengkai Yang <yangchengkai2...@163.com> AuthorDate: Fri Apr 15 19:47:45 2022 +0800 [FLINK-25705][docs]Translate "Metric Reporters" page of "Deployment" in to Chinese. This fixes #19496. Co-authored-by: Roc Marshal <flin...@126.com> --- .../content.zh/docs/deployment/metric_reporters.md | 207 +++++++++++---------- .../influxdb_reporter_configuration_zh.html | 72 +++++++ .../generated/metric_reporters_section_zh.html | 60 ++++++ ...eus_push_gateway_reporter_configuration_zh.html | 48 +++++ 4 files changed, 292 insertions(+), 95 deletions(-) diff --git a/docs/content.zh/docs/deployment/metric_reporters.md b/docs/content.zh/docs/deployment/metric_reporters.md index 87d6605f8f5..36eba808a7f 100644 --- a/docs/content.zh/docs/deployment/metric_reporters.md +++ b/docs/content.zh/docs/deployment/metric_reporters.md @@ -24,22 +24,24 @@ specific language governing permissions and limitations under the License. --> +<a name="metric-reporters"></a> + # Metric Reporters -Flink allows reporting metrics to external systems. -For more information about Flink's metric system go to the [metric system documentation]({{< ref "docs/ops/metrics" >}}). +Flink 支持用户将 Flink 的各项运行时指标发送给外部系统。 +了解更多指标方面信息可查看 [metric 系统相关文档]({{< ref "docs/ops/metrics" >}})。 -Metrics can be exposed to an external system by configuring one or several reporters in `conf/flink-conf.yaml`. These -reporters will be instantiated on each job and task manager when they are started. +你可以通过 `conf/flink-conf.yaml` 文件来配置一种或多种发送器,将运行时指标暴露给外部系统。 +发送器会在 TaskManager、Flink 作业启动时进行实例化。 -Below is a list of parameters that are generally applicable to all reporters. All properties are configured by setting `metrics.reporter.<reporter_name>.<property>` in the configuration. Reporters may additionally offer implementation-specific parameters, which are documented in the respective reporter's section. +下面列出了所有发送器都适用的参数,可以通过配置文件中的 `metrics.reporter.<reporter_name>.<property>` 项进行配置。有些发送器有自己特有的配置,详见该发送器章节下的具体说明。 -{{< include_reporter_config "layouts/shortcodes/generated/metric_reporters_section.html" >}} +{{< include_reporter_config "layouts/shortcodes/generated/metric_reporters_section_zh.html" >}} -All reporter configurations must contain the `factory.class` property. -Some reporters (referred to as `Scheduled`) allow specifying a reporting `interval`. +每种发送器的配置需要有 `factory.class` 属性。 +有些基于定时调度的发送器还可以通过 `interval` 来配置发送间隔。 -Example reporter configuration that specifies multiple reporters: +想要同时配置多个发送器,可参考以下示例。 ```yaml metrics.reporters: my_jmx_reporter,my_other_reporter @@ -54,80 +56,85 @@ metrics.reporter.my_other_reporter.host: 192.168.1.1 metrics.reporter.my_other_reporter.port: 10000 ``` -**Important:** The jar containing the reporter must be accessible when Flink is started. - Reporters are loaded as [plugins]({{< ref "docs/deployment/filesystems/plugins" >}}). - All reporters documented on this page are available by default. +**注意**:Flink 在启动时必须能访问到发送器所属的 jar 包,发送器会被加载为 [plugins]({{< ref "docs/deployment/filesystems/plugins" >}}),Flink 自带的发送器(文档中已经列出的发送器)无需做其他配置,开箱即用。 + +你可以实现 `org.apache.flink.metrics.reporter.MetricReporter` 接口来自定义发送器,并实现 `Scheduled` 接口让发送器周期性地将运行时指标发送出去。 +另外也可以实现 `MetricReporterFactory` 接口,让发送器作为插件被 Flink 导入。 + +<a name="identifiers-vs-tags"></a> -You can write your own `Reporter` by implementing the `org.apache.flink.metrics.reporter.MetricReporter` interface. -If the Reporter should send out reports regularly you have to implement the `Scheduled` interface as well. -By additionally implementing a `MetricReporterFactory` your reporter can also be loaded as a plugin. +## 基于标志符格式 vs. 基于 tags 格式 -## Identifiers vs. tags +发送器发送运行指标时有以下两种格式: -There are generally 2 formats for how reporters export metrics. +第一种是基于标志符的格式,这种格式将指标所属的详细范围信息与该指标名称连在一起,组成一个长字符串标志符。 +比如 `job.MyJobName.numRestarts` 就是这样的格式。 -Identifier-based reporters assemble a flat string containing all scope information and the metric name. -An example could be `job.MyJobName.numRestarts`. +第二种是基于 tags 的格式,这种格式由指标的逻辑范围和该指标名称组成,代表某一类通用的指标,比如 `job.numRestarts`。 +这类格式描述的特定指标实例会以“键值对”的方式体现出来,即所谓的标签或变量,比如 "jobName=MyJobName"。 -Tag-based reporters on the other hand define a generic class of metrics consisting of a logical scope and metric name (e.g., `job.numRestarts`), -and report a particular instance of said metric as a set of `key-value` pairs, so called "tags" or "variables" (e.g., "jobName=MyJobName"). +<a name="push-vs-pull"></a> ## Push vs. Pull -Metrics are exported either via pushes or pulls. +发送器通过 Pull 或 Push 的方式将指标发送出去。 -Push-based reporters usually implement the `Scheduled` interface and periodically send a summary of current metrics to an external system. +基于 Push 的发送器一般实现了 `Scheduled` 接口,周期性地将当前运行指标信息汇总,发送给外部系统存储。 -Pull-based reporters are queried from an external system instead. +基于 Pull 的发送器一般是由外部系统主动发起查询将指标信息拉走。 -## Reporters +<a name="reporter"></a> -The following sections list the supported reporters. +## 发送器 + +接下来的部分列出了 Flink 支持的发送器。 + +<a name="jmx"></a> ### JMX #### (org.apache.flink.metrics.jmx.JMXReporter) -Type: pull/tags +类型: pull/基于 tags 格式 -Parameters: +参数: -- `port` - (optional) the port on which JMX listens for connections. -In order to be able to run several instances of the reporter on one host (e.g. when one TaskManager is colocated with the JobManager) it is advisable to use a port range like `9250-9260`. -When a range is specified the actual port is shown in the relevant job or task manager log. -If this setting is set Flink will start an extra JMX connector for the given port/range. -Metrics are always available on the default local JMX interface. +- `port` -(可选的)JMX 监听的端口。 + 如果需要在一台机器上运行多个发送器示例进行监控时(比如 TaskManger 与 JobManager 在一台机器上运行时),建议将端口号配置为 `9250-9260` 这样的区间, + 实际使用的端口会在相关作业 或 TaskManger 的日志中显示。如果设置了这个选项,Flink 会按照配置的端口号或端口区间开启 JMX 发送器, + 这些运行时指标可以通过本地的 JMX 默认接口访问到。 -Example configuration: +配置示例: ```yaml metrics.reporter.jmx.factory.class: org.apache.flink.metrics.jmx.JMXReporterFactory metrics.reporter.jmx.port: 8789 ``` -Metrics exposed through JMX are identified by a domain and a list of key-properties, which together form the object name. +通过 JMX 发送的指标由“域”和“key-properties”列表组成,“域”总以 `org.apache.flink` 开头,后跟一个“通用指标标识符”。 + +“通用指标标识符”不像一般系统的指标度量那样按照所度量范围的形式进行命名,而是不包含任何变量,如同常量一样,每个作业都有。 +例如,`org.apache.flink.job.task.numBytesOut` 就是一个“域”。 -The domain always begins with `org.apache.flink` followed by a generalized metric identifier. In contrast to the usual -identifier it is not affected by scope-formats, does not contain any variables and is constant across jobs. -An example for such a domain would be `org.apache.flink.job.task.numBytesOut`. +“key-property”列表包含所有指标的具体变量值,无论配置的度量范围格式如何,都能关联到指定的指标。 -The key-property list contains the values for all variables, regardless of configured scope formats, that are associated -with a given metric. -An example for such a list would be `host=localhost,job_name=MyJob,task_name=MyTask`. +例如`host=localhost,job_name=MyJob,task_name=MyTask` 就是一个“key-property”列表。 -The domain thus identifies a metric class, while the key-property list identifies one (or multiple) instances of that metric. +总结来说,“域”标注出了某个指标的类,“key-property”列表标注出了该指标的一个(或者多个)实例。 + +<a name="graphite"></a> ### Graphite #### (org.apache.flink.metrics.graphite.GraphiteReporter) -Type: push/identifier +类型: push/基于标志符格式 -Parameters: +参数: -- `host` - the Graphite server host -- `port` - the Graphite server port -- `protocol` - protocol to use (TCP/UDP) +- `host` - Graphite 服务的地址。 +- `port` - Graphite 服务的端口。 +- `protocol` - 使用的协议(TCP/UDP)。 -Example configuration: +配置示例: ```yaml metrics.reporter.grph.factory.class: org.apache.flink.metrics.graphite.GraphiteReporterFactory @@ -137,16 +144,18 @@ metrics.reporter.grph.protocol: TCP metrics.reporter.grph.interval: 60 SECONDS ``` +<a name="influxdb"></a> + ### InfluxDB -#### (org.apache.flink.metrics.influxdb.InfluxdbReporter) +#### (org.apache.flink.metrics.influxdbPrometheusPushGateway.InfluxdbReporter) -Type: push/tags +类型: push/基于 tags 格式 -Parameters: +参数: -{{< include_reporter_config "layouts/shortcodes/generated/influxdb_reporter_configuration.html" >}} +{{< include_reporter_config "layouts/shortcodes/generated/influxdb_reporter_configuration_zh.html" >}} -Example configuration: +配置示例: ```yaml metrics.reporter.influxdb.factory.class: org.apache.flink.metrics.influxdb.InfluxdbReporterFactory @@ -163,46 +172,49 @@ metrics.reporter.influxdb.writeTimeout: 60000 metrics.reporter.influxdb.interval: 60 SECONDS ``` -The reporter would send metrics using http protocol to the InfluxDB server with the specified retention policy (or the default policy specified on the server). -All Flink metrics variables (see [List of all Variables]({{< ref "docs/ops/metrics" >}}#list-of-all-variables)) are exported as InfluxDB tags. +InfluxDB 发送器会使用 http 协议按照将指标发送到 InfluxDB 服务器。指标的保留策略可通过配置指定,或按照 InfluxDB 服务端的保留策略决定。 +所有的 Flink 运行指标变量(见 [List of all Variables]({{< ref "docs/ops/metrics" >}}#list-of-all-variables))都会按照 tag 形式上报给 InfluxDB。 + +<a name="prometheus"></a> ### Prometheus #### (org.apache.flink.metrics.prometheus.PrometheusReporter) -Type: pull/tags +类型: pull/基于 tags 格式 -Parameters: +参数: -- `port` - (optional) the port the Prometheus exporter listens on, defaults to [9249](https://github.com/prometheus/prometheus/wiki/Default-port-allocations). In order to be able to run several instances of the reporter on one host (e.g. when one TaskManager is colocated with the JobManager) it is advisable to use a port range like `9250-9260`. -- `filterLabelValueCharacters` - (optional) Specifies whether to filter label value characters. If enabled, all characters not matching \[a-zA-Z0-9:_\] will be removed, otherwise no characters will be removed. Before disabling this option please ensure that your label values meet the [Prometheus requirements](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). +- `port` - (可选的)Prometheus 发送器监听的端口,默认为 [9249](https://github.com/prometheus/prometheus/wiki/Default-port-allocations)。如果需要在一台机器上运行多个发送器示例进行监控时(比如 TaskManger 与 JobManager 在一台机器上运行时),建议将端口号配置为 `9250-9260` 这样的区间。 +- `filterLabelValueCharacters` -(可选的)指定是否过滤 label 中的非法字符。如果设置过滤,所有没有按照 \[a-zA-Z0-9:_\] 匹配的字符都会被过滤掉,如果设置不过滤,则不会有字符被过滤掉。设置不过滤前,请确保你的 label 符合 [Prometheus 的 lable 命名规范](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels)。 -Example configuration: +配置示例: ```yaml metrics.reporter.prom.factory.class: org.apache.flink.metrics.prometheus.PrometheusReporterFactory ``` +Flink 指标类型与 Prometheus 指标类型对应关系如下: -Flink metric types are mapped to Prometheus metric types as follows: +| Flink | Prometheus | 注意事项 | +| --------- |------------|-----------------------------------------| +| Counter | Gauge | Prometheus 的 counter 不支持累加。 | +| Gauge | Gauge | 只支持数字与布尔类型。 | +| Histogram | Summary | 分位数为 .5,.75,.95,.98,.99 和 .999。 | +| Meter | Gauge | Prometheus 的 gauge 为 meter 的百分比形式。 | -| Flink | Prometheus | Note | -| --------- |------------|------------------------------------------| -| Counter | Gauge |Prometheus counters cannot be decremented.| -| Gauge | Gauge |Only numbers and booleans are supported. | -| Histogram | Summary |Quantiles .5, .75, .95, .98, .99 and .999 | -| Meter | Gauge |The gauge exports the meter's rate. | +所有的 Flink 运行指标变量(见 [List of all Variables]({{< ref "docs/ops/metrics" >}}#list-of-all-variables))都会按照 label 形式上报给 Prometheus。 -All Flink metrics variables (see [List of all Variables]({{< ref "docs/ops/metrics" >}}#list-of-all-variables)) are exported to Prometheus as labels. +<a name="prometheuspushgateway"></a> ### PrometheusPushGateway #### (org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporter) -Type: push/tags +类型: push/基于 tags 格式 -Parameters: +参数: -{{< include_reporter_config "layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration.html" >}} +{{< include_reporter_config "layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration_zh.html" >}} -Example configuration: +配置示例: ```yaml metrics.reporter.promgateway.factory.class: org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporterFactory @@ -214,21 +226,24 @@ metrics.reporter.promgateway.groupingKey: k1=v1;k2=v2 metrics.reporter.promgateway.interval: 60 SECONDS ``` -The PrometheusPushGatewayReporter pushes metrics to a [Pushgateway](https://github.com/prometheus/pushgateway), which can be scraped by Prometheus. +PrometheusPushGatewayReporter 发送器将运行指标发送给 [Pushgateway](https://github.com/prometheus/pushgateway),Prometheus 再从 Pushgateway 拉取、解析运行指标。 -Please see the [Prometheus documentation](https://prometheus.io/docs/practices/pushing/) for use-cases. +更多使用方法可查看 [Prometheus 的文档](https://prometheus.io/docs/practices/pushing/) + +<a name="statsd"></a> ### StatsD #### (org.apache.flink.metrics.statsd.StatsDReporter) -Type: push/identifier +类型: push/基于标志符格式 + -Parameters: +参数: -- `host` - the StatsD server host -- `port` - the StatsD server port +- `host` - StatsD 的服务器地址。 +- `port` - StatsD 的服务器端口。 -Example configuration: +配置示例: ```yaml metrics.reporter.stsd.factory.class: org.apache.flink.metrics.statsd.StatsDReporterFactory @@ -237,28 +252,29 @@ metrics.reporter.stsd.port: 8125 metrics.reporter.stsd.interval: 60 SECONDS ``` +<a name="datadog"></a> + ### Datadog #### (org.apache.flink.metrics.datadog.DatadogHttpReporter) -Type: push/tags +类型: push/基于 tags 格式 -Note any variables in Flink metrics, such as `<host>`, `<job_name>`, `<tm_id>`, `<subtask_index>`, `<task_name>`, and `<operator_name>`, -will be sent to Datadog as tags. Tags will look like `host:localhost` and `job_name:myjobname`. +使用 Datadog 时,Flink 运行指标中的任何变量,例如 `<host>`、`<job_name>`、 `<tm_id>`、 `<subtask_index>`、`<task_name>`、 `<operator_name>`,都会被当作 `host:localhost`、`job_name:myjobname` 这样的 tag 发送。 -<span class="label label-info">Note</span> Histograms are exposed as a series of gauges following the naming convention of Datadog histograms (`<metric_name>.<aggregation>`). -The `min` aggregation is reported by default, whereas `sum` is not available. -In contrast to Datadog-provided Histograms the reported aggregations are not computed for a specific reporting interval. +<span class="label label-info">注意</span> 按照 Datedog 的 Histograms 命名约定,Histograms 类的运行指标会作为一系列 gauges 显示(`<metric_name>.<aggregation>`)。 +默认情况下 `min` 即最小值被发送到 Datedog,`sum` 不会被发送。 +与 Datadog 提供的 Histograms 相比,Histograms 类的运行指标不会按照指定的发送间隔进行聚合计算。 -Parameters: +参数: -- `apikey` - the Datadog API key -- `tags` - (optional) the global tags that will be applied to metrics when sending to Datadog. Tags should be separated by comma only -- `proxyHost` - (optional) The proxy host to use when sending to Datadog. -- `proxyPort` - (optional) The proxy port to use when sending to Datadog, defaults to 8080. -- `dataCenter` - (optional) The data center (`EU`/`US`) to connect to, defaults to `US`. -- `maxMetricsPerRequest` - (optional) The maximum number of metrics to include in each request, defaults to 2000. +- `apikey` - Datadog 的 API KEY。 +- `tags` - (可选的)发送到 Datadog 时将会转换为指标的全局 tag。tag 间只能以逗号分隔。 +- `proxyHost` - (可选的)发送到 Datadog 时使用的代理主机。 +- `proxyPort` - (可选的)发送到 Datadog 时使用的代理端口,默认为 8080。 +- `dataCenter` - (可选的)要连接的数据中心(`EU`/`US`),默认为 `US`。 +- `maxMetricsPerRequest` - (可选的)每次请求携带的最大运行指标个数,默认为 2000。 -Example configuration: +配置示例: ```yaml metrics.reporter.dghttp.factory.class: org.apache.flink.metrics.datadog.DatadogHttpReporterFactory @@ -271,13 +287,14 @@ metrics.reporter.dghttp.maxMetricsPerRequest: 2000 metrics.reporter.dghttp.interval: 60 SECONDS ``` +<a name="slf4j"></a> ### Slf4j #### (org.apache.flink.metrics.slf4j.Slf4jReporter) -Type: push/identifier +类型: push/基于标志符格式 -Example configuration: +配置示例: ```yaml metrics.reporter.slf4j.factory.class: org.apache.flink.metrics.slf4j.Slf4jReporterFactory diff --git a/docs/layouts/shortcodes/generated/influxdb_reporter_configuration_zh.html b/docs/layouts/shortcodes/generated/influxdb_reporter_configuration_zh.html new file mode 100644 index 00000000000..422cbfb53dc --- /dev/null +++ b/docs/layouts/shortcodes/generated/influxdb_reporter_configuration_zh.html @@ -0,0 +1,72 @@ +<table class="configuration table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 20%">键</th> + <th class="text-left" style="width: 15%">默认值</th> + <th class="text-left" style="width: 10%">数据类型</th> + <th class="text-left" style="width: 55%">描述</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>metrics.reporter.influxdb.connectTimeout</h5></td> + <td style="word-wrap: break-word;">10000</td> + <td>Integer</td> + <td>(可选的)连接 InfluxDB 时的超时时间。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.consistency</h5></td> + <td style="word-wrap: break-word;">ONE</td> + <td><p>Enum</p></td> + <td>(可选的)InfluxDB 保存指标时的一致性级别。<br /><br />可选的值:<ul><li>"ALL"</li><li>"ANY"</li><li>"ONE"</li><li>"QUORUM"</li></ul></td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.db</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>存储运行指标的 InfluxDB 数据库名称。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.host</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>InfluxDB 服务器的地址。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.password</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>(可选的)验证 InfluxDB 时用户名的密码。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.port</h5></td> + <td style="word-wrap: break-word;">8086</td> + <td>Integer</td> + <td>InfluxDB 服务器的端口号。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.retentionPolicy</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>(可选的)InfluxDB 保存指标时使用的保留策略。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.scheme</h5></td> + <td style="word-wrap: break-word;">http</td> + <td><p>Enum</p></td> + <td>InfluxDB 使用的协议。<br /><br />可选的值:<ul><li>"http"</li><li>"https"</li></ul></td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.username</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>(可选的)验证 InfluxDB 时的用户名。</td> + </tr> + <tr> + <td><h5>metrics.reporter.influxdb.writeTimeout</h5></td> + <td style="word-wrap: break-word;">10000</td> + <td>Integer</td> + <td>(可选的)InfluxDB 的写入超时时间。</td> + </tr> + </tbody> +</table> diff --git a/docs/layouts/shortcodes/generated/metric_reporters_section_zh.html b/docs/layouts/shortcodes/generated/metric_reporters_section_zh.html new file mode 100644 index 00000000000..dee4daf33ab --- /dev/null +++ b/docs/layouts/shortcodes/generated/metric_reporters_section_zh.html @@ -0,0 +1,60 @@ +<table class="configuration table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 20%">键</th> + <th class="text-left" style="width: 15%">默认值</th> + <th class="text-left" style="width: 10%">数据类型</th> + <th class="text-left" style="width: 55%">描述</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>metrics.reporter.<name>.factory.class</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>命名为 <name> 发送器的工厂类名称。</td> + </tr> + <tr> + <td><h5>metrics.reporter.<name>.interval</h5></td> + <td style="word-wrap: break-word;">10 s</td> + <td>Duration</td> + <td>命名为 <name> 发送器的发送间隔,只支持 push 类型发送器。</td> + </tr> + <tr> + <td><h5>metrics.reporter.<name>.scope.delimiter</h5></td> + <td style="word-wrap: break-word;">"."</td> + <td>String</td> + <td>命名为 <name> 发送器的指标标识符中的间隔符。</td> + </tr> + <tr> + <td><h5>metrics.reporter.<name>.scope.variables.additional</h5></td> + <td style="word-wrap: break-word;"></td> + <td>Map</td> + <td>命名为 <name> 发送器的 map 形式的变量列表,只支持 tags 类型发送器。</td> + </tr> + <tr> + <td><h5>metrics.reporter.<name>.scope.variables.excludes</h5></td> + <td style="word-wrap: break-word;">"."</td> + <td>String</td> + <td>命名为 <name> 发送器应该忽略的一组变量,只支持 tags 类型发送器。</td> + </tr> + <tr> + <td><h5>metrics.reporter.<name>.filter.includes</h5></td> + <td style="word-wrap: break-word;">"*:*:*"</td> + <td>List<String></td> + <td>命名为 <name> 发送器应包含的运行指标,其过滤条件以列表形式表示,该列表中每一个过滤条件都应遵循如下规范:<br /><code class="highlighter-rouge"><scope>[:<name>[,<name>][:<type>[,<type>]]]</code><br 当指标与过滤条件中的范围、名称(至少一个)、类型(至少一个)都匹配时,该指标才算符合过滤条件。<br /><ul><li>范围: 指过滤条件中指标所属的逻辑范围。<br />以如下模式进行匹配:<code class="highlighter-rouge">*</code> 代表所有字符都匹配。<code class="highlighter-rouge">.</code> 划分范围的层级。<br /><br />例如:<br /> "<code class="highlighter-rouge">jobmanager.job</code>" 匹配出 JobManager 上运 [...] + </tr> + <tr> + <td><h5>metrics.reporter.<name>.filter.excludes</h5></td> + <td style="word-wrap: break-word;"></td> + <td>List<String></td> + <td>命名为 <name> 发送器应排除掉的运行指标,形式与 <code class="highlighter-rouge">filter.includes</code> 类似。<br /></td> + </tr> + <tr> + <td><h5>metrics.reporter.<name>.<parameter></h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>配置命名为 <name> 发送器的 <parameter> 项</td> + </tr> + </tbody> +</table> diff --git a/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration_zh.html b/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration_zh.html new file mode 100644 index 00000000000..d79a5ba0e97 --- /dev/null +++ b/docs/layouts/shortcodes/generated/prometheus_push_gateway_reporter_configuration_zh.html @@ -0,0 +1,48 @@ +<table class="configuration table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 20%">键</th> + <th class="text-left" style="width: 15%">默认值</th> + <th class="text-left" style="width: 10%">数据类型</th> + <th class="text-left" style="width: 55%">描述</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>metrics.reporter.prometheus.deleteOnShutdown</h5></td> + <td style="word-wrap: break-word;">true</td> + <td>Boolean</td> + <td>是否在 PushGateway 停止运行时删除指标数据,Flink 会尽最大可能性删除指标数据(不保证一定能删除),更多细节请查看 <a href="https://issues.apache.org/jira/browse/FLINK-13787">此链接</a>。</td> + </tr> + <tr> + <td><h5>metrics.reporter.prometheus.filterLabelValueCharacters</h5></td> + <td style="word-wrap: break-word;">true</td> + <td>Boolean</td> + <td>是否过滤 label 中的字符。如果设置过滤,所有没有按照 \[a-zA-Z0-9:_\] 匹配的字符都会被过滤掉,如果设置不过滤,则不会有字符被过滤掉。设置不过滤前,请确保你的 label 符合 <a href="https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels">Prometheus 的命名规范</a>。</td> + </tr> + <tr> + <td><h5>metrics.reporter.prometheus.groupingKey</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>指定分组键,作为所有指标的组和全局标签。标签名称与值之间用 '=' 分割,标签与标签之间用 ';' 分隔,比如 <code class="highlighter-rouge">k1=v1;k2=v2</code> 。请确保你的分组键符合 <a href="https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels">Prometheus 的命名规范</a>。</td> + </tr> + <tr> + <td><h5>metrics.reporter.prometheus.hostUrl</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>PushGateway 服务器的 URL,包括协议、服务地址、端口号。</td> + </tr> + <tr> + <td><h5>metrics.reporter.prometheus.jobName</h5></td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>推送运行指标数据时的作业名。</td> + </tr> + <tr> + <td><h5>metrics.reporter.prometheus.randomJobNameSuffix</h5></td> + <td style="word-wrap: break-word;">true</td> + <td>Boolean</td> + <td>是否在作业名后添加一个随机后缀。</td> + </tr> + </tbody> +</table>