docs: document ADMIN function events - #2746
Conversation
Signed-off-by: WenyXu <wenymedia@gmail.com>
Signed-off-by: WenyXu <wenymedia@gmail.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 599bfae1c9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: WenyXu <wenymedia@gmail.com>
There was a problem hiding this comment.
Pull request overview
Documents admin_function event recording in the Nightly Events guides (EN/ZH), including event-specific columns, an example query, and clarification that the recorded output is the immediate ADMIN result (with async Procedure lifecycle tracked separately). It also renames the “Lifecycle event recorder” configuration section to “Event recording/事件记录配置” and backports only that terminology + link updates to 1.2.
Changes:
- Add Nightly guidance for querying and interpreting
admin_functionevents (EN/ZH). - Extend the Nightly event data model docs with
admin_function-specific columns (EN/ZH). - Rename the event recorder configuration section and update links in Nightly + 1.2 (EN/ZH).
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/user-guide/deployments-administration/monitoring/events/query-events.md | Add admin_function query example and interpretation notes (EN Nightly). |
| docs/user-guide/deployments-administration/monitoring/events/overview.md | Update overview to point to renamed “Event recording” section (EN Nightly). |
| docs/user-guide/deployments-administration/monitoring/events/event-data-model.md | Document admin_function event columns (EN Nightly). |
| docs/user-guide/deployments-administration/configuration.md | Rename section to “Event recording” and add admin_function type notes (EN Nightly). |
| docs/reference/sql/greptime-private/events.md | Update configuration link to renamed section (EN Nightly). |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/query-events.md | 增加 admin_function 查询示例与说明(中文 Nightly)。 |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/overview.md | 更新概览页指向“事件记录配置”小节(中文 Nightly)。 |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/event-data-model.md | 增加管理函数事件列说明(中文 Nightly)。 |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/configuration.md | 重命名为“事件记录配置”并补充 admin_function 类型说明(中文 Nightly)。 |
| i18n/zh/docusaurus-plugin-content-docs/current/reference/sql/greptime-private/events.md | 更新配置链接到“事件记录配置”(中文 Nightly)。 |
| versioned_docs/version-1.2/user-guide/deployments-administration/monitoring/events/overview.md | Update overview link text/anchor to renamed section (EN v1.2). |
| versioned_docs/version-1.2/user-guide/deployments-administration/configuration.md | Rename section heading to “Event recording” (EN v1.2, terminology-only backport). |
| versioned_docs/version-1.2/reference/sql/greptime-private/events.md | Update configuration link to renamed section (EN v1.2). |
| i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/deployments-administration/monitoring/events/overview.md | 更新概览链接到“事件记录配置”(中文 v1.2)。 |
| i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/deployments-administration/configuration.md | 标题改为“事件记录配置”(中文 v1.2,术语回移)。 |
| i18n/zh/docusaurus-plugin-content-docs/version-1.2/reference/sql/greptime-private/events.md | 更新配置链接到“事件记录配置”(中文 v1.2)。 |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 599bfae1c9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: WenyXu <wenymedia@gmail.com>
What changed
Document
admin_functionevents in the Nightly English and Chinese Events guides. Add the event-specific columns, a query example, and clarify that the recorded result is the immediate ADMIN function output. Asynchronous functions can return a Procedure ID whose later lifecycle is recorded separately.Rename the event recorder configuration section to “Event recording” / “事件记录配置” because the table also stores Region and maintenance events, not only Procedure lifecycle events. Backport only this terminology and its necessary links to 1.2; 1.2 does not document
admin_functionrecording.Closes #2732.
Scope
Verification
greptime_private.events.greptimeuser.ADMIN migrate_region(...)and verified that the immediateadmin_functionoutput returned a Procedure ID, whileregion_migrationevents recorded the laterRunningandDonestates.git diff --check origin/main...HEAD.node_modulesanddocusaurusis unavailable.Checklist