[FLINK-5211] [metrics] [docs] Include example reporter configuration This closes #2972.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/36bf9938 Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/36bf9938 Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/36bf9938 Branch: refs/heads/master Commit: 36bf99381dbee6425da51c7448d632ced19c0992 Parents: 365cd98 Author: zentol <[email protected]> Authored: Wed Nov 30 16:20:45 2016 +0100 Committer: zentol <[email protected]> Committed: Mon Dec 12 12:45:26 2016 +0100 ---------------------------------------------------------------------- docs/monitoring/metrics.md | 48 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/36bf9938/docs/monitoring/metrics.md ---------------------------------------------------------------------- diff --git a/docs/monitoring/metrics.md b/docs/monitoring/metrics.md index 2b1e9b5..afbce90 100644 --- a/docs/monitoring/metrics.md +++ b/docs/monitoring/metrics.md @@ -316,6 +316,16 @@ range is specified the actual port is shown in the relevant job or task manager specify a port no extra JMX server will be started. Metrics are still available on the default local JMX interface. +Example configuration: + +{% highlight yaml %} + +metrics.reporters: jmx +metrics.reporter.jmx.class: org.apache.flink.metrics.jmx.JMXReporter +metrics.reporter.jmx.port: 8789 + +{% endhighlight %} + ### Ganglia (org.apache.flink.metrics.ganglia.GangliaReporter) Dependency: {% highlight xml %} @@ -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 +metrics.reporter.gang.class: org.apache.flink.metrics.ganglia.GangliaReporter +metrics.reporter.gang.host: localhost +metrics.reporter.gang.port: 8649 +metrics.reporter.gang.tmax: 60 +metrics.reporter.gang.dmax: 0 +metrics.reporter.gang.ttl: 1 +metrics.reporter.gang.addressingMode: MULTICAST + +{% endhighlight %} + ### Graphite (org.apache.flink.metrics.graphite.GraphiteReporter) Dependency: {% highlight xml %} @@ -351,6 +376,18 @@ Parameters: - `port` - the Graphite server port - `protocol` - protocol to use (TCP/UDP) +Example configuration: + +{% highlight yaml %} + +metrics.reporters: grph +metrics.reporter.grph.class: org.apache.flink.metrics.graphite.GraphiteReporter +metrics.reporter.grph.host: localhost +metrics.reporter.grph.port: 2003 +metrics.reporter.grph.protocol: TCP + +{% endhighlight %} + ### StatsD (org.apache.flink.metrics.statsd.StatsDReporter) Dependency: {% highlight xml %} @@ -366,6 +403,17 @@ Parameters: - `host` - the StatsD server host - `port` - the StatsD server port +Example configuration: + +{% highlight yaml %} + +metrics.reporters: stsd +metrics.reporter.stsd.class: org.apache.flink.metrics.statsd.StatsDReporter +metrics.reporter.stsd.host: localhost +metrics.reporter.stsd.port: 8125 + +{% endhighlight %} + ## System metrics Flink exposes the following system metrics:
