docs: add enterprise dashboard webhook trigger docs#2592
Open
v0y4g3r wants to merge 3 commits into
Open
Conversation
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 <lei.mao@solidigm.com> Signed-off-by: Lei, HUANG <ratuthomm@gmail.com>
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 <ratuthomm@gmail.com>
v0y4g3r
changed the title
v0y4g3r
changed the title
Deploying greptime-docs with
|
| Latest commit: |
affc921
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fc96bbfb.greptime-docs.pages.dev |
| Branch Preview URL: | https://docs-webhook.greptime-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the Enterprise Management Console “Webhook Triggers” feature (resource-usage-based HTTP notifications), including configuration and payload details, and wires the new page into navigation/overview content for both current docs and v1.1 (plus Chinese translations).
Changes:
- Added new “Webhook Triggers” documentation pages (current + v1.1, EN + zh).
- Linked the new feature from the Management Console overview pages.
- Added the new doc to the current docs sidebar.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| versioned_docs/version-1.1/enterprise/console-ui/webhook-triggers.md | New v1.1 EN doc page describing webhook trigger configuration and payloads. |
| versioned_docs/version-1.1/enterprise/console-ui.md | Adds a Webhook Triggers mention/link in the v1.1 console overview (also touches Continuous Profiling link). |
| sidebars.ts | Adds the new Webhook Triggers page to the current docs sidebar navigation. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui/webhook-triggers.md | New v1.1 zh translation for the webhook triggers page. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.1/enterprise/console-ui.md | Adds a Webhook Triggers mention/link in the v1.1 zh console overview (also touches Continuous Profiling link). |
| i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui/webhook-triggers.md | New current zh translation for the webhook triggers page. |
| i18n/zh/docusaurus-plugin-content-docs/current/enterprise/console-ui.md | Adds a Webhook Triggers mention/link in the current zh console overview. |
| docs/enterprise/console-ui/webhook-triggers.md | New current EN doc page describing webhook trigger configuration and payloads. |
| docs/enterprise/console-ui.md | Adds a Webhook Triggers mention/link in the current EN console overview. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
discord9
approved these changes
Jun 30, 2026
discord9
left a comment
discord9
left a comment
Contributor
There was a problem hiding this comment.
LGTM. I left two minor follow-up comments; neither blocks this PR.
| ## 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. |
Contributor
There was a problem hiding this comment.
Minor: the adjacent Continuous Profiling link still uses ./continuous-profiling, which resolves to /enterprise/continuous-profiling from this page. Please change it to ./console-ui/continuous-profiling.md here and in the v1.1 zh mirror.
| - `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`. |
Contributor
There was a problem hiding this comment.
Nit: could we spell out the threshold units for non-percent metrics? memory_usage_bytes uses bytes and cpu_usage_millicores uses millicores, so values like threshold: 1000 are otherwise a bit ambiguous. Please also apply the same clarification to the mirrored zh/versioned copies.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
1.1and Chinese translation pages.Availability
This feature is enterprise-only and available when the enterprise dashboard is deployed with dashboard version
v0.2.0-alpha.10or later.Test Plan
node --input-type=moduleMDX compilation for changed and new docs pagesgit diff --checkpnpm build