[FLINK-25830] Typo mistake in "Metric Report page" of the documentation

• Type: Improvement
• Status: Closed
• Priority: Not a Priority
• Resolution: Fixed
• Fix Version/s: 1.15.0
• Component/s: Documentation
• Labels: auto-unassigned pull-request-available
• Assignee: Chengkai Yang
• Reporter: Chengkai Yang
• Created: 26/Jan/22 14:49
• Updated: 17/Feb/22 13:23
• Resolved: 11/Feb/22 06:56

Description

Hi, I think I find a typo mistake in the documentation:

This page:"Report page" .

In the YAML part:

```yaml
metrics.reporters: my_jmx_reporter,my_other_reporter

metrics.reporter.my_jmx_reporter.factory.class: org.apache.flink.metrics.jmx.JMXReporterFactory
metrics.reporter.my_jmx_reporter.port: 9020-9040
metrics.reporter.my_jmx_reporter.scope.variables.excludes:job_id;task_attempt_num
metrics.reporter.my_jmx_reporter.scope.variables.additional: cluster_name:my_test_cluster,tag_name:tag_value

metrics.reporter.my_other_reporter.class: org.apache.flink.metrics.graphite.GraphiteReporter
metrics.reporter.my_other_reporter.host: 192.168.1.1
metrics.reporter.my_other_reporter.port: 10000
```

This property: metrics.reporter.my_jmx_reporter.scope.variables.excludes:job_id;task_attempt_num

If the user copies this property to the conf/flink-conf.yaml, the user will get a warning in the log like this:

// code placeholder
2022-01-26 22:45:31,642 WARN  org.apache.flink.configuration.GlobalConfiguration           [] - Error while trying to split key and value in configuration file /opt/module/flink-1.14.2/conf/flink-conf.yaml:277: "metrics.reporter.my_jmx_reporter.scope.variables.excludes:job_id;task_attempt_num"
 

So there should have a space between "metrics.reporter.my_jmx_reporter.scope.variables.excludes:" and "job_id;task_attempt_num".

 

 

Issue Links

• is related to: FLINK-25705 Translate "Metric Reporters" page of "Deployment" in to Chinese
• links to: [FLINK-25830][docs]Typo mistake in "Metric Report page" of the documentation
• links to: GitHub Pull Request #18713