Skip to content

docs: document ADMIN function events - #2746

Merged
WenyXu merged 4 commits into
GreptimeTeam:mainfrom
WenyXu:admin-fn
Aug 13, 2026
Merged

docs: document ADMIN function events#2746
WenyXu merged 4 commits into
GreptimeTeam:mainfrom
WenyXu:admin-fn

Conversation

@WenyXu

@WenyXu WenyXu commented Aug 13, 2026

Copy link
Copy Markdown
Member

What changed

Document admin_function events 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_function recording.

Closes #2732.

Scope

  • Documentation versions: Nightly, 1.2
  • Languages: English, Chinese

Verification

  • Executed successful and failed ADMIN functions through MySQL, PostgreSQL, and HTTP against a running cluster and queried greptime_private.events.
  • Verified that MySQL and PostgreSQL actors use the protocol session user; unauthenticated HTTP used the default greptime user.
  • Executed ADMIN migrate_region(...) and verified that the immediate admin_function output returned a Procedure ID, while region_migration events recorded the later Running and Done states.
  • Ran git diff --check origin/main...HEAD.
  • Manually reviewed the changed links and anchors.
  • English and Chinese builds were attempted but could not run because this checkout has no node_modules and docusaurus is unavailable.
  • Strict link checks were not run for the same missing-dependency reason.
  • Navigation is unchanged because no pages were added or moved.

Checklist

  • I verified the content against the applicable GreptimeDB version.
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors.
  • I updated navigation when the document structure changed.

WenyXu added 2 commits August 13, 2026 09:09
Signed-off-by: WenyXu <wenymedia@gmail.com>
Signed-off-by: WenyXu <wenymedia@gmail.com>
@WenyXu

WenyXu commented Aug 13, 2026

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/user-guide/deployments-administration/configuration.md
Comment thread docs/user-guide/deployments-administration/monitoring/events/event-data-model.md Outdated
@WenyXu
WenyXu marked this pull request as ready for review August 13, 2026 09:36
Copilot AI lite review requested due to automatic review settings August 13, 2026 09:36
Signed-off-by: WenyXu <wenymedia@gmail.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_function events (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.

Comment thread docs/user-guide/deployments-administration/configuration.md

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/user-guide/deployments-administration/monitoring/events/query-events.md Outdated
Comment thread docs/user-guide/deployments-administration/configuration.md
Comment thread docs/user-guide/deployments-administration/monitoring/events/query-events.md Outdated
Signed-off-by: WenyXu <wenymedia@gmail.com>

@fengjiachun fengjiachun left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@WenyXu
WenyXu merged commit c6627d5 into GreptimeTeam:main Aug 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs for feat(event): record admin function executions

3 participants