e-mhui commented on code in PR #786:
URL: https://github.com/apache/inlong-website/pull/786#discussion_r1244679326
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/load_node/elasticsearch.md:
##########
@@ -74,186 +74,28 @@ TODO: 将在未来支持这个特性。
## Elasticsearch Load 节点参数
-<table class="table table-bordered">
- <thead>
- <tr>
- <th class="text-left" style={{width: '25%'}}>参数</th>
- <th class="text-center" style={{width: '8%'}}>是否必选</th>
- <th class="text-center" style={{width: '7%'}}>默认值</th>
- <th class="text-center" style={{width: '10%'}}>数据类型</th>
- <th class="text-center" style={{width: '50%'}}>描述</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><h5>connector</h5></td>
- <td>必选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>指定要使用的连接器，有效值为：
- <ul>
- <li><code>elasticsearch-6</code>：连接到 Elasticsearch 5.x and 6.x 的集群。</li>
- <li><code>elasticsearch-7</code>：连接到 Elasticsearch 7.x 及更高版本的集群。</li>
- </ul></td>
- </tr>
- <tr>
- <td><h5>hosts</h5></td>
- <td>必选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>要连接到的一台或多台 Elasticsearch 主机，例如
<code>'http://host_name:9092;http://host_name:9093'</code>。</td>
- </tr>
- <tr>
- <td><h5>index</h5></td>
- <td>必选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Elasticsearch 中每条记录的索引。可以是一个静态索引（例如
<code>'myIndex'</code>）或一个动态索引（例如 <code>'index-{'{log_ts|yyyy-MM-dd}'}'</code>）。
- 更多详细信息，请参见下面的<a href="#dymic-index">动态索引</a>部分。</td>
- </tr>
- <tr>
- <td><h5>document-type</h5></td>
- <td>6.x 版本中必选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Elasticsearch 文档类型。在 <code>elasticsearch-7</code> 中不再需要。</td>
- </tr>
- <tr>
- <td><h5>document-id.key-delimiter</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>_</td>
- <td>String</td>
- <td>复合键的分隔符（默认为"_"），例如，指定为"$"将导致文档 ID 为"KEY1$KEY2$KEY3"。</td>
- </tr>
- <tr>
- <td><h5>username</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>用于连接 Elasticsearch 实例的用户名。请注意，Elasticsearch 没有预绑定安全特性，但你可以通过如下<a
href="https://www.elastic.co/guide/en/elasticsearch/reference/master/configuring-security.html";>指南</a>启用它来保护
Elasticsearch 集群。</td>
- </tr>
- <tr>
- <td><h5>password</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>用于连接 Elasticsearch
实例的密码。如果配置了<code>username</code>，则此选项也必须配置为非空字符串。</td>
- </tr>
- <tr>
- <td><h5>failure-handler</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>fail</td>
- <td>String</td>
- <td>对 Elasticsearch 请求失败情况下的失败处理策略。有效策略为：
- <ul>
- <li><code>fail</code>：如果请求失败并因此导致作业失败，则抛出异常。</li>
- <li><code>ignore</code>：忽略失败并放弃请求。</li>
- <li><code>retry-rejected</code>：重新添加由于队列容量饱和而失败的请求。</li>
- <li>自定义类名称：使用 ActionRequestFailureHandler 的子类进行失败处理。</li>
- </ul>
- </td>
- </tr>
- <tr>
- <td><h5>sink.flush-on-checkpoint</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>true</td>
- <td>Boolean</td>
- <td>是否在 checkpoint 时执行 flush。禁用后，在 checkpoint 时 sink 将不会等待所有的 pending
请求被 Elasticsearch 确认。因此，sink 不会为请求的 at-least-once 交付提供任何有力保证。
- </td>
- </tr>
- <tr>
- <td><h5>sink.bulk-flush.max-actions</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>1000</td>
- <td>Integer</td>
- <td>每个批量请求的最大缓冲操作数。
- 可以设置为<code>'0'</code>来禁用它。
- </td>
- </tr>
- <tr>
- <td><h5>sink.bulk-flush.max-size</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>2mb</td>
- <td>MemorySize</td>
- <td>每个批量请求的缓冲操作在内存中的最大值。单位必须为 MB。
- 可以设置为<code>'0'</code>来禁用它。
- </td>
- </tr>
- <tr>
- <td><h5>sink.bulk-flush.interval</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>1s</td>
- <td>Duration</td>
- <td>flush 缓冲操作的间隔。
-
可以设置为<code>'0'</code>来禁用它。注意，<code>'sink.bulk-flush.max-size'</code>和<code>'sink.bulk-flush.max-actions'</code>都设置为<code>'0'</code>的这种
flush 间隔设置允许对缓冲操作进行完全异步处理。
- </td>
- </tr>
- <tr>
- <td><h5>sink.bulk-flush.backoff.strategy</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>DISABLED</td>
- <td>String</td>
- <td>指定在由于临时请求错误导致任何 flush 操作失败时如何执行重试。有效策略为：
- <ul>
- <li><code>DISABLED</code>：不执行重试，即第一次请求错误后失败。</li>
- <li><code>CONSTANT</code>：等待重试之间的回退延迟。</li>
- <li><code>EXPONENTIAL</code>：先等待回退延迟，然后在重试之间指数递增。</li>
- </ul>
- </td>
- </tr>
- <tr>
- <td><h5>sink.bulk-flush.backoff.max-retries</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>8</td>
- <td>Integer</td>
- <td>最大回退重试次数。</td>
- </tr>
- <tr>
- <td><h5>sink.bulk-flush.backoff.delay</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>50ms</td>
- <td>Duration</td>
- <td>每次回退尝试之间的延迟。对于 <code>CONSTANT</code> 回退策略，该值是每次重试之间的延迟。对于
<code>EXPONENTIAL</code> 回退策略，该值是初始的延迟。</td>
- </tr>
- <tr>
- <td><h5>connection.max-retry-timeout</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>Duration</td>
- <td>最大重试超时时间。</td>
- </tr>
- <tr>
- <td><h5>connection.path-prefix</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>添加到每个 REST 通信中的前缀字符串，例如，<code>'/v1'</code>。</td>
- </tr>
- <tr>
- <td><h5>routing.filed-name</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>使用 field 值来生成该 field 的动态路由</td>
- </tr>
- <tr>
- <td><h5>format</h5></td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>json</td>
- <td>String</td>
- <td>Elasticsearch 连接器支持指定格式。该格式必须生成一个有效的 json 文档。
- 默认使用内置的 <code>'json'</code> 格式。更多详细信息，请参阅 <a
href="https://nightlies.apache.org/flink/flink-docs-release-1.13/zh/docs/connectors/table/formats/overview/";>JSON
Format</a> 页面。
- </td>
- </tr>
- <tr>
- <td>inlong.metric.labels</td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>inlong metric
的标签值，该值的构成为groupId=[groupId]&streamId=[streamId]&nodeId=[nodeId]。</td>
- </tr>
- </tbody>
-</table>
+| 参数 | 是否必选 | 默认值 | 数据类型 | 描述 |
+| --- | --- | --- | --- | --- |
+| connector | 必选 | (none) | String | 指定要使用的连接器，有效值为：<br/><br/>-
`elasticsearch-6`：连接到 Elasticsearch 5.x and 6.x 的集群。<br/>-
`elasticsearch-7`：连接到 Elasticsearch 7.x 及更高版本的集群。 |
+| hosts | 必选 | (none) | String | 要连接到的一台或多台 Elasticsearch 主机，例如
`'http://host_name:9092;http://host_name:9093'`。 |
+| index | 必选 | (none) | String | Elasticsearch 中每条记录的索引。可以是一个静态索引（例如
`'myIndex'`）或一个动态索引（例如 `'index-{log_ts\|yyyy-MM-dd}'`）。
更多详细信息，请参见下面的[动态索引](#动态索引)部分。 |
+| document-type | 6.x 版本中必选 | (none) | String | Elasticsearch 文档类型。在
`elasticsearch-7` 中不再需要。 |
+| document-id.key-delimiter | 可选 | _ | String |
复合键的分隔符（默认为"_"），例如，指定为"$"将导致文档 ID 为"KEY1\$KEY2\$KEY3"。 |
+| username | 可选 | (none) | String | 用于连接 Elasticsearch
实例的用户名。请注意，Elasticsearch
没有预绑定安全特性，但你可以通过如下[指南](https://www.elastic.co/guide/en/elasticsearch/reference/master/configuring-security.html)启用它来保护
Elasticsearch 集群。 |
+| password | 可选 | (none) | String | 用于连接 Elasticsearch
实例的密码。如果配置了`username`，则此选项也必须配置为非空字符串。 |
+| failure-handler | 可选 | fail | String | 对 Elasticsearch
请求失败情况下的失败处理策略。有效策略为：<br/><br/>- `fail`：如果请求失败并因此导致作业失败，则抛出异常。<br/>-
`ignore`：忽略失败并放弃请求。<br/>- `retry-rejected`：重新添加由于队列容量饱和而失败的请求。<br/>- 自定义类名称：使用
ActionRequestFailureHandler 的子类进行失败处理。 |
+| sink.flush-on-checkpoint | 可选 | true | Boolean | 是否在 checkpoint 时执行
flush。禁用后，在 checkpoint 时 sink 将不会等待所有的 pending 请求被 Elasticsearch 确认。因此，sink
不会为请求的 at-least-once 交付提供任何有力保证。 |
+| sink.bulk-flush.max-actions | 可选 | 1000 | Integer | 每个批量请求的最大缓冲操作数。
可以设置为`'0'`来禁用它。 |
+| sink.bulk-flush.max-size | 可选 | 2mb | MemorySize |
每个批量请求的缓冲操作在内存中的最大值。单位必须为 MB。 可以设置为`'0'`来禁用它。 |
+| sink.bulk-flush.interval | 可选 | 1s | Duration | flush 缓冲操作的间隔。
可以设置为`'0'`来禁用它。注意，`'sink.bulk-flush.max-size'`和`'sink.bulk-flush.max-actions'`都设置为`'0'`的这种
flush 间隔设置允许对缓冲操作进行完全异步处理。 |
+| sink.bulk-flush.backoff.strategy | 可选 | DISABLED | String |
指定在由于临时请求错误导致任何 flush 操作失败时如何执行重试。有效策略为：<br/><br/>-
`DISABLED`：不执行重试，即第一次请求错误后失败。<br/>- `CONSTANT`：等待重试之间的回退延迟。<br/>-
`EXPONENTIAL`：先等待回退延迟，然后在重试之间指数递增。 |
+| sink.bulk-flush.backoff.max-retries | 可选 | 8 | Integer | 最大回退重试次数。 |
+| sink.bulk-flush.backoff.delay | 可选 | 50ms | Duration | 每次回退尝试之间的延迟。对于
`CONSTANT` 回退策略，该值是每次重试之间的延迟。对于 `EXPONENTIAL` 回退策略，该值是初始的延迟。 |
+| connection.max-retry-timeout | 可选 | (none) | Duration | 最大重试超时时间。 |
+| connection.path-prefix | 可选 | (none) | String | 添加到每个 REST
通信中的前缀字符串，例如，`'/v1'`。 |
+| routing.filed-name | 可选 | (none) | String | 使用 field 值来生成该 field 的动态路由 |
+| format | 可选 | json | String | Elasticsearch 连接器支持指定格式。该格式必须生成一个有效的 json
文档。 默认使用内置的 `'json'` 格式。更多详细信息，请参阅 [JSON
Format](https://nightlies.apache.org/flink/flink-docs-release-1.13/zh/docs/connectors/table/formats/overview/)
页面。 |
+| inlong.metric.labels | 可选 | (none) | String | inlong metric
的标签值，该值的构成为groupId=[groupId]&streamId=[streamId]&nodeId=[nodeId]。 |
Review Comment:
Done.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
