flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From u..@apache.org
Subject [1/5] flink git commit: [FLINK-5451] Extend JMX reporter section
Date Tue, 24 Jan 2017 09:56:03 GMT
Repository: flink
Updated Branches:
  refs/heads/release-1.2 993a2e2fa -> 7296d6bdf


[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/7b1dbb47
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/7b1dbb47
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/7b1dbb47

Branch: refs/heads/release-1.2
Commit: 7b1dbb472e243ce08c6be6421497c053cfbdfd31
Parents: 2497f41
Author: zentol <chesnay@apache.org>
Authored: Fri Jan 13 12:17:20 2017 +0100
Committer: Ufuk Celebi <uce@apache.org>
Committed: Tue Jan 24 10:53:09 2017 +0100

----------------------------------------------------------------------
 docs/monitoring/metrics.md | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/7b1dbb47/docs/monitoring/metrics.md
----------------------------------------------------------------------
diff --git a/docs/monitoring/metrics.md b/docs/monitoring/metrics.md
index 4d0aef0..d4b8117 100644
--- a/docs/monitoring/metrics.md
+++ b/docs/monitoring/metrics.md
@@ -312,9 +312,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:
@@ -327,6 +327,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 %}


Mime
View raw message