Skip to content

docs: add lifecycle event recorder configuration - #2678

Merged
WenyXu merged 1 commit into
mainfrom
docs/lifecycle-event-recorder
Aug 3, 2026
Merged

docs: add lifecycle event recorder configuration#2678
WenyXu merged 1 commit into
mainfrom
docs/lifecycle-event-recorder

Conversation

@WenyXu

@WenyXu WenyXu commented Jul 31, 2026

Copy link
Copy Markdown
Member

What's Changed in this PR

Closes #2652, #2655, #2656, #2657, #2658, #2659, #2661, #2664, #2665, #2667.

Document the [event_recorder] configuration in the English and Chinese deployment configuration guides.

  • Explain the ttl and event_types options, including the default all-event behavior and disabling recording with an empty array.
  • List the event types supported by standalone and Metasrv separately.
  • Document batch_gc and wal_prune as Metasrv-only event types.
  • Keep the Chinese localized configuration page synchronized with the English page.

Validation:

  • git diff --check origin/main...HEAD
  • English/Chinese event-type list consistency check

pnpm typecheck was not completed because the checkout is missing node_modules/@docusaurus/theme-classic and node_modules/@types/node.

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6bda517
Status: ✅  Deploy successful!
Preview URL: https://93367bd5.greptime-docs.pages.dev
Branch Preview URL: https://docs-lifecycle-event-recorde.greptime-docs.pages.dev

View logs

Signed-off-by: WenyXu <wenymedia@gmail.com>
@WenyXu
WenyXu force-pushed the docs/lifecycle-event-recorder branch from 604fa8e to 6bda517 Compare July 31, 2026 09:39
@WenyXu

WenyXu commented Jul 31, 2026

Copy link
Copy Markdown
Member Author

@codex review

@WenyXu
WenyXu marked this pull request as ready for review July 31, 2026 09:41
Copilot AI review requested due to automatic review settings July 31, 2026 09:41

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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Can't wait for the next one!

Reviewed commit: 6bda5174ea

ℹ️ 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".

@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. Verified the ttl default, the omitted/empty event_types semantics, and both standalone/Metasrv event-type lists against config/config.md and recorder.rs on greptimedb main; event_types is unreleased so the Nightly-only scope is correct.

@WenyXu
WenyXu merged commit 7242736 into main Aug 3, 2026
7 checks passed
@WenyXu
WenyXu deleted the docs/lifecycle-event-recorder branch August 3, 2026 08:01
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-recorder): configure lifecycle event recording

3 participants