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 e13f479f483eb37fda0f90b1260b34367c68356a Author: Till Rohrmann <[email protected]> AuthorDate: Wed Nov 25 15:00:24 2020 +0100 [FLINK-20342][docs] Move ops/monitoring/rest_api.md to ops/rest_api.md --- docs/index.md | 2 +- docs/index.zh.md | 2 +- docs/ops/metrics.md | 4 ++-- docs/ops/metrics.zh.md | 4 ++-- docs/ops/{monitoring => }/rest_api.md | 6 +++--- docs/ops/{monitoring => }/rest_api.zh.md | 6 +++--- 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 | 4 ++-- docs/try-flink/flink-operations-playground.zh.md | 4 ++-- 11 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7e86872..6783847 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 ops/monitoring/rest_api.md %}) +* [Rest API]({% link ops/rest_api.md %}) * [CLI]({% link deployment/cli.md %}) </div> diff --git a/docs/index.zh.md b/docs/index.zh.md index dfb2950..68d84c0 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 ops/monitoring/rest_api.zh.md %}) +* [Rest API]({% link ops/rest_api.zh.md %}) * [CLI]({% link deployment/cli.zh.md %}) </div> diff --git a/docs/ops/metrics.md b/docs/ops/metrics.md index 50298de..698b115 100644 --- a/docs/ops/metrics.md +++ b/docs/ops/metrics.md @@ -1,7 +1,7 @@ --- title: "Metrics" nav-parent_id: ops -nav-pos: 6 +nav-pos: 5 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -1629,7 +1629,7 @@ purposes. ## REST API integration -Metrics can be queried through the [Monitoring REST API]({% link ops/monitoring/rest_api.md %}). +Metrics can be queried through the [Monitoring REST API]({% link ops/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/ops/metrics.zh.md b/docs/ops/metrics.zh.md index 3df49a5..9e01aeb 100644 --- a/docs/ops/metrics.zh.md +++ b/docs/ops/metrics.zh.md @@ -1,7 +1,7 @@ --- title: "指标" nav-parent_id: ops -nav-pos: 6 +nav-pos: 5 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -1629,7 +1629,7 @@ purposes. ## REST API integration -Metrics can be queried through the [Monitoring REST API]({% link ops/monitoring/rest_api.zh.md %}). +Metrics can be queried through the [Monitoring REST API]({% link ops/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/ops/monitoring/rest_api.md b/docs/ops/rest_api.md similarity index 97% rename from docs/ops/monitoring/rest_api.md rename to docs/ops/rest_api.md index ad7c6f7..11b6c1e 100644 --- a/docs/ops/monitoring/rest_api.md +++ b/docs/ops/rest_api.md @@ -1,7 +1,7 @@ --- -title: "Monitoring REST API" -nav-parent_id: monitoring_group -nav-pos: 3 +title: "REST API" +nav-parent_id: ops +nav-pos: 6 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/monitoring/rest_api.zh.md b/docs/ops/rest_api.zh.md similarity index 98% rename from docs/ops/monitoring/rest_api.zh.md rename to docs/ops/rest_api.zh.md index 0f69269..db39131 100644 --- a/docs/ops/monitoring/rest_api.zh.md +++ b/docs/ops/rest_api.zh.md @@ -1,7 +1,7 @@ --- -title: "监控 REST API" -nav-parent_id: monitoring_group -nav-pos: 3 +title: "REST API" +nav-parent_id: ops +nav-pos: 6 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/redirects/rest_api.md b/docs/redirects/rest_api.md index c433b03..84cc110 100644 --- a/docs/redirects/rest_api.md +++ b/docs/redirects/rest_api.md @@ -1,7 +1,7 @@ --- title: "Monitoring REST API" layout: redirect -redirect: /ops/monitoring/rest_api.html +redirect: /ops/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 a772827..bbec0ce 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 }}/ops/monitoring/rest_api.html#available-requests) for details. +Please check the [REST API documentation]({{ site.baseurl }}/ops/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 a772827..bbec0ce 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 }}/ops/monitoring/rest_api.html#available-requests) for details. +Please check the [REST API documentation]({{ site.baseurl }}/ops/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 83885a0..6ddeefd 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 ops/monitoring/rest_api.md %}#api) is exposed via +The [Flink REST API]({% link ops/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 ops/monitoring/rest_api.md %}#api) +Please consult the [REST API reference]({% link ops/rest_api.md %}#api) for a complete list of possible queries including how to query metrics of different scopes (e.g. TaskManager metrics); diff --git a/docs/try-flink/flink-operations-playground.zh.md b/docs/try-flink/flink-operations-playground.zh.md index 1d1b53a..cac0f34 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 ops/monitoring/rest_api.zh.md %}#api) 可以通过本机的 +[Flink REST API]({%link ops/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 ops/monitoring/rest_api.zh.md %}#api)，该参考上有完整的指标查询接口信息，包括如何查询不同种类的指标（例如 TaskManager 指标）。 +请查阅 [REST API 参考]({%link ops/rest_api.zh.md %}#api)，该参考上有完整的指标查询接口信息，包括如何查询不同种类的指标（例如 TaskManager 指标）。 {% top %}
