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 22d9af88118039edb6ade7b84bcac6fb0961764e Author: Till Rohrmann <[email protected]> AuthorDate: Wed Nov 25 13:23:26 2020 +0100 [FLINK-20342][docs] Move monitoring/metrics.md to ops/metrics.md --- docs/deployment/config.md | 2 +- docs/deployment/config.zh.md | 2 +- docs/deployment/filesystems/plugins.md | 2 +- docs/deployment/filesystems/plugins.zh.md | 2 +- docs/deployment/memory/mem_setup.md | 2 +- docs/deployment/memory/mem_setup.zh.md | 2 +- docs/deployment/metric_reporters.md | 2 +- docs/deployment/metric_reporters.zh.md | 2 +- docs/dev/connectors/kafka.md | 2 +- docs/dev/connectors/kafka.zh.md | 2 +- docs/dev/python/table-api-users-guide/metrics.md | 14 +++++++------- .../dev/python/table-api-users-guide/metrics.zh.md | 14 +++++++------- docs/ops/debugging/debugging_event_time.md | 4 ++-- docs/ops/debugging/debugging_event_time.zh.md | 4 ++-- docs/ops/debugging/index.md | 2 +- docs/ops/debugging/index.zh.md | 2 +- docs/{monitoring => ops}/metrics.md | 20 ++++++++++---------- docs/{monitoring => ops}/metrics.zh.md | 22 +++++++++++----------- docs/ops/monitoring/index.md | 2 +- docs/ops/monitoring/index.zh.md | 2 +- docs/ops/state/large_state_tuning.md | 2 +- docs/ops/state/large_state_tuning.zh.md | 2 +- docs/redirects/metrics.md | 2 +- docs/release-notes/flink-1.9.md | 2 +- docs/release-notes/flink-1.9.zh.md | 2 +- docs/try-flink/flink-operations-playground.md | 4 ++-- docs/try-flink/flink-operations-playground.zh.md | 4 ++-- 27 files changed, 62 insertions(+), 62 deletions(-) diff --git a/docs/deployment/config.md b/docs/deployment/config.md index f2ca0f2..b6143a9 100644 --- a/docs/deployment/config.md +++ b/docs/deployment/config.md @@ -240,7 +240,7 @@ These are the options commonly needed to configure the RocksDB state backend. Se # Metrics -Please refer to the [metrics system documentation]({% link monitoring/metrics.md %}) for background on Flink's metrics infrastructure. +Please refer to the [metrics system documentation]({% link ops/metrics.md %}) for background on Flink's metrics infrastructure. {% include generated/metric_configuration.html %} diff --git a/docs/deployment/config.zh.md b/docs/deployment/config.zh.md index 6ff59e7..eb10fdd 100644 --- a/docs/deployment/config.zh.md +++ b/docs/deployment/config.zh.md @@ -240,7 +240,7 @@ These are the options commonly needed to configure the RocksDB state backend. Se # Metrics -Please refer to the [metrics system documentation]({% link monitoring/metrics.zh.md %}) for background on Flink's metrics infrastructure. +Please refer to the [metrics system documentation]({% link ops/metrics.zh.md %}) for background on Flink's metrics infrastructure. {% include generated/metric_configuration.html %} diff --git a/docs/deployment/filesystems/plugins.md b/docs/deployment/filesystems/plugins.md index aaab6a0..ff27e6d 100644 --- a/docs/deployment/filesystems/plugins.md +++ b/docs/deployment/filesystems/plugins.md @@ -117,6 +117,6 @@ Furthermore, loggers are whitelisted, so that they are configured properly. ## Metric Reporters All [metric reporters]({% link deployment/metric_reporters.md %}) that Flink provides can be used as plugins. -See the [metrics]({% link monitoring/metrics.md %}) documentation for more details. +See the [metrics]({% link ops/metrics.md %}) documentation for more details. {% top %} diff --git a/docs/deployment/filesystems/plugins.zh.md b/docs/deployment/filesystems/plugins.zh.md index aaab6a0..ff27e6d 100644 --- a/docs/deployment/filesystems/plugins.zh.md +++ b/docs/deployment/filesystems/plugins.zh.md @@ -117,6 +117,6 @@ Furthermore, loggers are whitelisted, so that they are configured properly. ## Metric Reporters All [metric reporters]({% link deployment/metric_reporters.md %}) that Flink provides can be used as plugins. -See the [metrics]({% link monitoring/metrics.md %}) documentation for more details. +See the [metrics]({% link ops/metrics.md %}) documentation for more details. {% top %} diff --git a/docs/deployment/memory/mem_setup.md b/docs/deployment/memory/mem_setup.md index 2abcf32..6dfdad3 100644 --- a/docs/deployment/memory/mem_setup.md +++ b/docs/deployment/memory/mem_setup.md @@ -101,7 +101,7 @@ or derived memory component sizes: | *-XX:MaxMetaspaceSize* | JVM Metaspace | JVM Metaspace | {:.table-bordered} (\*) Keep in mind that you might not be able to use the full amount of heap memory depending on the GC algorithm used. Some GC algorithms allocate a certain amount of heap memory for themselves. -This will lead to a different maximum being returned by the [Heap metrics]({% link monitoring/metrics.md %}#memory). +This will lead to a different maximum being returned by the [Heap metrics]({% link ops/metrics.md %}#memory). <br/> (\*\*) Notice, that the native non-direct usage of memory in user code can be also accounted for as a part of the off-heap memory. <br/> diff --git a/docs/deployment/memory/mem_setup.zh.md b/docs/deployment/memory/mem_setup.zh.md index 61ffde5..f39a108 100644 --- a/docs/deployment/memory/mem_setup.zh.md +++ b/docs/deployment/memory/mem_setup.zh.md @@ -100,7 +100,7 @@ Flink 进程启动时，会根据配置的和自动推导出的各内存部分 | *-XX:MaxDirectMemorySize*<br/>（TaskManager 始终设置，JobManager 见注释） | 框架堆外内存 + 任务堆外内存(\*\*) + 网络内存 | 堆外内存 (\*\*) (\*\*\*) | | *-XX:MaxMetaspaceSize* | JVM Metaspace | JVM Metaspace | {:.table-bordered} -(\*) 请记住，根据所使用的 GC 算法，你可能无法使用到全部堆内存。一些 GC 算法会为它们自身分配一定量的堆内存。这会导致[堆的指标]({% link monitoring/metrics.zh.md %}#memory)返回一个不同的最大值。 +(\*) 请记住，根据所使用的 GC 算法，你可能无法使用到全部堆内存。一些 GC 算法会为它们自身分配一定量的堆内存。这会导致[堆的指标]({% link ops/metrics.zh.md %}#memory)返回一个不同的最大值。 <br/> (\*\*) 请注意，堆外内存也包括了用户代码使用的本地内存（非直接内存）。 <br/> diff --git a/docs/deployment/metric_reporters.md b/docs/deployment/metric_reporters.md index 0668027..7ae05da 100644 --- a/docs/deployment/metric_reporters.md +++ b/docs/deployment/metric_reporters.md @@ -23,7 +23,7 @@ under the License. --> Flink allows reporting metrics to external systems. -For more information about Flink's metric system go to the [metric system documentation]({% link monitoring/metrics.md %}). +For more information about Flink's metric system go to the [metric system documentation]({% link ops/metrics.md %}). * This will be replaced by the TOC {:toc} diff --git a/docs/deployment/metric_reporters.zh.md b/docs/deployment/metric_reporters.zh.md index 0668027..7ae05da 100644 --- a/docs/deployment/metric_reporters.zh.md +++ b/docs/deployment/metric_reporters.zh.md @@ -23,7 +23,7 @@ under the License. --> Flink allows reporting metrics to external systems. -For more information about Flink's metric system go to the [metric system documentation]({% link monitoring/metrics.md %}). +For more information about Flink's metric system go to the [metric system documentation]({% link ops/metrics.md %}). * This will be replaced by the TOC {:toc} diff --git a/docs/dev/connectors/kafka.md b/docs/dev/connectors/kafka.md index a897986..853d0df 100644 --- a/docs/dev/connectors/kafka.md +++ b/docs/dev/connectors/kafka.md @@ -502,7 +502,7 @@ application before first checkpoint completes, by factor larger than `FlinkKafka ## Kafka Connector Metrics -Flink's Kafka connectors provide some metrics through Flink's [metrics system]({% link monitoring/metrics.md %}) to analyze +Flink's Kafka connectors provide some metrics through Flink's [metrics system]({% link ops/metrics.md %}) to analyze the behavior of the connector. The producers export Kafka's internal metrics through Flink's metric system for all supported versions. The Kafka documentation lists all exported metrics in its [documentation](http://kafka.apache.org/documentation/#selector_monitoring). diff --git a/docs/dev/connectors/kafka.zh.md b/docs/dev/connectors/kafka.zh.md index d86ddfc..2d70896 100644 --- a/docs/dev/connectors/kafka.zh.md +++ b/docs/dev/connectors/kafka.zh.md @@ -440,7 +440,7 @@ Flink Kafka Producer 需要知道如何将 Java/Scala 对象转化为二进制 ## Kafka 连接器指标 -Flink 的 Kafka 连接器通过 Flink 的 [metric 系统]({% link monitoring/metrics.zh.md %}) 提供一些指标来分析 Kafka Connector 的状况。Producer 通过 Flink 的 metrics 系统为所有支持的版本导出 Kafka 的内部指标。consumer 从 Kafka 0.10 版本开始导出所有指标。Kafka 在其[文档](http://kafka.apache.org/documentation/#selector_monitoring)中列出了所有导出的指标。 +Flink 的 Kafka 连接器通过 Flink 的 [metric 系统]({% link ops/metrics.zh.md %}) 提供一些指标来分析 Kafka Connector 的状况。Producer 通过 Flink 的 metrics 系统为所有支持的版本导出 Kafka 的内部指标。consumer 从 Kafka 0.10 版本开始导出所有指标。Kafka 在其[文档](http://kafka.apache.org/documentation/#selector_monitoring)中列出了所有导出的指标。 除了这些指标之外，所有 consumer 都暴露了每个主题分区的 `current-offsets` 和 `committed-offsets`。`current-offsets` 是指分区中的当前偏移量。指的是我们成功检索和发出的最后一个元素的偏移量。`committed-offsets` 是最后提交的偏移量。这为用户提供了 at-least-once 语义，用于提交给 Zookeeper 或 broker 的偏移量。对于 Flink 的偏移检查点，系统提供精准一次语义。 diff --git a/docs/dev/python/table-api-users-guide/metrics.md b/docs/dev/python/table-api-users-guide/metrics.md index 8c80955..815e846 100644 --- a/docs/dev/python/table-api-users-guide/metrics.md +++ b/docs/dev/python/table-api-users-guide/metrics.md @@ -142,7 +142,7 @@ class MyUDF(ScalarFunction): ## Scope -You can refer to the Java metric document for more details on [Scope definition]({% link monitoring/metrics.md %}#Scope). +You can refer to the Java metric document for more details on [Scope definition]({% link ops/metrics.md %}#Scope). ### User Scope @@ -169,11 +169,11 @@ function_context ### System Scope -You can refer to the Java metric document for more details on [System Scope]({% link monitoring/metrics.md %}#system-scope). +You can refer to the Java metric document for more details on [System Scope]({% link ops/metrics.md %}#system-scope). ### List of all Variables -You can refer to the Java metric document for more details on [List of all Variables]({% link monitoring/metrics.md %}#list-of-all-variables). +You can refer to the Java metric document for more details on [List of all Variables]({% link ops/metrics.md %}#list-of-all-variables). ### User Variables @@ -198,10 +198,10 @@ function_context You can refer to the Java metric document for more details on the following sections: - [Reporter]({% link deployment/metric_reporters.md %}). -- [System metrics]({% link monitoring/metrics.md %}#system-metrics). -- [Latency tracking]({% link monitoring/metrics.md %}#latency-tracking). -- [REST API integration]({% link monitoring/metrics.md %}#rest-api-integration). -- [Dashboard integration]({% link monitoring/metrics.md %}#dashboard-integration). +- [System metrics]({% link ops/metrics.md %}#system-metrics). +- [Latency tracking]({% link ops/metrics.md %}#latency-tracking). +- [REST API integration]({% link ops/metrics.md %}#rest-api-integration). +- [Dashboard integration]({% link ops/metrics.md %}#dashboard-integration). {% top %} diff --git a/docs/dev/python/table-api-users-guide/metrics.zh.md b/docs/dev/python/table-api-users-guide/metrics.zh.md index f59c718..d13914d 100644 --- a/docs/dev/python/table-api-users-guide/metrics.zh.md +++ b/docs/dev/python/table-api-users-guide/metrics.zh.md @@ -143,7 +143,7 @@ class MyUDF(ScalarFunction): ## 范围（Scope） -您可以参考Java指标文档以获取有关[范围定义]({% link monitoring/metrics.zh.md %}#Scope)的更多详细信息。 +您可以参考Java指标文档以获取有关[范围定义]({% link ops/metrics.zh.md %}#Scope)的更多详细信息。 ### 用户范围（User Scope） @@ -171,11 +171,11 @@ function_context ### 系统范围（System Scope） -您可以参考Java指标文档以获取有关[系统范围]({% link monitoring/metrics.zh.md %}#system-scope)的更多详细信息。 +您可以参考Java指标文档以获取有关[系统范围]({% link ops/metrics.zh.md %}#system-scope)的更多详细信息。 ### 所有变量列表 -您可以参考Java指标文档以获取有关[“所有变量列表”的]({% link monitoring/metrics.zh.md %}#list-of-all-variables)更多详细信息。 +您可以参考Java指标文档以获取有关[“所有变量列表”的]({% link ops/metrics.zh.md %}#list-of-all-variables)更多详细信息。 ### 用户变量（User Variables） @@ -200,10 +200,10 @@ function_context 您可以参考Java的指标文档，以获取关于以下部分的更多详细信息： * [Reporter]({% link deployment/metric_reporters.md %}) 。 -* [系统指标]({% link monitoring/metrics.zh.md %}#system-metrics) 。 -* [延迟跟踪]({% link monitoring/metrics.zh.md %}#latency-tracking) 。 -* [REST API集成]({% link monitoring/metrics.zh.md %}#rest-api-integration) 。 -* [仪表板集成]({% link monitoring/metrics.zh.md %}#dashboard-integration) 。 +* [系统指标]({% link ops/metrics.zh.md %}#system-metrics) 。 +* [延迟跟踪]({% link ops/metrics.zh.md %}#latency-tracking) 。 +* [REST API集成]({% link ops/metrics.zh.md %}#rest-api-integration) 。 +* [仪表板集成]({% link ops/metrics.zh.md %}#dashboard-integration) 。 {% top %} diff --git a/docs/ops/debugging/debugging_event_time.md b/docs/ops/debugging/debugging_event_time.md index f81603b..d081fa5 100644 --- a/docs/ops/debugging/debugging_event_time.md +++ b/docs/ops/debugging/debugging_event_time.md @@ -31,7 +31,7 @@ Flink's [event time]({% link dev/event_time.md %}) and watermark support are pow out-of-order events. However, it's harder to understand what exactly is going on because the progress of time is tracked within the system. -Low watermarks of each task can be accessed through Flink web interface or [metrics system]({% link monitoring/metrics.md %}). +Low watermarks of each task can be accessed through Flink web interface or [metrics system]({% link ops/metrics.md %}). Each Task in Flink exposes a metric called `currentInputWatermark` that represents the lowest watermark received by this task. This long value represents the "current event time". @@ -43,7 +43,7 @@ and selecting the `<taskNr>.currentInputWatermark` metric. In the new box you'll the current low watermark of the task. Another way of getting the metric is using one of the **metric reporters**, as described in the documentation -for the [metrics system]({% link monitoring/metrics.md %}). +for the [metrics system]({% link ops/metrics.md %}). For local setups, we recommend using the JMX metric reporter and a tool like [VisualVM](https://visualvm.github.io/). diff --git a/docs/ops/debugging/debugging_event_time.zh.md b/docs/ops/debugging/debugging_event_time.zh.md index 7037f4a..c149c3f 100644 --- a/docs/ops/debugging/debugging_event_time.zh.md +++ b/docs/ops/debugging/debugging_event_time.zh.md @@ -31,13 +31,13 @@ under the License. Flink 的[事件时间]({% link dev/event_time.zh.md %})和 watermark 支持对于处理乱序事件是十分强大的特性。然而，由于是系统内部跟踪时间进度，所以很难了解究竟正在发生什么。 -可以通过 Flink web 界面或[指标系统]({% link monitoring/metrics.zh.md %})访问 task 的 low watermarks。 +可以通过 Flink web 界面或[指标系统]({% link ops/metrics.zh.md %})访问 task 的 low watermarks。 Flink 中的 task 通过调用 `currentInputWatermark` 方法暴露一个指标，该指标表示当前 task 所接收到的 the lowest watermark。这个 long 类型值表示“当前事件时间”。该值通过获取上游算子收到的所有 watermarks 的最小值来计算。这意味着用 watermarks 跟踪的事件时间总是由最落后的 source 控制。 **使用 web 界面**可以访问 low watermark 指标，在指标选项卡中选择一个 task，然后选择 ```<taskNr>.currentInputWatermark``` 指标。在新的显示框中，你可以看到此 task 的当前 low watermark。 -获取指标的另一种方式是使用**指标报告器**之一，如[指标系统]({% link monitoring/metrics.zh.md %})文档所述。对于本地集群设置，我们推荐使用 JMX 指标报告器和类似于 [VisualVM](https://visualvm.github.io/) 的工具。 +获取指标的另一种方式是使用**指标报告器**之一，如[指标系统]({% link ops/metrics.zh.md %})文档所述。对于本地集群设置，我们推荐使用 JMX 指标报告器和类似于 [VisualVM](https://visualvm.github.io/) 的工具。 diff --git a/docs/ops/debugging/index.md b/docs/ops/debugging/index.md index 8b42f71..8c5b2de 100644 --- a/docs/ops/debugging/index.md +++ b/docs/ops/debugging/index.md @@ -2,7 +2,7 @@ title: "Debugging" nav-id: debugging nav-parent_id: ops -nav-pos: 6 +nav-pos: 7 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/debugging/index.zh.md b/docs/ops/debugging/index.zh.md index 8b42f71..8c5b2de 100644 --- a/docs/ops/debugging/index.zh.md +++ b/docs/ops/debugging/index.zh.md @@ -2,7 +2,7 @@ title: "Debugging" nav-id: debugging nav-parent_id: ops -nav-pos: 6 +nav-pos: 7 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/monitoring/metrics.md b/docs/ops/metrics.md similarity index 98% rename from docs/monitoring/metrics.md rename to docs/ops/metrics.md index e8537a6..50298de 100644 --- a/docs/monitoring/metrics.md +++ b/docs/ops/metrics.md @@ -1,7 +1,7 @@ --- title: "Metrics" -nav-parent_id: monitoring -nav-pos: 1 +nav-parent_id: ops +nav-pos: 6 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -1185,42 +1185,42 @@ Certain RocksDB native metrics are available but disabled by default, you can fi <tr> <th rowspan="14"><strong>Task</strong></th> <td>numBytesInLocal</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBytesInLocalPerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> <td>numBytesInRemote</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBytesInRemotePerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> <td>numBuffersInLocal</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBuffersInLocalPerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> <td>numBuffersInRemote</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBuffersInRemotePerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> diff --git a/docs/monitoring/metrics.zh.md b/docs/ops/metrics.zh.md similarity index 98% rename from docs/monitoring/metrics.zh.md rename to docs/ops/metrics.zh.md index 28305ee..3df49a5 100644 --- a/docs/monitoring/metrics.zh.md +++ b/docs/ops/metrics.zh.md @@ -1,7 +1,7 @@ --- title: "指标" -nav-parent_id: monitoring -nav-pos: 1 +nav-parent_id: ops +nav-pos: 6 --- <!-- Licensed to the Apache Software Foundation (ASF) under one @@ -797,7 +797,7 @@ Some metrics might not be exposed when using other JVM implementations (e.g. IBM </table> -### Network (Deprecated: use [Default shuffle service metrics]({% link monitoring/metrics.zh.md %}#default-shuffle-service)) +### Network (Deprecated: use [Default shuffle service metrics]({% link ops/metrics.zh.md %}#default-shuffle-service)) <table class="table table-bordered"> <thead> <tr> @@ -1185,42 +1185,42 @@ Certain RocksDB native metrics are available but disabled by default, you can fi <tr> <th rowspan="13"><strong>Task</strong></th> <td>numBytesInLocal</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBytesInLocalPerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> <td>numBytesInRemote</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBytesInRemotePerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> <td>numBuffersInLocal</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBuffersInLocalPerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> <td>numBuffersInRemote</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Counter</td> </tr> <tr> <td>numBuffersInRemotePerSecond</td> - <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link monitoring/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> + <td><span class="label label-danger">Attention:</span> deprecated, use <a href="{% link ops/metrics.zh.md %}#default-shuffle-service">Default shuffle service metrics</a>.</td> <td>Meter</td> </tr> <tr> diff --git a/docs/ops/monitoring/index.md b/docs/ops/monitoring/index.md index 6ad2af8..e4d6f8e 100644 --- a/docs/ops/monitoring/index.md +++ b/docs/ops/monitoring/index.md @@ -2,7 +2,7 @@ title: "Monitoring" nav-id: monitoring_group nav-parent_id: ops -nav-pos: 7 +nav-pos: 8 --- <!-- Licensed to the Apache Software Foundation (ASF) under one diff --git a/docs/ops/monitoring/index.zh.md b/docs/ops/monitoring/index.zh.md index 6ad2af8..e4d6f8e 100644 --- a/docs/ops/monitoring/index.zh.md +++ b/docs/ops/monitoring/index.zh.md @@ -2,7 +2,7 @@ title: "Monitoring" nav-id: monitoring_group nav-parent_id: ops -nav-pos: 7 +nav-pos: 8 --- <!-- 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 6df2d5d..12b4d7c 100644 --- a/docs/ops/state/large_state_tuning.md +++ b/docs/ops/state/large_state_tuning.md @@ -45,7 +45,7 @@ The easiest way to monitor checkpoint behavior is via the UI's checkpoint sectio for [checkpoint monitoring]({% link ops/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) +The two numbers (both exposed via Task level [metrics]({% link ops/metrics.md %}#checkpointing) and in the [web interface]({% link ops/monitoring/checkpoint_monitoring.md %})) that are of particular interest when scaling up checkpoints are: diff --git a/docs/ops/state/large_state_tuning.zh.md b/docs/ops/state/large_state_tuning.zh.md index 073ca5e..8a36eb7 100644 --- a/docs/ops/state/large_state_tuning.zh.md +++ b/docs/ops/state/large_state_tuning.zh.md @@ -45,7 +45,7 @@ The easiest way to monitor checkpoint behavior is via the UI's checkpoint sectio for [checkpoint monitoring]({% link ops/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) +The two numbers (both exposed via Task level [metrics]({% link ops/metrics.zh.md %}#checkpointing) and in the [web interface]({% link ops/monitoring/checkpoint_monitoring.zh.md %})) that are of particular interest when scaling up checkpoints are: diff --git a/docs/redirects/metrics.md b/docs/redirects/metrics.md index 5da04ee..234f95d 100644 --- a/docs/redirects/metrics.md +++ b/docs/redirects/metrics.md @@ -1,7 +1,7 @@ --- title: "Metrics" layout: redirect -redirect: /monitoring/metrics.html +redirect: /ops/metrics.html permalink: /apis/metrics.html --- <!-- diff --git a/docs/release-notes/flink-1.9.md b/docs/release-notes/flink-1.9.md index d0523a1..b2aa4c2 100644 --- a/docs/release-notes/flink-1.9.md +++ b/docs/release-notes/flink-1.9.md @@ -168,7 +168,7 @@ memory segments. The default timeout is 30 seconds, and is configurable via `tas It is possible that for some previously working deployments this default timeout value is too low and might have to be increased. -Please also notice that several network I/O metrics have had their scope changed. See the [1.9 metrics documentation](https://ci.apache.org/projects/flink/flink-docs-master/monitoring/metrics.html) +Please also notice that several network I/O metrics have had their scope changed. See the [1.9 metrics documentation](https://ci.apache.org/projects/flink/flink-docs-master/ops/metrics.html) for which metrics are affected. In 1.9.0, these metrics will still be available under their previous scopes, but this may no longer be the case in future versions. diff --git a/docs/release-notes/flink-1.9.zh.md b/docs/release-notes/flink-1.9.zh.md index d0523a1..b2aa4c2 100644 --- a/docs/release-notes/flink-1.9.zh.md +++ b/docs/release-notes/flink-1.9.zh.md @@ -168,7 +168,7 @@ memory segments. The default timeout is 30 seconds, and is configurable via `tas It is possible that for some previously working deployments this default timeout value is too low and might have to be increased. -Please also notice that several network I/O metrics have had their scope changed. See the [1.9 metrics documentation](https://ci.apache.org/projects/flink/flink-docs-master/monitoring/metrics.html) +Please also notice that several network I/O metrics have had their scope changed. See the [1.9 metrics documentation](https://ci.apache.org/projects/flink/flink-docs-master/ops/metrics.html) for which metrics are affected. In 1.9.0, these metrics will still be available under their previous scopes, but this may no longer be the case in future versions. diff --git a/docs/try-flink/flink-operations-playground.md b/docs/try-flink/flink-operations-playground.md index ebc20a0..83885a0 100644 --- a/docs/try-flink/flink-operations-playground.md +++ b/docs/try-flink/flink-operations-playground.md @@ -530,7 +530,7 @@ rescaling: all windows are present with a count of exactly one thousand. ### Querying the Metrics of a Job -The JobManager exposes system and user [metrics]({% link monitoring/metrics.md %}) +The JobManager exposes system and user [metrics]({% link ops/metrics.md %}) via its REST API. The endpoint depends on the scope of these metrics. Metrics scoped to a Job can be listed via @@ -808,7 +808,7 @@ command of the *client* container in `docker-compose.yaml`. * `--backpressure` adds an additional operator into the middle of the job that causes severe backpressure 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) +inspecting various [network metrics]({% link ops/metrics.md %}#default-shuffle-service) such as `outputQueueLength` and `outPoolUsage`, and/or by using the [backpressure monitoring]({% link ops/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 0a55673..1d1b53a 100644 --- a/docs/try-flink/flink-operations-playground.zh.md +++ b/docs/try-flink/flink-operations-playground.zh.md @@ -545,7 +545,7 @@ docker-compose scale taskmanager=2 ### 查询 Job 指标 -可以通过 JobManager 提供的 REST API 来获取系统和用户[指标]({%link monitoring/metrics.zh.md %}) +可以通过 JobManager 提供的 REST API 来获取系统和用户[指标]({%link ops/metrics.zh.md %}) 具体请求方式取决于我们想查询哪类指标，Job 相关的指标分类可通过 `jobs/<job-id>/metrics` 获得，而要想查询某类指标的具体值则可以在请求地址后跟上 `get` 参数。 @@ -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 ops/monitoring/back_pressure.zh.md %}#monitoring-back-pressure)也可以观察到。 +* `--backpressure` 将一个额外算子添加到 Job 中，该算子会在偶数分钟内产生严重的反压（比如：10:12 期间，而 10:13 期间不会）。这种现象可以通过多种[网络指标]({%link ops/metrics.zh.md %}#default-shuffle-service)观察到，比如：`outputQueueLength` 和 `outPoolUsage` 指标，通过 WebUI 上的[反压监控]({%link ops/monitoring/back_pressure.zh.md %}#monitoring-back-pressure)也可以观察到。
