You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/10/13 11:23:47 UTC
[GitHub] [flink] klion26 commented on a change in pull request #13601: [FLINK-19431][docs]Translate "Monitoring REST API" page of "Debugging & Monitoring" into Chinese
klion26 commented on a change in pull request #13601:
URL: https://github.com/apache/flink/pull/13601#discussion_r503867919
##########
File path: docs/monitoring/rest_api.zh.md
##########
@@ -22,46 +22,45 @@ specific language governing permissions and limitations
under the License.
-->
-Flink has a monitoring API that can be used to query status and statistics of running jobs, as well as recent completed jobs.
-This monitoring API is used by Flink's own dashboard, but is designed to be used also by custom monitoring tools.
+Flink 具有监控 API ，可用于查询正在运行的作业以及最近完成的作业的状态和统计信息。该监控 API 被用于 Flink 自己的仪表盘，同时也可用于自定义监控工具。
-The monitoring API is a REST-ful API that accepts HTTP requests and responds with JSON data.
+该监控 API 是 REST-ful 风格的 API ，可以接受 HTTP 请求并返回 JSON 格式的数据。
Review comment:
`该监控 API 是 REST-ful 风格的 API` -> `该监控 API 是 REST-ful 风格的` 是否就可以了
##########
File path: docs/monitoring/rest_api.zh.md
##########
@@ -22,46 +22,45 @@ specific language governing permissions and limitations
under the License.
-->
-Flink has a monitoring API that can be used to query status and statistics of running jobs, as well as recent completed jobs.
-This monitoring API is used by Flink's own dashboard, but is designed to be used also by custom monitoring tools.
+Flink 具有监控 API ，可用于查询正在运行的作业以及最近完成的作业的状态和统计信息。该监控 API 被用于 Flink 自己的仪表盘，同时也可用于自定义监控工具。
-The monitoring API is a REST-ful API that accepts HTTP requests and responds with JSON data.
+该监控 API 是 REST-ful 风格的 API ，可以接受 HTTP 请求并返回 JSON 格式的数据。
* This will be replaced by the TOC
{:toc}
-## Overview
+## 概览
-The monitoring API is backed by a web server that runs as part of the *Dispatcher*. By default, this server listens at port `8081`, which can be configured in `flink-conf.yaml` via `rest.port`. Note that the monitoring API web server and the web dashboard web server are currently the same and thus run together at the same port. They respond to different HTTP URLs, though.
+该监控 API 由作为 *Dispatcher* 一部分运行的 web 服务器提供支持。默认情况下，该服务器监听 8081 端口，端口号可以通过修改 `flink-conf.yaml` 文件的 `rest.port` 进行配置。请注意，该监控 API 的 web 服务器和仪表盘的 web 服务器目前是相同的，因此在同一端口一起运行。不过，它们响应不同的 HTTP URL 。
-In the case of multiple Dispatchers (for high availability), each Dispatcher will run its own instance of the monitoring API, which offers information about completed and running job while that Dispatcher was elected the cluster leader.
+在多个 Dispatcher 的情况下（为了高可用），每个 Dispatcher 将运行自己的监控 API 实例，当 Dispatcher 被选举成为集群 leader 时，该实例将提供已完成和正在运行作业的相关信息。
-## Developing
+## 拓展
-The REST API backend is in the `flink-runtime` project. The core class is `org.apache.flink.runtime.webmonitor.WebMonitorEndpoint`, which sets up the server and the request routing.
+该 REST API 后端位于 `flink-runtime` 项目中。核心类是 `org.apache.flink.runtime.webmonitor.WebMonitorEndpoint` ，用来配置服务器和请求路由。
-We use *Netty* and the *Netty Router* library to handle REST requests and translate URLs. This choice was made because this combination has lightweight dependencies, and the performance of Netty HTTP is very good.
+我们使用 *Netty* 和 *Netty Router* 库来处理 REST 请求和转换 URL 。选择该选项是因为这种组合具有轻量级依赖关系，并且 Netty HTTP 的性能非常好。
-To add new requests, one needs to
-* add a new `MessageHeaders` class which serves as an interface for the new request,
-* add a new `AbstractRestHandler` class which handles the request according to the added `MessageHeaders` class,
-* add the handler to `org.apache.flink.runtime.webmonitor.WebMonitorEndpoint#initializeHandlers()`.
+添加新的请求，需要
+* 添加一个新的 `MessageHeaders` 类，作为新请求的接口，
+* 添加一个新的 `AbstractRestHandler` 类，该类根据添加的 `MessageHeaders` 类处理请求，
Review comment:
“该类根据添加的 `MessageHeaders` 类处理请求” 这句读起来有点怪怪的，能否再优化下
##########
File path: docs/monitoring/rest_api.zh.md
##########
@@ -22,46 +22,45 @@ specific language governing permissions and limitations
under the License.
-->
-Flink has a monitoring API that can be used to query status and statistics of running jobs, as well as recent completed jobs.
-This monitoring API is used by Flink's own dashboard, but is designed to be used also by custom monitoring tools.
+Flink 具有监控 API ，可用于查询正在运行的作业以及最近完成的作业的状态和统计信息。该监控 API 被用于 Flink 自己的仪表盘，同时也可用于自定义监控工具。
-The monitoring API is a REST-ful API that accepts HTTP requests and responds with JSON data.
+该监控 API 是 REST-ful 风格的 API ，可以接受 HTTP 请求并返回 JSON 格式的数据。
* This will be replaced by the TOC
{:toc}
-## Overview
+## 概览
Review comment:
请在每个标题前面添加下 `<a>` 标签吧，具体参考 [wiki](https://cwiki.apache.org/confluence/display/FLINK/Flink+Translation+Specifications)
链接的锚点可以参考英文版的 url
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org