You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "wangzzu (via GitHub)" <gi...@apache.org> on 2023/09/12 05:25:55 UTC
[GitHub] [flink] wangzzu opened a new pull request, #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
wangzzu opened a new pull request, #23399:
URL: https://github.com/apache/flink/pull/23399
<!--
*Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message (including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
- Translate failure-enricher documentation to Chinese
## Brief change log
- Translate failure-enricher documentation to Chinese
## Verifying this change
verify this in local
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? docs
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] wangzzu commented on pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "wangzzu (via GitHub)" <gi...@apache.org>.
wangzzu commented on PR #23399:
URL: https://github.com/apache/flink/pull/23399#issuecomment-1714996308
cc @pgaref @huwh
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] wangzzu commented on pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "wangzzu (via GitHub)" <gi...@apache.org>.
wangzzu commented on PR #23399:
URL: https://github.com/apache/flink/pull/23399#issuecomment-1719495377
@huwh thanks for your review, i have fixed these
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] huwh commented on a diff in pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "huwh (via GitHub)" <gi...@apache.org>.
huwh commented on code in PR #23399:
URL: https://github.com/apache/flink/pull/23399#discussion_r1323974700
##########
docs/content/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -42,7 +42,7 @@ To implement a custom FailureEnricher plugin, you need to:
Then, create a jar which includes your `FailureEnricher`, `FailureEnricherFactory`, `META-INF/services/` and all external dependencies.
Make a directory in `plugins/` of your Flink distribution with an arbitrary name, e.g. "failure-enrichment", and put the jar into this directory.
-See [Flink Plugin]({% link deployment/filesystems/plugins.md %}) for more details.
+See [Flink Plugin]({{< ref "docs/deployment/filesystems/plugins" >}}) for more details.
Review Comment:
I haven’t reviewed it in detail yet. Can you separate this fix change into an independent commit? This is unrelated to translation work.
##########
docs/content/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -42,7 +42,7 @@ To implement a custom FailureEnricher plugin, you need to:
Then, create a jar which includes your `FailureEnricher`, `FailureEnricherFactory`, `META-INF/services/` and all external dependencies.
Make a directory in `plugins/` of your Flink distribution with an arbitrary name, e.g. "failure-enrichment", and put the jar into this directory.
-See [Flink Plugin]({% link deployment/filesystems/plugins.md %}) for more details.
+See [Flink Plugin]({{< ref "docs/deployment/filesystems/plugins" >}}) for more details.
Review Comment:
I haven’t reviewed it in detail yet. Can you separate this fix change into an independent commit? This is unrelated to translation work.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #23399:
URL: https://github.com/apache/flink/pull/23399#issuecomment-1715000130
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "f9a5b318b86856634929075d2b3c37820a858e45",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "f9a5b318b86856634929075d2b3c37820a858e45",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* f9a5b318b86856634929075d2b3c37820a858e45 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run azure` re-run the last Azure build
</details>
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] huwh commented on a diff in pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "huwh (via GitHub)" <gi...@apache.org>.
huwh commented on code in PR #23399:
URL: https://github.com/apache/flink/pull/23399#discussion_r1325871369
##########
docs/content.zh/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -21,34 +21,33 @@ specific language governing permissions and limitations
under the License.
-->
-## Custom failure enrichers
-Flink provides a pluggable interface for users to register their custom logic and enrich failures with extra metadata labels (string key-value pairs).
-This enables users to implement their own failure enrichment plugins to categorize job failures, expose custom metrics, or make calls to external notification systems.
+## 自定义故障丰富器（Failure Enricher）
-FailureEnrichers are triggered every time an exception is reported at runtime by the JobManager.
-Every FailureEnricher may asynchronously return labels associated with the failure that are then exposed via the JobManager's REST API (e.g., a 'type:System' label implying the failure is categorized as a system error).
+Flink 提供了一个可插拔的接口，供用户注册他们自定义的逻辑，并使用额外的元数据标签（字符串类型的 key-value 对）来丰富故障（Failure）信息。
+这使得用户可以实现自定义的故障丰富器插件，对作业故障进行分类、对外暴露自定义指标，或者调用外部通知系统。
+每当 JobManager 在运行时收到异常时，都会触发 FailureEnrichers。
+每个 FailureEnricher 可以异步返回故障对应的标签（labels），这些标签可以通过 JobManager 的 REST API 来查询（例如："type:System" 的标签意味着该故障被分类为系统错误）。
-### Implement a plugin for your custom enricher
+### 实现一个自定义的故障丰富器插件
-To implement a custom FailureEnricher plugin, you need to:
+要实现自定义的 FailureEnricher 插件，需要按照下面的步骤：
-- Add your own FailureEnricher by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricher.java" name="FailureEnricher" >}} interface.
+- 通过实现 FailureEnricher 接口，添加自定义的 FailureEnricher；
-- Add your own FailureEnricherFactory by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricherFactory.java" name="FailureEnricherFactory" >}} interface.
+- 通过实现 FailureEnricherFactory 接口，添加自定义的 FailureEnricherFactory；
Review Comment:
ditto
##########
docs/content.zh/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -21,34 +21,33 @@ specific language governing permissions and limitations
under the License.
-->
-## Custom failure enrichers
-Flink provides a pluggable interface for users to register their custom logic and enrich failures with extra metadata labels (string key-value pairs).
-This enables users to implement their own failure enrichment plugins to categorize job failures, expose custom metrics, or make calls to external notification systems.
+## 自定义故障丰富器（Failure Enricher）
-FailureEnrichers are triggered every time an exception is reported at runtime by the JobManager.
-Every FailureEnricher may asynchronously return labels associated with the failure that are then exposed via the JobManager's REST API (e.g., a 'type:System' label implying the failure is categorized as a system error).
+Flink 提供了一个可插拔的接口，供用户注册他们自定义的逻辑，并使用额外的元数据标签（字符串类型的 key-value 对）来丰富故障（Failure）信息。
+这使得用户可以实现自定义的故障丰富器插件，对作业故障进行分类、对外暴露自定义指标，或者调用外部通知系统。
+每当 JobManager 在运行时收到异常时，都会触发 FailureEnrichers。
+每个 FailureEnricher 可以异步返回故障对应的标签（labels），这些标签可以通过 JobManager 的 REST API 来查询（例如："type:System" 的标签意味着该故障被分类为系统错误）。
-### Implement a plugin for your custom enricher
+### 实现一个自定义的故障丰富器插件
-To implement a custom FailureEnricher plugin, you need to:
+要实现自定义的 FailureEnricher 插件，需要按照下面的步骤：
-- Add your own FailureEnricher by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricher.java" name="FailureEnricher" >}} interface.
+- 通过实现 FailureEnricher 接口，添加自定义的 FailureEnricher；
Review Comment:
Can we keep the source code link here?
##########
docs/content.zh/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -21,34 +21,33 @@ specific language governing permissions and limitations
under the License.
-->
-## Custom failure enrichers
-Flink provides a pluggable interface for users to register their custom logic and enrich failures with extra metadata labels (string key-value pairs).
-This enables users to implement their own failure enrichment plugins to categorize job failures, expose custom metrics, or make calls to external notification systems.
+## 自定义故障丰富器（Failure Enricher）
-FailureEnrichers are triggered every time an exception is reported at runtime by the JobManager.
-Every FailureEnricher may asynchronously return labels associated with the failure that are then exposed via the JobManager's REST API (e.g., a 'type:System' label implying the failure is categorized as a system error).
+Flink 提供了一个可插拔的接口，供用户注册他们自定义的逻辑，并使用额外的元数据标签（字符串类型的 key-value 对）来丰富故障（Failure）信息。
+这使得用户可以实现自定义的故障丰富器插件，对作业故障进行分类、对外暴露自定义指标，或者调用外部通知系统。
+每当 JobManager 在运行时收到异常时，都会触发 FailureEnrichers。
+每个 FailureEnricher 可以异步返回故障对应的标签（labels），这些标签可以通过 JobManager 的 REST API 来查询（例如："type:System" 的标签意味着该故障被分类为系统错误）。
-### Implement a plugin for your custom enricher
+### 实现一个自定义的故障丰富器插件
-To implement a custom FailureEnricher plugin, you need to:
+要实现自定义的 FailureEnricher 插件，需要按照下面的步骤：
-- Add your own FailureEnricher by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricher.java" name="FailureEnricher" >}} interface.
+- 通过实现 FailureEnricher 接口，添加自定义的 FailureEnricher；
-- Add your own FailureEnricherFactory by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricherFactory.java" name="FailureEnricherFactory" >}} interface.
+- 通过实现 FailureEnricherFactory 接口，添加自定义的 FailureEnricherFactory；
-- Add a service entry. Create a file `META-INF/services/org.apache.flink.core.failure.FailureEnricherFactory` which contains the class name of your failure enricher factory class (see [Java Service Loader](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html) docs for more details).
+- 添加一个 Service 入口，创建一个文件 `META-INF/services/org.apache.flink.core.failure.FailureEnricherFactory`，文件中包含自定义 FailureEnricherFactory 的类名（有关详细信息，请参阅 [Java Service Loader](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html) 文档）。
-
-Then, create a jar which includes your `FailureEnricher`, `FailureEnricherFactory`, `META-INF/services/` and all external dependencies.
-Make a directory in `plugins/` of your Flink distribution with an arbitrary name, e.g. "failure-enrichment", and put the jar into this directory.
-See [Flink Plugin]({% link deployment/filesystems/plugins.md %}) for more details.
+然后，创建一个包含 `FailureEnricher`，`FailureEnricherFactory`，`META-INF/services/` 和所有外部依赖项的 jar 文件。
+在 Flink Deploy 目录中的 `plugins/` 目录中创建一个任意名称的目录，例如 "failure-enrichment"，并将 jar 文件放入此目录中。
+使用方式与其它 Plugin 是类似的，有关的详细信息，请参考 [Flink插件]({{< ref "docs/deployment/filesystems/plugins" >}})。
Review Comment:
[Flink插件] -> [Flink Plugins]
I think keep the Flink Plugins in english is fine, like other Chinese documents.
##########
docs/content.zh/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -21,34 +21,33 @@ specific language governing permissions and limitations
under the License.
-->
-## Custom failure enrichers
-Flink provides a pluggable interface for users to register their custom logic and enrich failures with extra metadata labels (string key-value pairs).
-This enables users to implement their own failure enrichment plugins to categorize job failures, expose custom metrics, or make calls to external notification systems.
+## 自定义故障丰富器（Failure Enricher）
-FailureEnrichers are triggered every time an exception is reported at runtime by the JobManager.
-Every FailureEnricher may asynchronously return labels associated with the failure that are then exposed via the JobManager's REST API (e.g., a 'type:System' label implying the failure is categorized as a system error).
+Flink 提供了一个可插拔的接口，供用户注册他们自定义的逻辑，并使用额外的元数据标签（字符串类型的 key-value 对）来丰富故障（Failure）信息。
+这使得用户可以实现自定义的故障丰富器插件，对作业故障进行分类、对外暴露自定义指标，或者调用外部通知系统。
+每当 JobManager 在运行时收到异常时，都会触发 FailureEnrichers。
+每个 FailureEnricher 可以异步返回故障对应的标签（labels），这些标签可以通过 JobManager 的 REST API 来查询（例如："type:System" 的标签意味着该故障被分类为系统错误）。
-### Implement a plugin for your custom enricher
+### 实现一个自定义的故障丰富器插件
-To implement a custom FailureEnricher plugin, you need to:
+要实现自定义的 FailureEnricher 插件，需要按照下面的步骤：
-- Add your own FailureEnricher by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricher.java" name="FailureEnricher" >}} interface.
+- 通过实现 FailureEnricher 接口，添加自定义的 FailureEnricher；
-- Add your own FailureEnricherFactory by implementing the {{< gh_link file="/flink-core/src/main/java/org/apache/flink/core/failure/FailureEnricherFactory.java" name="FailureEnricherFactory" >}} interface.
+- 通过实现 FailureEnricherFactory 接口，添加自定义的 FailureEnricherFactory；
-- Add a service entry. Create a file `META-INF/services/org.apache.flink.core.failure.FailureEnricherFactory` which contains the class name of your failure enricher factory class (see [Java Service Loader](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html) docs for more details).
+- 添加一个 Service 入口，创建一个文件 `META-INF/services/org.apache.flink.core.failure.FailureEnricherFactory`，文件中包含自定义 FailureEnricherFactory 的类名（有关详细信息，请参阅 [Java Service Loader](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ServiceLoader.html) 文档）。
-
-Then, create a jar which includes your `FailureEnricher`, `FailureEnricherFactory`, `META-INF/services/` and all external dependencies.
-Make a directory in `plugins/` of your Flink distribution with an arbitrary name, e.g. "failure-enrichment", and put the jar into this directory.
-See [Flink Plugin]({% link deployment/filesystems/plugins.md %}) for more details.
+然后，创建一个包含 `FailureEnricher`，`FailureEnricherFactory`，`META-INF/services/` 和所有外部依赖项的 jar 文件。
+在 Flink Deploy 目录中的 `plugins/` 目录中创建一个任意名称的目录，例如 "failure-enrichment"，并将 jar 文件放入此目录中。
+使用方式与其它 Plugin 是类似的，有关的详细信息，请参考 [Flink插件]({{< ref "docs/deployment/filesystems/plugins" >}})。
Review Comment:
[Flink插件] -> [Flink Plugins]
I think keep the Flink Plugins in english is fine, like other Chinese documents.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] huwh closed pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "huwh (via GitHub)" <gi...@apache.org>.
huwh closed pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
URL: https://github.com/apache/flink/pull/23399
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] wangzzu commented on pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "wangzzu (via GitHub)" <gi...@apache.org>.
wangzzu commented on PR #23399:
URL: https://github.com/apache/flink/pull/23399#issuecomment-1720436861
@flinkbot run azure
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] wangzzu commented on a diff in pull request #23399: [FLINK-33061][docs] Translate failure-enricher documentation to Chinese
Posted by "wangzzu (via GitHub)" <gi...@apache.org>.
wangzzu commented on code in PR #23399:
URL: https://github.com/apache/flink/pull/23399#discussion_r1324344461
##########
docs/content/docs/deployment/advanced/failure_enrichers.md:
##########
@@ -42,7 +42,7 @@ To implement a custom FailureEnricher plugin, you need to:
Then, create a jar which includes your `FailureEnricher`, `FailureEnricherFactory`, `META-INF/services/` and all external dependencies.
Make a directory in `plugins/` of your Flink distribution with an arbitrary name, e.g. "failure-enrichment", and put the jar into this directory.
-See [Flink Plugin]({% link deployment/filesystems/plugins.md %}) for more details.
+See [Flink Plugin]({{< ref "docs/deployment/filesystems/plugins" >}}) for more details.
Review Comment:
Good advice, here I fixed it
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org