From c1e8df48d4d74cdf8898eec0c0eb53dab39e56fd Mon Sep 17 00:00:00 2001 From: "Lei, HUANG" Date: Tue, 30 Jun 2026 15:09:58 +0800 Subject: [PATCH 1/4] Docs: add webhook triggers documentation and cross-references Introduce a new documentation page for the enterprise webhook trigger feature, which monitors cluster resource usage metrics and sends HTTP notifications when configured thresholds are crossed. Covers configuration, payload schema, and behavioral notes on firing/resolved alert cycles. Also update the console-ui overview pages (English and Chinese, current and versioned 1.1) to cross-reference the new page, and register the corresponding sidebar entry. Affected files: - docs/enterprise/console-ui/webhook-triggers.md - versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md - i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md - i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md - docs/enterprise/console-ui.md - versioned_docs/version-1.1/enterprise/console-ui.md - i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md - i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md - sidebars.ts Signed-off-by: Lei Mao Signed-off-by: Lei, HUANG --- docs/enterprise/console-ui.md | 2 +- .../enterprise/console-ui/webhook-triggers.md | 85 +++++++++++++++++++ .../current/enterprise/console-ui.md | 2 +- .../enterprise/console-ui/webhook-triggers.md | 85 +++++++++++++++++++ .../version-1.1/enterprise/console-ui.md | 2 +- .../enterprise/console-ui/webhook-triggers.md | 85 +++++++++++++++++++ sidebars.ts | 1 + .../version-1.1/enterprise/console-ui.md | 2 +- .../enterprise/console-ui/webhook-triggers.md | 85 +++++++++++++++++++ 9 files changed, 345 insertions(+), 4 deletions(-) create mode 100644 docs/enterprise/console-ui/webhook-triggers.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md create mode 100644 versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md diff --git a/docs/enterprise/console-ui.md b/docs/enterprise/console-ui.md index 480a940ec..db03f08b0 100644 --- a/docs/enterprise/console-ui.md +++ b/docs/enterprise/console-ui.md @@ -90,4 +90,4 @@ The **Metrics** page shows cluster operational metrics in a single built-in moni ### CPU and Memory Profiling -The sidebar provides **Memory Profile** and **CPU Profile** entries for continuous profiling of GreptimeDB components. For configuration and usage, see [Continuous Profiling](./console-ui/continuous-profiling.md). +The sidebar provides **Memory Profile** and **CPU Profile** entries for continuous profiling of GreptimeDB components. For configuration and usage, see [Continuous Profiling](./console-ui/continuous-profiling.md). The enterprise dashboard also supports [Webhook Triggers](./console-ui/webhook-triggers.md) for sending notifications based on cluster resource usage metrics. diff --git a/docs/enterprise/console-ui/webhook-triggers.md b/docs/enterprise/console-ui/webhook-triggers.md new file mode 100644 index 000000000..60212e003 --- /dev/null +++ b/docs/enterprise/console-ui/webhook-triggers.md @@ -0,0 +1,85 @@ +--- +keywords: [enterprise, management console, webhook triggers, resource usage, alerting, CPU, memory] +description: Configure enterprise dashboard webhook triggers to send notifications based on GreptimeDB cluster resource usage metrics. +--- + +# Webhook Triggers + +Webhook triggers monitor cluster resource usage metrics and send HTTP notifications when a configured threshold is reached. This is an enterprise-only feature and is available only when the enterprise dashboard is deployed. + +Configure webhook triggers per provisioned instance under `settings.monitoring.webhook_triggers` in the dashboard apiserver configuration. Enabled webhook triggers require a metrics source, either `settings.monitoring.greptimedb.url` or `settings.monitoring.metrics.prometheus`. + +```yaml +provisionedInstances: + - name: mycluster + settings: + monitoring: + greptimedb: + url: http://monitoring-greptimedb:4000 + # Or use a Prometheus-compatible metrics source: + # metrics: + # prometheus: http://prometheus:9090 + webhook_triggers: + - name: high-datanode-memory + enabled: true + roles: [datanode] + metric: memory_usage_percent + operator: ">=" + threshold: 90 + cooldown_seconds: 300 + url: https://alerts.example.com/datanode-memory + headers: + Authorization: Bearer token + - name: high-frontend-cpu + enabled: true + roles: [frontend] + metric: cpu_usage_millicores + threshold: 1000 + cooldown_seconds: 600 + url: https://alerts.example.com/frontend-cpu +``` + +Webhook trigger configuration items: + +- `name`: Trigger name. Required when `enabled` is `true`. The name must be unique within the instance and must not contain `/`. +- `enabled`: Enables or disables the trigger. +- `roles`: Optional role filter. Omit it or leave it empty to match all roles. Supported roles are `frontend`, `metasrv`, `datanode`, and `flownode`. +- `metric`: Resource usage metric to evaluate. Supported metrics are `memory_usage_percent`, `memory_usage_bytes`, `cpu_usage_percent`, and `cpu_usage_millicores`. +- `operator`: Comparison operator. The default and only supported value is `>=`. +- `threshold`: Threshold value. It must be greater than `0`. Percentage metrics must be less than or equal to `100`. +- `cooldown_seconds`: Minimum interval between repeated `firing` notifications for the same active alert. The default is `300` seconds. +- `url`: Webhook endpoint. Required when `enabled` is `true`; the URL must use `http://` or `https://`. +- `headers`: Optional custom HTTP headers, for example `Authorization`. The webhook client always sends `Content-Type: application/json`. + +When a matching component crosses the threshold, the dashboard apiserver sends a `firing` payload. While the alert remains active, repeated `firing` payloads for the same instance, trigger, pod, and process start time are suppressed until `cooldown_seconds` elapses. When the metric drops below the threshold, the dashboard apiserver sends a `resolved` payload. + +Webhook payloads use a fixed JSON schema and cannot be templated. A representative `firing` payload looks like this: + +```json +{ + "status": "firing", + "trigger_name": "high-datanode-memory", + "metric": "memory_usage_percent", + "operator": ">=", + "threshold": 90, + "value": 91.2, + "instance": "ns_demo", + "cluster": "demo", + "namespace": "ns", + "pod": "demo-datanode-0", + "role": "datanode", + "app": "greptime-datanode", + "component_instance": "datanode-0", + "endpoint": "http://demo-datanode-0:4000", + "process_start_time_seconds": 1760000000, + "starts_at": "2026-06-23T10:00:00Z", + "ends_at": null, + "sent_at": "2026-06-23T10:00:00Z" +} +``` + +For `resolved` payloads, `status` is `resolved`, `value` is the below-threshold value that resolved the alert, and `ends_at` is set. + +:::note +Webhook trigger state is kept in dashboard apiserver memory and is not durable. There is no durable retry queue. If the dashboard apiserver restarts, or if an instance, trigger, or pod series disappears, the corresponding state may be forgotten without sending `resolved`. Receivers that need hard guarantees should expire alerts on their side. +::: diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md index 1801714bf..67c3550cb 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md @@ -90,4 +90,4 @@ GreptimeDB 企业版管理控制台在开源 [GreptimeDB 控制台](/getting-sta ### CPU and Memory Profiling -侧边栏提供 **Memory Profile** 与 **CPU Profile** 入口，用于对 GreptimeDB 组件做持续性能剖析。配置与使用见[持续性能剖析](./console-ui/continuous-profiling.md)。 +侧边栏提供 **Memory Profile** 与 **CPU Profile** 入口，用于对 GreptimeDB 组件做持续性能剖析。配置与使用见[持续性能剖析](./console-ui/continuous-profiling.md)。企业版 dashboard 还支持 [Webhook 触发器](./console-ui/webhook-triggers.md)，可基于集群资源使用指标发送通知。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md new file mode 100644 index 000000000..3a2480c47 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md @@ -0,0 +1,85 @@ +--- +keywords: [企业版, 管理控制台, Webhook 触发器, 资源使用, 告警, CPU, 内存] +description: 在企业版 dashboard 中配置 webhook 触发器，基于 GreptimeDB 集群资源使用指标发送通知。 +--- + +# Webhook 触发器 + +Webhook 触发器会监控集群资源使用指标，并在达到配置阈值时发送 HTTP 通知。该功能仅属于企业版，并且只有在部署企业版 dashboard 时可用。 + +在 dashboard apiserver 配置中，按 provisioned instance 将 webhook 触发器配置到 `settings.monitoring.webhook_triggers` 下。启用 webhook 触发器需要配置指标数据源，即 `settings.monitoring.greptimedb.url` 或 `settings.monitoring.metrics.prometheus`。 + +```yaml +provisionedInstances: + - name: mycluster + settings: + monitoring: + greptimedb: + url: http://monitoring-greptimedb:4000 + # 也可以使用 Prometheus 兼容的指标数据源： + # metrics: + # prometheus: http://prometheus:9090 + webhook_triggers: + - name: high-datanode-memory + enabled: true + roles: [datanode] + metric: memory_usage_percent + operator: ">=" + threshold: 90 + cooldown_seconds: 300 + url: https://alerts.example.com/datanode-memory + headers: + Authorization: Bearer token + - name: high-frontend-cpu + enabled: true + roles: [frontend] + metric: cpu_usage_millicores + threshold: 1000 + cooldown_seconds: 600 + url: https://alerts.example.com/frontend-cpu +``` + +Webhook 触发器配置项： + +- `name`：触发器名称。`enabled` 为 `true` 时必填。同一个 instance 内名称必须唯一，且不能包含 `/`。 +- `enabled`：启用或禁用该触发器。 +- `roles`：可选的角色过滤器。省略或留空表示匹配所有角色。支持的角色包括 `frontend`、`metasrv`、`datanode` 和 `flownode`。 +- `metric`：要检查的资源使用指标。支持 `memory_usage_percent`、`memory_usage_bytes`、`cpu_usage_percent` 和 `cpu_usage_millicores`。 +- `operator`：比较运算符。默认值和当前唯一支持的值都是 `>=`。 +- `threshold`：阈值，必须大于 `0`。百分比指标的阈值必须小于或等于 `100`。 +- `cooldown_seconds`：同一活跃告警重复发送 `firing` 通知的最小间隔，默认值为 `300` 秒。 +- `url`：Webhook 端点。`enabled` 为 `true` 时必填，并且必须使用 `http://` 或 `https://`。 +- `headers`：可选的自定义 HTTP header，例如 `Authorization`。Webhook 客户端总是会发送 `Content-Type: application/json`。 + +当匹配的组件指标越过阈值时，dashboard apiserver 会发送 `firing` payload。告警保持活跃期间，同一 instance、trigger、pod 和进程启动时间对应的重复 `firing` payload 会被抑制，直到超过 `cooldown_seconds`。当指标降到阈值以下时，dashboard apiserver 会发送 `resolved` payload。 + +Webhook payload 使用固定 JSON 结构，暂不支持自定义模板。下面是一个代表性的 `firing` payload： + +```json +{ + "status": "firing", + "trigger_name": "high-datanode-memory", + "metric": "memory_usage_percent", + "operator": ">=", + "threshold": 90, + "value": 91.2, + "instance": "ns_demo", + "cluster": "demo", + "namespace": "ns", + "pod": "demo-datanode-0", + "role": "datanode", + "app": "greptime-datanode", + "component_instance": "datanode-0", + "endpoint": "http://demo-datanode-0:4000", + "process_start_time_seconds": 1760000000, + "starts_at": "2026-06-23T10:00:00Z", + "ends_at": null, + "sent_at": "2026-06-23T10:00:00Z" +} +``` + +对于 `resolved` payload，`status` 为 `resolved`，`value` 是使告警恢复的低于阈值的指标值，并且会设置 `ends_at`。 + +:::note +Webhook 触发器状态保存在 dashboard apiserver 内存中，不具备持久性，也没有持久化重试队列。如果 dashboard apiserver 重启，或者 instance、trigger、pod 指标序列消失，对应状态可能会被遗忘且不会发送 `resolved`。需要强保证的接收端应自行设置告警过期机制。 +::: diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md index 10e2dce34..2db982357 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md @@ -59,4 +59,4 @@ GreptimeDB 企业版管理控制台是标准 GreptimeDB 仪表板的增强版本 ## 持续性能剖析 -管理控制台支持[持续性能剖析](./continuous-profiling)，可用于采集和分析 GreptimeDB 组件的 CPU 与内存 Profile。 +管理控制台支持[持续性能剖析](./continuous-profiling)，可用于采集和分析 GreptimeDB 组件的 CPU 与内存 Profile。同时也支持 [Webhook 触发器](./console-ui/webhook-triggers.md)，可基于集群资源使用指标发送通知。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md new file mode 100644 index 000000000..3a2480c47 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md @@ -0,0 +1,85 @@ +--- +keywords: [企业版, 管理控制台, Webhook 触发器, 资源使用, 告警, CPU, 内存] +description: 在企业版 dashboard 中配置 webhook 触发器，基于 GreptimeDB 集群资源使用指标发送通知。 +--- + +# Webhook 触发器 + +Webhook 触发器会监控集群资源使用指标，并在达到配置阈值时发送 HTTP 通知。该功能仅属于企业版，并且只有在部署企业版 dashboard 时可用。 + +在 dashboard apiserver 配置中，按 provisioned instance 将 webhook 触发器配置到 `settings.monitoring.webhook_triggers` 下。启用 webhook 触发器需要配置指标数据源，即 `settings.monitoring.greptimedb.url` 或 `settings.monitoring.metrics.prometheus`。 + +```yaml +provisionedInstances: + - name: mycluster + settings: + monitoring: + greptimedb: + url: http://monitoring-greptimedb:4000 + # 也可以使用 Prometheus 兼容的指标数据源： + # metrics: + # prometheus: http://prometheus:9090 + webhook_triggers: + - name: high-datanode-memory + enabled: true + roles: [datanode] + metric: memory_usage_percent + operator: ">=" + threshold: 90 + cooldown_seconds: 300 + url: https://alerts.example.com/datanode-memory + headers: + Authorization: Bearer token + - name: high-frontend-cpu + enabled: true + roles: [frontend] + metric: cpu_usage_millicores + threshold: 1000 + cooldown_seconds: 600 + url: https://alerts.example.com/frontend-cpu +``` + +Webhook 触发器配置项： + +- `name`：触发器名称。`enabled` 为 `true` 时必填。同一个 instance 内名称必须唯一，且不能包含 `/`。 +- `enabled`：启用或禁用该触发器。 +- `roles`：可选的角色过滤器。省略或留空表示匹配所有角色。支持的角色包括 `frontend`、`metasrv`、`datanode` 和 `flownode`。 +- `metric`：要检查的资源使用指标。支持 `memory_usage_percent`、`memory_usage_bytes`、`cpu_usage_percent` 和 `cpu_usage_millicores`。 +- `operator`：比较运算符。默认值和当前唯一支持的值都是 `>=`。 +- `threshold`：阈值，必须大于 `0`。百分比指标的阈值必须小于或等于 `100`。 +- `cooldown_seconds`：同一活跃告警重复发送 `firing` 通知的最小间隔，默认值为 `300` 秒。 +- `url`：Webhook 端点。`enabled` 为 `true` 时必填，并且必须使用 `http://` 或 `https://`。 +- `headers`：可选的自定义 HTTP header，例如 `Authorization`。Webhook 客户端总是会发送 `Content-Type: application/json`。 + +当匹配的组件指标越过阈值时，dashboard apiserver 会发送 `firing` payload。告警保持活跃期间，同一 instance、trigger、pod 和进程启动时间对应的重复 `firing` payload 会被抑制，直到超过 `cooldown_seconds`。当指标降到阈值以下时，dashboard apiserver 会发送 `resolved` payload。 + +Webhook payload 使用固定 JSON 结构，暂不支持自定义模板。下面是一个代表性的 `firing` payload： + +```json +{ + "status": "firing", + "trigger_name": "high-datanode-memory", + "metric": "memory_usage_percent", + "operator": ">=", + "threshold": 90, + "value": 91.2, + "instance": "ns_demo", + "cluster": "demo", + "namespace": "ns", + "pod": "demo-datanode-0", + "role": "datanode", + "app": "greptime-datanode", + "component_instance": "datanode-0", + "endpoint": "http://demo-datanode-0:4000", + "process_start_time_seconds": 1760000000, + "starts_at": "2026-06-23T10:00:00Z", + "ends_at": null, + "sent_at": "2026-06-23T10:00:00Z" +} +``` + +对于 `resolved` payload，`status` 为 `resolved`，`value` 是使告警恢复的低于阈值的指标值，并且会设置 `ends_at`。 + +:::note +Webhook 触发器状态保存在 dashboard apiserver 内存中，不具备持久性，也没有持久化重试队列。如果 dashboard apiserver 重启，或者 instance、trigger、pod 指标序列消失，对应状态可能会被遗忘且不会发送 `resolved`。需要强保证的接收端应自行设置告警过期机制。 +::: diff --git a/sidebars.ts b/sidebars.ts index 5a305b992..beca2a627 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -506,6 +506,7 @@ const sidebars: SidebarsConfig = { items: [ 'enterprise/console-ui', 'enterprise/console-ui/continuous-profiling', + 'enterprise/console-ui/webhook-triggers', ], }, { diff --git a/versioned_docs/version-1.1/enterprise/console-ui.md b/versioned_docs/version-1.1/enterprise/console-ui.md index 89b32e740..271699053 100644 --- a/versioned_docs/version-1.1/enterprise/console-ui.md +++ b/versioned_docs/version-1.1/enterprise/console-ui.md @@ -59,4 +59,4 @@ Displays long-running SQL and PromQL queries with detailed execution time and qu ## Continuous Profiling -The Management Console supports [Continuous Profiling](./continuous-profiling) for capturing and analyzing GreptimeDB component CPU and memory profiles. +The Management Console supports [Continuous Profiling](./continuous-profiling) for capturing and analyzing GreptimeDB component CPU and memory profiles. It also supports [Webhook Triggers](./console-ui/webhook-triggers.md) for sending notifications based on cluster resource usage metrics. diff --git a/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md b/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md new file mode 100644 index 000000000..60212e003 --- /dev/null +++ b/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md @@ -0,0 +1,85 @@ +--- +keywords: [enterprise, management console, webhook triggers, resource usage, alerting, CPU, memory] +description: Configure enterprise dashboard webhook triggers to send notifications based on GreptimeDB cluster resource usage metrics. +--- + +# Webhook Triggers + +Webhook triggers monitor cluster resource usage metrics and send HTTP notifications when a configured threshold is reached. This is an enterprise-only feature and is available only when the enterprise dashboard is deployed. + +Configure webhook triggers per provisioned instance under `settings.monitoring.webhook_triggers` in the dashboard apiserver configuration. Enabled webhook triggers require a metrics source, either `settings.monitoring.greptimedb.url` or `settings.monitoring.metrics.prometheus`. + +```yaml +provisionedInstances: + - name: mycluster + settings: + monitoring: + greptimedb: + url: http://monitoring-greptimedb:4000 + # Or use a Prometheus-compatible metrics source: + # metrics: + # prometheus: http://prometheus:9090 + webhook_triggers: + - name: high-datanode-memory + enabled: true + roles: [datanode] + metric: memory_usage_percent + operator: ">=" + threshold: 90 + cooldown_seconds: 300 + url: https://alerts.example.com/datanode-memory + headers: + Authorization: Bearer token + - name: high-frontend-cpu + enabled: true + roles: [frontend] + metric: cpu_usage_millicores + threshold: 1000 + cooldown_seconds: 600 + url: https://alerts.example.com/frontend-cpu +``` + +Webhook trigger configuration items: + +- `name`: Trigger name. Required when `enabled` is `true`. The name must be unique within the instance and must not contain `/`. +- `enabled`: Enables or disables the trigger. +- `roles`: Optional role filter. Omit it or leave it empty to match all roles. Supported roles are `frontend`, `metasrv`, `datanode`, and `flownode`. +- `metric`: Resource usage metric to evaluate. Supported metrics are `memory_usage_percent`, `memory_usage_bytes`, `cpu_usage_percent`, and `cpu_usage_millicores`. +- `operator`: Comparison operator. The default and only supported value is `>=`. +- `threshold`: Threshold value. It must be greater than `0`. Percentage metrics must be less than or equal to `100`. +- `cooldown_seconds`: Minimum interval between repeated `firing` notifications for the same active alert. The default is `300` seconds. +- `url`: Webhook endpoint. Required when `enabled` is `true`; the URL must use `http://` or `https://`. +- `headers`: Optional custom HTTP headers, for example `Authorization`. The webhook client always sends `Content-Type: application/json`. + +When a matching component crosses the threshold, the dashboard apiserver sends a `firing` payload. While the alert remains active, repeated `firing` payloads for the same instance, trigger, pod, and process start time are suppressed until `cooldown_seconds` elapses. When the metric drops below the threshold, the dashboard apiserver sends a `resolved` payload. + +Webhook payloads use a fixed JSON schema and cannot be templated. A representative `firing` payload looks like this: + +```json +{ + "status": "firing", + "trigger_name": "high-datanode-memory", + "metric": "memory_usage_percent", + "operator": ">=", + "threshold": 90, + "value": 91.2, + "instance": "ns_demo", + "cluster": "demo", + "namespace": "ns", + "pod": "demo-datanode-0", + "role": "datanode", + "app": "greptime-datanode", + "component_instance": "datanode-0", + "endpoint": "http://demo-datanode-0:4000", + "process_start_time_seconds": 1760000000, + "starts_at": "2026-06-23T10:00:00Z", + "ends_at": null, + "sent_at": "2026-06-23T10:00:00Z" +} +``` + +For `resolved` payloads, `status` is `resolved`, `value` is the below-threshold value that resolved the alert, and `ends_at` is set. + +:::note +Webhook trigger state is kept in dashboard apiserver memory and is not durable. There is no durable retry queue. If the dashboard apiserver restarts, or if an instance, trigger, or pod series disappears, the corresponding state may be forgotten without sending `resolved`. Receivers that need hard guarantees should expire alerts on their side. +::: From aa64a6760f2b9f8437c9d07eac434d6283498027 Mon Sep 17 00:00:00 2001 From: "Lei, HUANG" Date: Tue, 30 Jun 2026 15:15:32 +0800 Subject: [PATCH 2/4] Document webhook triggers require dashboard v0.2.0-alpha.10 or later The webhook triggers feature requires the enterprise dashboard to be deployed at version `v0.2.0-alpha.10` or later. Updated files: - `docs/enterprise/console-ui/webhook-triggers.md` - `i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md` - `i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md` - `versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md` Signed-off-by: Lei, HUANG --- docs/enterprise/console-ui/webhook-triggers.md | 2 +- .../current/enterprise/console-ui/webhook-triggers.md | 2 +- .../version-1.1/enterprise/console-ui/webhook-triggers.md | 2 +- .../version-1.1/enterprise/console-ui/webhook-triggers.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/enterprise/console-ui/webhook-triggers.md b/docs/enterprise/console-ui/webhook-triggers.md index 60212e003..8d6b9b146 100644 --- a/docs/enterprise/console-ui/webhook-triggers.md +++ b/docs/enterprise/console-ui/webhook-triggers.md @@ -5,7 +5,7 @@ description: Configure enterprise dashboard webhook triggers to send notificatio # Webhook Triggers -Webhook triggers monitor cluster resource usage metrics and send HTTP notifications when a configured threshold is reached. This is an enterprise-only feature and is available only when the enterprise dashboard is deployed. +Webhook triggers monitor cluster resource usage metrics and send HTTP notifications when a configured threshold is reached. This is an enterprise-only feature and is available only when the enterprise dashboard is deployed with dashboard version `v0.2.0-alpha.10` or later. Configure webhook triggers per provisioned instance under `settings.monitoring.webhook_triggers` in the dashboard apiserver configuration. Enabled webhook triggers require a metrics source, either `settings.monitoring.greptimedb.url` or `settings.monitoring.metrics.prometheus`. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md index 3a2480c47..b36d23f39 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md @@ -5,7 +5,7 @@ description: 在企业版 dashboard 中配置 webhook 触发器，基于 Greptim # Webhook 触发器 -Webhook 触发器会监控集群资源使用指标，并在达到配置阈值时发送 HTTP 通知。该功能仅属于企业版，并且只有在部署企业版 dashboard 时可用。 +Webhook 触发器会监控集群资源使用指标，并在达到配置阈值时发送 HTTP 通知。该功能仅属于企业版，并且只有在部署 dashboard 版本 `v0.2.0-alpha.10` 或更高版本的企业版 dashboard 时可用。 在 dashboard apiserver 配置中，按 provisioned instance 将 webhook 触发器配置到 `settings.monitoring.webhook_triggers` 下。启用 webhook 触发器需要配置指标数据源，即 `settings.monitoring.greptimedb.url` 或 `settings.monitoring.metrics.prometheus`。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md index 3a2480c47..b36d23f39 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md @@ -5,7 +5,7 @@ description: 在企业版 dashboard 中配置 webhook 触发器，基于 Greptim # Webhook 触发器 -Webhook 触发器会监控集群资源使用指标，并在达到配置阈值时发送 HTTP 通知。该功能仅属于企业版，并且只有在部署企业版 dashboard 时可用。 +Webhook 触发器会监控集群资源使用指标，并在达到配置阈值时发送 HTTP 通知。该功能仅属于企业版，并且只有在部署 dashboard 版本 `v0.2.0-alpha.10` 或更高版本的企业版 dashboard 时可用。 在 dashboard apiserver 配置中，按 provisioned instance 将 webhook 触发器配置到 `settings.monitoring.webhook_triggers` 下。启用 webhook 触发器需要配置指标数据源，即 `settings.monitoring.greptimedb.url` 或 `settings.monitoring.metrics.prometheus`。 diff --git a/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md b/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md index 60212e003..8d6b9b146 100644 --- a/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md +++ b/versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md @@ -5,7 +5,7 @@ description: Configure enterprise dashboard webhook triggers to send notificatio # Webhook Triggers -Webhook triggers monitor cluster resource usage metrics and send HTTP notifications when a configured threshold is reached. This is an enterprise-only feature and is available only when the enterprise dashboard is deployed. +Webhook triggers monitor cluster resource usage metrics and send HTTP notifications when a configured threshold is reached. This is an enterprise-only feature and is available only when the enterprise dashboard is deployed with dashboard version `v0.2.0-alpha.10` or later. Configure webhook triggers per provisioned instance under `settings.monitoring.webhook_triggers` in the dashboard apiserver configuration. Enabled webhook triggers require a metrics source, either `settings.monitoring.greptimedb.url` or `settings.monitoring.metrics.prometheus`. From affc92199b96d5504bc14ff6eafa5eb4f181c14a Mon Sep 17 00:00:00 2001 From: "Lei, HUANG" Date: Tue, 30 Jun 2026 21:05:39 +0800 Subject: [PATCH 3/4] Docs: add webhook triggers to v1.1 sidebar --- versioned_sidebars/version-1.1-sidebars.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/versioned_sidebars/version-1.1-sidebars.json b/versioned_sidebars/version-1.1-sidebars.json index 1c9bd7c26..89460e4b2 100644 --- a/versioned_sidebars/version-1.1-sidebars.json +++ b/versioned_sidebars/version-1.1-sidebars.json @@ -502,7 +502,8 @@ "label": "Management Console", "items": [ "enterprise/console-ui", - "enterprise/console-ui/continuous-profiling" + "enterprise/console-ui/continuous-profiling", + "enterprise/console-ui/webhook-triggers" ] }, { From faf38eec1b2f3fa02f8bb95b3addfeeee13f6736 Mon Sep 17 00:00:00 2001 From: "Lei, HUANG" Date: Wed, 1 Jul 2026 11:27:17 +0800 Subject: [PATCH 4/4] Docs: fix v1.1 console links --- .../version-1.1/enterprise/console-ui.md | 2 +- versioned_docs/version-1.1/enterprise/console-ui.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md index 2db982357..e0d3859f3 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md @@ -59,4 +59,4 @@ GreptimeDB 企业版管理控制台是标准 GreptimeDB 仪表板的增强版本 ## 持续性能剖析 -管理控制台支持[持续性能剖析](./continuous-profiling)，可用于采集和分析 GreptimeDB 组件的 CPU 与内存 Profile。同时也支持 [Webhook 触发器](./console-ui/webhook-triggers.md)，可基于集群资源使用指标发送通知。 +管理控制台支持[持续性能剖析](./console-ui/continuous-profiling.md)，可用于采集和分析 GreptimeDB 组件的 CPU 与内存 Profile。同时也支持 [Webhook 触发器](./console-ui/webhook-triggers.md)，可基于集群资源使用指标发送通知。 diff --git a/versioned_docs/version-1.1/enterprise/console-ui.md b/versioned_docs/version-1.1/enterprise/console-ui.md index 271699053..7565496e9 100644 --- a/versioned_docs/version-1.1/enterprise/console-ui.md +++ b/versioned_docs/version-1.1/enterprise/console-ui.md @@ -59,4 +59,4 @@ Displays long-running SQL and PromQL queries with detailed execution time and qu ## Continuous Profiling -The Management Console supports [Continuous Profiling](./continuous-profiling) for capturing and analyzing GreptimeDB component CPU and memory profiles. It also supports [Webhook Triggers](./console-ui/webhook-triggers.md) for sending notifications based on cluster resource usage metrics. +The Management Console supports [Continuous Profiling](./console-ui/continuous-profiling.md) for capturing and analyzing GreptimeDB component CPU and memory profiles. It also supports [Webhook Triggers](./console-ui/webhook-triggers.md) for sending notifications based on cluster resource usage metrics.