8000 [Doc] Add routine load offset lag metric and configuration doc (backport #59923) by mergify[bot] · Pull Request #59997 · StarRocks/starrocks · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[Doc] Add routine load offset lag metric and configuration doc (backport #59923) #59997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/en/administration/management/FE_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2254,6 +2254,24 @@ Starting from version 3.3.0, the system defaults to refreshing one partition at
- Description: Routine Load job is set to the UNSTABLE state if any task within the Routine Load job lags. To be specific, the difference between the timestamp of the message being consumed and the current time exceeds this threshold, and unconsumed messages exist in the data source.
- Introduced in: -

##### enable_routine_load_lag_metrics

- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to collect Routine Load Kafka partition offset lag metrics. Please note that set this item to `true` will call the Kafka API to get the partition's latest offset.
- Introduced in: -

##### min_routine_load_lag_for_metrics

- Default: 10000
- Type: INT
- Unit: -
- Is mutable: Yes
- Description: The minimum offset lag of Routine Load jobs to be shown in monitoring metrics. Routine Load jobs whose offset lags are greater than this value will be displayed in the metrics.
- Introduced in: -

##### max_tolerable_backend_down_num

- Default: 0
Expand Down
10 changes: 10 additions & 0 deletions docs/en/administration/management/monitoring/metrics.md
< 8000 template class="js-file-alert-template">
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -1668,3 +1668,13 @@ For more information on how to build a monitoring service for your StarRocks clu

- Unit: Count
- Description: The total number of error rows encountered during data loading by all Routine Load jobs.

### starrocks_fe_routine_load_max_lag_of_partition

- Unit: -
- Description: The maximum Kafka partition offset lag for each Routine Load job. It is collected only when the FE configuration `enable_routine_load_lag_metrics` is set to `true` and the offset lag is greater than or equal to the FE configuration `min_routine_load_lag_for_metrics`. By default, `enable_routine_load_lag_metrics` is `false`, and `min_routine_load_lag_for_metrics` is `10000`.

### starrocks_fe_sql_block_hit_count

- Unit: Count
- Description: The number of times blacklisted sql have been intercepted.
18 changes: 18 additions & 0 deletions docs/ja/administration/management/FE_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1566,6 +1566,24 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
- 説明: Routine Load ジョブ内のタスクが遅延すると、Routine Load ジョブは UNSTABLE 状態に設定されます。具体的には、消費されているメッセージのタイムスタンプと現在の時間の差がこのしきい値を超え、データソースに未消費のメッセージが存在する場合です。
- 導入バージョン: -

##### enable_routine_load_lag_metrics

- デフォルト: false
- タイプ: Boolean
- 単位: -
- 変更可能: はい
- 説明: Routine Load パーティションのオフセットラグをメトリクスで収集するかどうか。この項目を `true` に設定すると、Kafka API を呼び出してパーティションの最新のオフセットを取得することに注意。
- 導入バージョン: -

##### min_routine_load_lag_for_metrics

- デフォルト: 10000
- タイプ: Int
- 単位: -
- 変更可能: はい
- 説明: 監視メトリクスに表示される Routine Load ジョブの最小オフセットラグ。オフセットラグがこの値より大きい Routine Load ジョブは、メトリクスに表示されます。
- 導入バージョン: -

##### max_tolerable_backend_down_num

- デフォルト: 0
Expand Down
12 changes: 11 additions & 1 deletion docs/ja/administration/management/monitoring/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -1666,4 +1666,14 @@ StarRocks クラスタのモニタリングサービスの構築方法につい
### starrocks_fe_routine_load_error_rows

- 単位: Count
- 説明: すべての Routine Load ジョブによるデータロード中に発生したエラーロウの総数。
- 説明: すべての Routine Load ジョブによるデータロード中に発生したエラーロウの総数。

### starrocks_fe_routine_load_max_lag_of_partition

- 単位: -
- 説明: 各 Routine Load ジョブにおける Kafka パーティションの最大オフセットラグ。これは、FEの設定項目 `enable_routine_load_lag_metrics` が `true` に設定され、かつオフセットラグが FE の設定項目 `min_routine_load_lag_for_metrics` 以上である場合にのみ収集されます。デフォルトでは、`enable_routine_load_lag_metrics` は `false` に設定されており、`min_routine_load_lag_for_metrics` は `10000` に設定されています。

### starrocks_fe_sql_block_hit_count

- 単位: Count
- 説明: ブラックリストに登録された SQL がインターセプトされた回数。
18 changes: 18 additions & 0 deletions docs/zh/administration/management/FE_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2246,6 +2246,24 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
- 描述:Routine Load 导入作业的任一导入任务消费延迟,即正在消费的消息时间戳与当前时间的差值超过该阈值,且数据源中存在未被消费的消息,则导入作业置为 UNSTABLE 状态。
- 引入版本:-

##### enable_routine_load_lag_metrics

- 默认值:false
- 类型:Boolean
- 单位:-
- 是否动态:是
- 描述:是否收集 Routine Load Partition Offset Lag 的指标。请注意,将此项目设置为 `true` 会调用 Kafka API 来获取 Partition 的最新 Offset。
- 引入版本:-

##### min_routine_load_lag_for_metrics

- 默认值:10000
- 类型:Int
- 单位:-
- 是否动态:是
- 描述:要在监控指标中显示的 Routine Load 任务的最小 Offset Lag。Offset Lag 大于此值的 Routine Load 任务将显示在指标中。
- 引入版本:-

##### max_tolerable_backend_down_num

- 默认值:0
Expand Down
10 changes: 10 additions & 0 deletions docs/zh/administration/management/monitoring/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -1667,3 +1667,13 @@ displayed_sidebar: docs

- 单位:个
- 描述:所有 Routine Load 作业导入错误数据的总行数。

### starrocks_fe_routine_load_max_lag_of_partition

- 单位:-
- 描述:每个 Routine Load 作业最大的 Kafka Partition Offset Lag。只有当 FE 配置 `enable_routine_load_lag_metrics` 为 `true` 并且 Offset Lag 大于等于 FE 配置 `min_routine_load_lag_for_metrics` 时才会收集。`enable_routine_load_lag_metrics` 默认为 `false`,`min_routine_load_lag_for_metrics` 默认为 `10000`。

### starrocks_fe_sql_block_hit_count

- 单位:个
- 描述: 黑名单 SQL 被拦截的次数。
Loading
0