[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[ https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15741973#comment-15741973 ] ASF GitHub Bot commented on FLINK-5211: --- Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/2972 > 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[
https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15735323#comment-15735323
]
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_r91715769
--- 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 --
hah, you got me there. We could also use things like "foo" or "bar" i guess.
> 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[
https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15735161#comment-15735161
]
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_r91705438
--- 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 admit though that it looks a bit odd.
> 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[ https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15735163#comment-15735163 ] ASF GitHub Bot commented on FLINK-5211: --- Github user zentol commented on the issue: https://github.com/apache/flink/pull/2972 @uce Thanks for the review, I've checked that every configuration does in fact work. Merging this. > 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[
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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[
https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15733650#comment-15733650
]
ASF GitHub Bot commented on FLINK-5211:
---
Github user uce commented on a diff in the pull request:
https://github.com/apache/flink/pull/2972#discussion_r91626592
--- 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 think that's very easy to understand when reading the first, but this is
definitely good enough! Feel free to merge as is, but can you double check that
the examples are actually correct (no typos, etc.) and consistent with the
other parts of the documentation.
> 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[
https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15733563#comment-15733563
]
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_r91620174
--- 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 --
there is no limit, but i wanted to make sure that users understand that the
name is arbitrary; as in to configure graphite the reporter does not have to
called "graphite" as well.
> 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[ https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15733382#comment-15733382 ] ASF GitHub Bot commented on FLINK-5211: --- Github user uce commented on the issue: https://github.com/apache/flink/pull/2972 Very good idea! This will definitely be helpful for users. > 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)
[jira] [Commented] (FLINK-5211) Include an example configuration for all reporters
[ https://issues.apache.org/jira/browse/FLINK-5211?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15732980#comment-15732980 ] ASF GitHub Bot commented on FLINK-5211: --- GitHub user zentol opened a pull request: https://github.com/apache/flink/pull/2972 [FLINK-5211] [metrics] [docs] Include example reporter configuration CC @tillrohrmann You can merge this pull request into a Git repository by running: $ git pull https://github.com/zentol/flink 5211_docs_reporter Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/2972.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #2972 commit 7839152db689241d851f218907103ad3a191f974 Author: zentol Date: 2016-11-30T15:20:45Z [FLINK-5211] [metrics] [docs] Include example reporter configuration > 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)
