[docs] Document metrics visualization in web-frontend
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/052922cd Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/052922cd Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/052922cd Branch: refs/heads/master Commit: 052922cdd9f62c230f2b02c34414b95f841dd2ad Parents: 5e9d93a Author: zentol <[email protected]> Authored: Fri Jan 13 12:18:01 2017 +0100 Committer: Ufuk Celebi <[email protected]> Committed: Tue Jan 24 10:56:59 2017 +0100 ---------------------------------------------------------------------- docs/monitoring/metrics.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/052922cd/docs/monitoring/metrics.md ---------------------------------------------------------------------- diff --git a/docs/monitoring/metrics.md b/docs/monitoring/metrics.md index 063962b..a524f58 100644 --- a/docs/monitoring/metrics.md +++ b/docs/monitoring/metrics.md @@ -631,4 +631,18 @@ latency issues caused by individual machines. Currently, Flink assumes that the clocks of all machines in the cluster are in sync. We recommend setting up an automated clock synchronisation service (like NTP) to avoid false latency results. +### Dashboard integration + +Metrics that were gathered for each task or operator can also be visualized in the Dashboard. On the main page for a +job, select the `Metrics` tab. After selecting one of the tasks in the top graph you can select metrics to display using +the `Add Metric` drop-down menu. + +* Task metrics are listed as `<subtask_index>.<metric_name>`. +* Operator metrics are listed as `<subtask_index>.<operator_name>.<metric_name>`. + +Each metric will be visualized as a separate graph, with the x-axis representing time and the y-axis the measured value. +All graphs are automatically updated every 10 seconds, and continue to do so when navigating to another page. + +There is no limit as to the number of visualized metrics; however only numeric metrics can be visualized. + {% top %}
