Repository: flink Updated Branches: refs/heads/master f98af8cc1 -> 3c4a4b2fe
[FLINK-4396] [docs] Document /opt reporter jars This closes #3116. Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/3c4a4b2f Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/3c4a4b2f Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/3c4a4b2f Branch: refs/heads/master Commit: 3c4a4b2fe0bddbfd6ee825b1add763279db15658 Parents: ef252f0 Author: zentol <[email protected]> Authored: Wed Jan 11 15:09:26 2017 +0100 Committer: Ufuk Celebi <[email protected]> Committed: Tue Jan 24 10:56:59 2017 +0100 ---------------------------------------------------------------------- docs/monitoring/metrics.md | 35 +++++++++++------------------------ 1 file changed, 11 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/3c4a4b2f/docs/monitoring/metrics.md ---------------------------------------------------------------------- diff --git a/docs/monitoring/metrics.md b/docs/monitoring/metrics.md index 5059295..4390a0a 100644 --- a/docs/monitoring/metrics.md +++ b/docs/monitoring/metrics.md @@ -322,6 +322,8 @@ metrics.reporter.my_other_reporter.port: 10000 ``` +**Important:** The jar containing the reporter must be accessible when Flink is started by placing it in the /lib folder. + 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. @@ -362,14 +364,9 @@ An example for such a list would be `host=localhost,job_name=MyJob,task_name=MyT The domain thus identifies a metric class, while the key-property list identifies one (or multiple) instances of that metric. ### Ganglia (org.apache.flink.metrics.ganglia.GangliaReporter) -Dependency: -{% highlight xml %} -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-metrics-ganglia</artifactId> - <version>{{site.version}}</version> -</dependency> -{% endhighlight %} + +In order to use this reporter you must copy `/opt/flink-metrics-ganglia-{{site.version}}.jar` into the `/lib` folder +of your Flink distribution. Parameters: @@ -396,14 +393,9 @@ metrics.reporter.gang.addressingMode: MULTICAST {% endhighlight %} ### Graphite (org.apache.flink.metrics.graphite.GraphiteReporter) -Dependency: -{% highlight xml %} -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-metrics-graphite</artifactId> - <version>{{site.version}}</version> -</dependency> -{% endhighlight %} + +In order to use this reporter you must copy `/opt/flink-metrics-graphite-{{site.version}}.jar` into the `/lib` folder +of your Flink distribution. Parameters: @@ -424,14 +416,9 @@ metrics.reporter.grph.protocol: TCP {% endhighlight %} ### StatsD (org.apache.flink.metrics.statsd.StatsDReporter) -Dependency: -{% highlight xml %} -<dependency> - <groupId>org.apache.flink</groupId> - <artifactId>flink-metrics-statsd</artifactId> - <version>{{site.version}}</version> -</dependency> -{% endhighlight %} + +In order to use this reporter you must copy `/opt/flink-metrics-statsd-{{site.version}}.jar` into the `/lib` folder +of your Flink distribution. Parameters:
