This is an automated email from the ASF dual-hosted git repository. trohrmann pushed a commit to branch release-1.12 in repository https://gitbox.apache.org/repos/asf/flink.git
commit 5270f77746bf5d5d22bdd7d74b357375cfb9815c Author: Till Rohrmann <[email protected]> AuthorDate: Wed Nov 25 11:26:46 2020 +0100 [FLINK-20342][docs] Group monitoring guides under monitoring/monitoring --- docs/index.md | 2 +- docs/index.zh.md | 2 +- docs/learn-flink/fault_tolerance.md | 2 +- docs/learn-flink/fault_tolerance.zh.md | 2 +- docs/monitoring/metrics.md | 2 +- docs/monitoring/metrics.zh.md | 2 +- docs/monitoring/{ => monitoring}/back_pressure.md | 4 ++-- docs/monitoring/{ => monitoring}/back_pressure.zh.md | 4 ++-- docs/monitoring/{ => monitoring}/checkpoint_monitoring.md | 4 ++-- docs/monitoring/{ => monitoring}/checkpoint_monitoring.zh.md | 4 ++-- docs/{redirects/rest_api.md => monitoring/monitoring/index.md} | 8 ++++---- docs/{redirects/rest_api.md => monitoring/monitoring/index.zh.md} | 8 ++++---- docs/monitoring/{ => monitoring}/rest_api.md | 4 ++-- docs/monitoring/{ => monitoring}/rest_api.zh.md | 4 ++-- docs/ops/state/large_state_tuning.md | 6 +++--- docs/ops/state/large_state_tuning.zh.md | 6 +++--- docs/redirects/back_pressure.md | 2 +- docs/redirects/rest_api.md | 2 +- docs/release-notes/flink-1.5.md | 2 +- docs/release-notes/flink-1.5.zh.md | 2 +- docs/try-flink/flink-operations-playground.md | 6 +++--- docs/try-flink/flink-operations-playground.zh.md | 6 +++--- 22 files changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/index.md b/docs/index.md index 87c8c8a..45236a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -68,7 +68,7 @@ The reference documentation covers all the details. Some starting points: <div class="col-sm-6" markdown="1"> * [Configuration]({% link deployment/config.md %}) -* [Rest API]({% link monitoring/rest_api.md %}) +* [Rest API]({% link monitoring/monitoring/rest_api.md %}) * [CLI]({% link deployment/cli.md %}) </div> diff --git a/docs/index.zh.md b/docs/index.zh.md index 61a539e..6bf26c9 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -68,7 +68,7 @@ Apache Flink 是一个在无界和有界数据流上进行状态计算的框架 <div class="col-sm-6" markdown="1"> * [配置参数]({% link deployment/config.zh.md %}) -* [Rest API]({% link monitoring/rest_api.zh.md %}) +* [Rest API]({% link monitoring/monitoring/rest_api.zh.md %}) * [CLI]({% link deployment/cli.zh.md %}) </div> diff --git a/docs/learn-flink/fault_tolerance.md b/docs/learn-flink/fault_tolerance.md index 88dc5f5..8233512 100644 --- a/docs/learn-flink/fault_tolerance.md +++ b/docs/learn-flink/fault_tolerance.md @@ -202,7 +202,7 @@ try-flink/flink-operations-playground.md %}#observing-failure--recovery). - [Checkpoints]({% link ops/state/checkpoints.md %}) - [Savepoints]({% link ops/state/savepoints.md %}) - [Tuning Checkpoints and Large State]({% link ops/state/large_state_tuning.md %}) -- [Monitoring Checkpointing]({% link monitoring/checkpoint_monitoring.md %}) +- [Monitoring Checkpointing]({% link monitoring/monitoring/checkpoint_monitoring.md %}) - [Task Failure Recovery]({% link dev/task_failure_recovery.md %}) {% top %} diff --git a/docs/learn-flink/fault_tolerance.zh.md b/docs/learn-flink/fault_tolerance.zh.md index 568003e..1c798f2 100644 --- a/docs/learn-flink/fault_tolerance.zh.md +++ b/docs/learn-flink/fault_tolerance.zh.md @@ -159,7 +159,7 @@ Barrier 只有在需要提供精确一次的语义保证时需要进行对齐（ - [Checkpoints]({% link ops/state/checkpoints.zh.md %}) - [Savepoints]({% link ops/state/savepoints.zh.md %}) - [大状态与 Checkpoint 调优]({% link ops/state/large_state_tuning.zh.md %}) -- [监控 Checkpoint]({% link monitoring/checkpoint_monitoring.zh.md %}) +- [监控 Checkpoint]({% link monitoring/monitoring/checkpoint_monitoring.zh.md %}) - [Task 故障恢复]({% link dev/task_failure_recovery.zh.md %}) {% top %} diff --git a/docs/monitoring/metrics.md b/docs/monitoring/metrics.md index b948abd..f9061ca 100644 --- a/docs/monitoring/metrics.md +++ b/docs/monitoring/metrics.md @@ -1863,7 +1863,7 @@ purposes. ## REST API integration -Metrics can be queried through the [Monitoring REST API]({% link monitoring/rest_api.md %}). +Metrics can be queried through the [Monitoring REST API]({% link monitoring/monitoring/rest_api.md %}). Below is a list of available endpoints, with a sample JSON response. All endpoints are of the sample form `http://hostname:8081/jobmanager/metrics`, below we list only the *path* part of the URLs. diff --git a/docs/monitoring/metrics.zh.md b/docs/monitoring/metrics.zh.md index be04fe6..3130ae2 100644 --- a/docs/monitoring/metrics.zh.md +++ b/docs/monitoring/metrics.zh.md @@ -1862,7 +1862,7 @@ purposes. ## REST API integration -Metrics can be queried through the [Monitoring REST API]({% link monitoring/rest_api.zh.md %}). +Metrics can be queried through the [Monitoring REST API]({% link monitoring/monitoring/rest_api.zh.md %}). Below is a list of available endpoints, with a sample JSON response. All endpoints are of the sample form `http://hostname:8081/jobmanager/metrics`, below we list only the *path* part of the URLs. diff --git a/docs/monitoring/back_pressure.md b/docs/monitoring/monitoring/back_pressure.md similarity index 98% rename from docs/monitoring/back_pressure.md rename to docs/monitoring/monitoring/back_pressure.md index 5391ea5..9772079 100644 --- a/docs/monitoring/back_pressure.md +++ b/docs/monitoring/monitoring/back_pressure.md @@ -1,7 +1,7 @@ --- title: "Monitoring Back Pressure" -nav-parent_id: monitoring -nav-pos: 5 +nav-parent_id: monitoring_group +nav-pos: 2 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/monitoring/back_pressure.zh.md b/docs/monitoring/monitoring/back_pressure.zh.md similarity index 98% rename from docs/monitoring/back_pressure.zh.md rename to docs/monitoring/monitoring/back_pressure.zh.md index 1a49a6c..f996c5f 100644 --- a/docs/monitoring/back_pressure.zh.md +++ b/docs/monitoring/monitoring/back_pressure.zh.md @@ -1,7 +1,7 @@ --- title: "监控反压" -nav-parent_id: monitoring -nav-pos: 5 +nav-parent_id: monitoring_group +nav-pos: 2 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/monitoring/checkpoint_monitoring.md b/docs/monitoring/monitoring/checkpoint_monitoring.md similarity index 99% rename from docs/monitoring/checkpoint_monitoring.md rename to docs/monitoring/monitoring/checkpoint_monitoring.md index 067a257..6578b79 100644 --- a/docs/monitoring/checkpoint_monitoring.md +++ b/docs/monitoring/monitoring/checkpoint_monitoring.md @@ -1,7 +1,7 @@ --- title: "Monitoring Checkpointing" -nav-parent_id: monitoring -nav-pos: 4 +nav-parent_id: monitoring_group +nav-pos: 1 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/monitoring/checkpoint_monitoring.zh.md b/docs/monitoring/monitoring/checkpoint_monitoring.zh.md similarity index 99% rename from docs/monitoring/checkpoint_monitoring.zh.md rename to docs/monitoring/monitoring/checkpoint_monitoring.zh.md index 837d149..dfb843d 100644 --- a/docs/monitoring/checkpoint_monitoring.zh.md +++ b/docs/monitoring/monitoring/checkpoint_monitoring.zh.md @@ -1,7 +1,7 @@ --- title: "监控 Checkpoint" -nav-parent_id: monitoring -nav-pos: 4 +nav-parent_id: monitoring_group +nav-pos: 1 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/redirects/rest_api.md b/docs/monitoring/monitoring/index.md similarity index 85% copy from docs/redirects/rest_api.md copy to docs/monitoring/monitoring/index.md index 10091b2..95ae992 100644 --- a/docs/redirects/rest_api.md +++ b/docs/monitoring/monitoring/index.md @@ -1,8 +1,8 @@ --- -title: "Monitoring REST API" -layout: redirect -redirect: /monitoring/rest_api.html -permalink: /internals/monitoring_rest_api.html +title: "Monitoring" +nav-id: monitoring_group +nav-parent_id: monitoring +nav-pos: 10 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/redirects/rest_api.md b/docs/monitoring/monitoring/index.zh.md similarity index 85% copy from docs/redirects/rest_api.md copy to docs/monitoring/monitoring/index.zh.md index 10091b2..95ae992 100644 --- a/docs/redirects/rest_api.md +++ b/docs/monitoring/monitoring/index.zh.md @@ -1,8 +1,8 @@ --- -title: "Monitoring REST API" -layout: redirect -redirect: /monitoring/rest_api.html -permalink: /internals/monitoring_rest_api.html +title: "Monitoring" +nav-id: monitoring_group +nav-parent_id: monitoring +nav-pos: 10 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/monitoring/rest_api.md b/docs/monitoring/monitoring/rest_api.md similarity index 98% rename from docs/monitoring/rest_api.md rename to docs/monitoring/monitoring/rest_api.md index 785977c..ad7c6f7 100644 --- a/docs/monitoring/rest_api.md +++ b/docs/monitoring/monitoring/rest_api.md @@ -1,7 +1,7 @@ --- title: "Monitoring REST API" -nav-parent_id: monitoring -nav-pos: 10 +nav-parent_id: monitoring_group +nav-pos: 3 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/monitoring/rest_api.zh.md b/docs/monitoring/monitoring/rest_api.zh.md similarity index 98% rename from docs/monitoring/rest_api.zh.md rename to docs/monitoring/monitoring/rest_api.zh.md index 945e460..0f69269 100644 --- a/docs/monitoring/rest_api.zh.md +++ b/docs/monitoring/monitoring/rest_api.zh.md @@ -1,7 +1,7 @@ --- title: "监控 REST API" -nav-parent_id: monitoring -nav-pos: 10 +nav-parent_id: monitoring_group +nav-pos: 3 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/state/large_state_tuning.md b/docs/ops/state/large_state_tuning.md index 0ae9df1..5d591d2 100644 --- a/docs/ops/state/large_state_tuning.md +++ b/docs/ops/state/large_state_tuning.md @@ -42,11 +42,11 @@ The last section explains some best practices concerning planning how many resou ## Monitoring State and Checkpoints The easiest way to monitor checkpoint behavior is via the UI's checkpoint section. The documentation -for [checkpoint monitoring]({% link monitoring/checkpoint_monitoring.md %}) shows how to access the available checkpoint +for [checkpoint monitoring]({% link monitoring/monitoring/checkpoint_monitoring.md %}) shows how to access the available checkpoint metrics. The two numbers (both exposed via Task level [metrics]({% link monitoring/metrics.md %}#checkpointing) -and in the [web interface]({% link monitoring/checkpoint_monitoring.md %})) that are of particular interest when scaling +and in the [web interface]({% link monitoring/monitoring/checkpoint_monitoring.md %})) that are of particular interest when scaling up checkpoints are: - The time until operators receive their first checkpoint barrier @@ -171,7 +171,7 @@ This section discusses how to decide how many resources should be used for a Fli The basic rules of thumb for capacity planning are: - Normal operation should have enough capacity to not operate under constant *back pressure*. - See [back pressure monitoring]({% link monitoring/back_pressure.md %}) for details on how to check whether the application runs under back pressure. + See [back pressure monitoring]({% link monitoring/monitoring/back_pressure.md %}) for details on how to check whether the application runs under back pressure. - Provision some extra resources on top of the resources needed to run the program back-pressure-free during failure-free time. These resources are needed to "catch up" with the input data that accumulated during the time the application diff --git a/docs/ops/state/large_state_tuning.zh.md b/docs/ops/state/large_state_tuning.zh.md index aaac270..4fefeaa 100644 --- a/docs/ops/state/large_state_tuning.zh.md +++ b/docs/ops/state/large_state_tuning.zh.md @@ -42,11 +42,11 @@ The last section explains some best practices concerning planning how many resou ## Monitoring State and Checkpoints The easiest way to monitor checkpoint behavior is via the UI's checkpoint section. The documentation -for [checkpoint monitoring]({% link monitoring/checkpoint_monitoring.zh.md %}) shows how to access the available checkpoint +for [checkpoint monitoring]({% link monitoring/monitoring/checkpoint_monitoring.zh.md %}) shows how to access the available checkpoint metrics. The two numbers (both exposed via Task level [metrics]({% link monitoring/metrics.zh.md %}#checkpointing) -and in the [web interface]({% link monitoring/checkpoint_monitoring.zh.md %})) that are of particular interest when scaling +and in the [web interface]({% link monitoring/monitoring/checkpoint_monitoring.zh.md %})) that are of particular interest when scaling up checkpoints are: - The time until operators receive their first checkpoint barrier @@ -171,7 +171,7 @@ This section discusses how to decide how many resources should be used for a Fli The basic rules of thumb for capacity planning are: - Normal operation should have enough capacity to not operate under constant *back pressure*. - See [back pressure monitoring]({% link monitoring/back_pressure.zh.md %}) for details on how to check whether the application runs under back pressure. + See [back pressure monitoring]({% link monitoring/monitoring/back_pressure.zh.md %}) for details on how to check whether the application runs under back pressure. - Provision some extra resources on top of the resources needed to run the program back-pressure-free during failure-free time. These resources are needed to "catch up" with the input data that accumulated during the time the application diff --git a/docs/redirects/back_pressure.md b/docs/redirects/back_pressure.md index e5ce8ee..52d1719 100644 --- a/docs/redirects/back_pressure.md +++ b/docs/redirects/back_pressure.md @@ -1,7 +1,7 @@ --- title: "Back Pressure Monitoring" layout: redirect -redirect: /monitoring/back_pressure.html +redirect: /monitoring/monitoring/back_pressure.html permalink: /internals/back_pressure_monitoring.html --- <!-- diff --git a/docs/redirects/rest_api.md b/docs/redirects/rest_api.md index 10091b2..2850b5b 100644 --- a/docs/redirects/rest_api.md +++ b/docs/redirects/rest_api.md @@ -1,7 +1,7 @@ --- title: "Monitoring REST API" layout: redirect -redirect: /monitoring/rest_api.html +redirect: /monitoring/monitoring/rest_api.html permalink: /internals/monitoring_rest_api.html --- <!-- diff --git a/docs/release-notes/flink-1.5.md b/docs/release-notes/flink-1.5.md index 3752622c..b90aa88 100644 --- a/docs/release-notes/flink-1.5.md +++ b/docs/release-notes/flink-1.5.md @@ -64,7 +64,7 @@ In an effort to harmonize, extend, and improve the REST API, a few handlers and * The REST API to cancel a job was changed. * The REST API to cancel a job with savepoint was changed. -Please check the [REST API documentation]({{ site.baseurl }}/monitoring/rest_api.html#available-requests) for details. +Please check the [REST API documentation]({{ site.baseurl }}/monitoring/monitoring/rest_api.html#available-requests) for details. ### Kafka Producer Flushes on Checkpoint by Default diff --git a/docs/release-notes/flink-1.5.zh.md b/docs/release-notes/flink-1.5.zh.md index 3752622c..b90aa88 100644 --- a/docs/release-notes/flink-1.5.zh.md +++ b/docs/release-notes/flink-1.5.zh.md @@ -64,7 +64,7 @@ In an effort to harmonize, extend, and improve the REST API, a few handlers and * The REST API to cancel a job was changed. * The REST API to cancel a job with savepoint was changed. -Please check the [REST API documentation]({{ site.baseurl }}/monitoring/rest_api.html#available-requests) for details. +Please check the [REST API documentation]({{ site.baseurl }}/monitoring/monitoring/rest_api.html#available-requests) for details. ### Kafka Producer Flushes on Checkpoint by Default diff --git a/docs/try-flink/flink-operations-playground.md b/docs/try-flink/flink-operations-playground.md index 4213caa..5b1053c 100644 --- a/docs/try-flink/flink-operations-playground.md +++ b/docs/try-flink/flink-operations-playground.md @@ -177,7 +177,7 @@ docker-compose run --no-deps client flink --help ### Flink REST API -The [Flink REST API]({% link monitoring/rest_api.md %}#api) is exposed via +The [Flink REST API]({% link monitoring/monitoring/rest_api.md %}#api) is exposed via `localhost:8081` on the host or via `jobmanager:8081` from the client container, e.g. to list all currently running jobs, you can run: {% highlight bash%} @@ -780,7 +780,7 @@ curl localhost:8081/jobs/<jod-id> } {% endhighlight %} -Please consult the [REST API reference]({% link monitoring/rest_api.md %}#api) +Please consult the [REST API reference]({% link monitoring/monitoring/rest_api.md %}#api) for a complete list of possible queries including how to query metrics of different scopes (e.g. TaskManager metrics); @@ -810,5 +810,5 @@ command of the *client* container in `docker-compose.yaml`. during even-numbered minutes (e.g., during 10:12, but not during 10:13). This can be observed by inspecting various [network metrics]({% link monitoring/metrics.md %}#default-shuffle-service) such as `outputQueueLength` and `outPoolUsage`, and/or by using the -[backpressure monitoring]({% link monitoring/back_pressure.md %}#monitoring-back-pressure) +[backpressure monitoring]({% link monitoring/monitoring/back_pressure.md %}#monitoring-back-pressure) available in the WebUI. diff --git a/docs/try-flink/flink-operations-playground.zh.md b/docs/try-flink/flink-operations-playground.zh.md index 74e1c02..a3e8910 100644 --- a/docs/try-flink/flink-operations-playground.zh.md +++ b/docs/try-flink/flink-operations-playground.zh.md @@ -175,7 +175,7 @@ docker-compose run --no-deps client flink --help ### Flink REST API -[Flink REST API]({%link monitoring/rest_api.zh.md %}#api) 可以通过本机的 +[Flink REST API]({%link monitoring/monitoring/rest_api.zh.md %}#api) 可以通过本机的 `localhost:8081` 进行访问，也可以在 client 容器中通过 `jobmanager:8081` 进行访问。 比如，通过如下命令可以获取所有正在运行中的 Job： {% highlight bash%} @@ -793,7 +793,7 @@ curl localhost:8081/jobs/<jod-id> } {% endhighlight %} -请查阅 [REST API 参考]({%link monitoring/rest_api.zh.md %}#api)，该参考上有完整的指标查询接口信息，包括如何查询不同种类的指标（例如 TaskManager 指标）。 +请查阅 [REST API 参考]({%link monitoring/monitoring/rest_api.zh.md %}#api)，该参考上有完整的指标查询接口信息，包括如何查询不同种类的指标（例如 TaskManager 指标）。 {% top %} @@ -813,4 +813,4 @@ curl localhost:8081/jobs/<jod-id> *Click Event Count* 这个 Job 还有另外一个选项，该选项默认是关闭的，你可以在 *client* 容器的 `docker-compose.yaml` 文件中添加该选项从而观察该 Job 在反压下的表现，该选项描述如下： -* `--backpressure` 将一个额外算子添加到 Job 中，该算子会在偶数分钟内产生严重的反压（比如：10:12 期间，而 10:13 期间不会）。这种现象可以通过多种[网络指标]({%link monitoring/metrics.zh.md %}#default-shuffle-service)观察到，比如：`outputQueueLength` 和 `outPoolUsage` 指标，通过 WebUI 上的[反压监控]({%link monitoring/back_pressure.zh.md %}#monitoring-back-pressure)也可以观察到。 +* `--backpressure` 将一个额外算子添加到 Job 中，该算子会在偶数分钟内产生严重的反压（比如：10:12 期间，而 10:13 期间不会）。这种现象可以通过多种[网络指标]({%link monitoring/metrics.zh.md %}#default-shuffle-service)观察到，比如：`outputQueueLength` 和 `outPoolUsage` 指标，通过 WebUI 上的[反压监控]({%link monitoring/monitoring/back_pressure.zh.md %}#monitoring-back-pressure)也可以观察到。
