Skip to content

Events in TiDB Premium: Developer guide changes - #23638

Open
fpavitra-oss wants to merge 2 commits into
pingcap:release-8.5from
fpavitra-oss:events-premium-branch
Open

Events in TiDB Premium: Developer guide changes#23638
fpavitra-oss wants to merge 2 commits into
pingcap:release-8.5from
fpavitra-oss:events-premium-branch

Conversation

@fpavitra-oss

@fpavitra-oss fpavitra-oss commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Documentation changes for Events in TiDB Premium.

First-time contributors' checklist

What is changed, added or deleted? (Required)

With this feature, we are enabling Events in TiDB Premium. The changes include:
Events console will be visible in TiDB Premium
A list of Events that cause a change to Premium instance will show up
Each Event will carry supporting information like who triggered it, timestamp, etc.
Documentation changes are now mentioning Premium wherever Events are described.
A new section adds list of events supported in TiDB Premium.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

https://pingcap.feishu.cn/wiki/YXtIwQ8rxiCaiAkD0QcceCBlnog

  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Clarified that historical events are logged at the instance level for Starter, Essential, and Premium instances.
    • Expanded events documentation to cover Premium instances, including supported plan details, instructions, and Premium-specific event types.
  • New Features
    • Events are now available for Premium instances, including monitoring of migrations, endpoints, changefeeds, backups, restores, exports, capacity, and PrivateLink activity.

Documentation changes for Events in TiDB Premium.
@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign tangenta for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Changes

Event documentation

Layer / File(s) Summary
Premium instance event coverage
tidb-cloud/monitoring-concepts.md, tidb-cloud/tidb-cloud-events.md, tidb-cloud/features.md
The documentation includes Premium instances in historical event coverage, plan conditions, navigation instructions, and Events feature availability.
Premium event type reference
tidb-cloud/tidb-cloud-events.md
A new table lists event types logged for Premium instances.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: 🔵 Low · up to 1cb0f

The documentation currently includes Starter/Essential-only event rows in the Dedicated plan section, which could mislead users about supported events. This is a localized documentation correctness issue and is mergeable with owner awareness and a follow-up to split or relocate those rows.

Suggested reviewers: qiancai, blesslulu

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: Events documentation updates for TiDB Premium.
Description check ✅ Passed The description follows the repository template and explains the changes, affected version, reference link, checklists, and AI involvement.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 64def6ef-ccbe-44e1-8d32-ffc4d1dd2457

📥 Commits

Reviewing files that changed from the base of the PR and between a5c03bf and 6ab6e19.

📒 Files selected for processing (2)
  • tidb-cloud/monitoring-concepts.md
  • tidb-cloud/tidb-cloud-events.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread tidb-cloud/tidb-cloud-events.md Outdated

@coderabbitai coderabbitai 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.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 05dcc608-d41e-43fb-9e27-62c826f3a28d

📥 Commits

Reviewing files that changed from the base of the PR and between 6ab6e19 and 1cb0fab.

📒 Files selected for processing (2)
  • tidb-cloud/features.md
  • tidb-cloud/tidb-cloud-events.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment on lines +36 to +38
<CustomContent plan="starter,essential,dedicated">

TiDB Cloud logs the following types of events:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Do not expose Starter and Essential-only rows on Dedicated pages.

This block now renders for dedicated, but rows such as UpdateSpendingLimit and ResourceLimitation still describe Starter and Essential instances. Split the table by plan, or keep those rows outside the Dedicated block before publishing.

As per path instructions, a committable suggestion is not appropriate because the fix requires moving non-contiguous table rows.

Source: Path instructions

@qiancai qiancai self-assigned this Aug 28, 2026
@qiancai qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Aug 28, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. contribution This PR is from a community contributor. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants