[
https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15735158#comment-15735158
]
ASF GitHub Bot commented on FLINK-5211:
---------------------------------------
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/2972#discussion_r91705355
--- Diff: docs/monitoring/metrics.md ---
@@ -335,6 +345,21 @@ Parameters:
- `ttl` - time-to-live for transmitted UDP packets
- `addressingMode` - UDP addressing mode to use (UNICAST/MULTICAST)
+Example configuration:
+
+{% highlight yaml %}
+
+metrics.reporters: gang
--- End diff --
I would expect that users will not read the full documentation, or even the
full reporter section. There will be plenty that jump straight to the reporter
of their interest, so we can't rely on people understanding it by reading
another part of the docs.
I will keep the names as is.
> Include an example configuration for all reporters
> --------------------------------------------------
>
> Key: FLINK-5211
> URL: https://issues.apache.org/jira/browse/FLINK-5211
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, Metrics
> Reporter: Chesnay Schepler
> Assignee: Chesnay Schepler
> Fix For: 1.2.0
>
>
> We should extend the reporter documentation to include an example
> configuration for every reporter.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
