[FLINK-5451] Extend JMX reporter section
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/5e9d93af Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/5e9d93af Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/5e9d93af Branch: refs/heads/master Commit: 5e9d93afd8bee6cd5261c3d965255b000c168889 Parents: 10a8e4b Author: zentol <[email protected]> Authored: Fri Jan 13 12:17:20 2017 +0100 Committer: Ufuk Celebi <[email protected]> Committed: Tue Jan 24 10:56:59 2017 +0100 ---------------------------------------------------------------------- docs/monitoring/metrics.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/5e9d93af/docs/monitoring/metrics.md ---------------------------------------------------------------------- diff --git a/docs/monitoring/metrics.md b/docs/monitoring/metrics.md index cfffe65..063962b 100644 --- a/docs/monitoring/metrics.md +++ b/docs/monitoring/metrics.md @@ -334,9 +334,9 @@ but not activated. Parameters: -- `port` - the port on which JMX listens for connections. This can also be a port range. When a -range is specified the actual port is shown in the relevant job or task manager log. If you don't -specify a port no extra JMX server will be started. Metrics are still available on the default +- `port` - (optional) the port on which JMX listens for connections. This can also be a port range. When a +range is specified the actual port is shown in the relevant job or task manager log. If this setting is set +Flink will start an extra JMX connector for the given port/range. Metrics are always available on the default local JMX interface. Example configuration: @@ -349,6 +349,18 @@ metrics.reporter.jmx.port: 8789 {% endhighlight %} +Metrics exposed through JMX are identified by a domain and a list of key-properties, which together form the object name. + +The domain always begins with `org.apache.flink` followed by a generalized metric identifier. In contrast to the usual +identifier it is not affected by scope-formats, does not contain any variables and is constant across jobs. +An example for such a domain would be `org.apache.flink.job.task.numBytesOut`. + +The key-property list contains the values for all variables, regardless of configured scope formats, that are associated +with a given metric. +An example for such a list would be `host=localhost,job_name=MyJob,task_name=MyTask`. + +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 %}
