Skip to content

Events in TiDB Premium: Developer guide changes #23638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fpavitra-oss wants to merge 2 commits into
base: release-8.5
Choose a base branch
from
+44 −6
Open

Events in TiDB Premium: Developer guide changes #23638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ab6e19
Documentation changes for Events in Premium.
fpavitra-oss Aug 27, 2026
1cb0fab
add CustomContent for premium logged events
qiancai Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tidb-cloud/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ This document lists the feature support status for different TiDB Cloud plans, i
<td>Events</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/monitoring-concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ For more information, see [TiDB Cloud Built-in Alerting](/tidb-cloud/monitor-bui

In TiDB Cloud, an event indicates a change in your TiDB Cloud resource.

- For {{{ .starter }}} and Essential instances, TiDB Cloud logs the historical events at the instance level.
- For {{{ .starter }}}, Essential and Premium instances, TiDB Cloud logs the historical events at the instance level.
- For TiDB Cloud Dedicated clusters, TiDB Cloud logs the historical events at the cluster level.

You can view the logged events on the **Events** page, including the event type, status, message, trigger time, and trigger user.
Expand Down
46 changes: 42 additions & 4 deletions tidb-cloud/tidb-cloud-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ summary: Learn how to view the events for TiDB Cloud resources using the Events

# Events

<CustomContent plan="starter,essential">
<CustomContent plan="starter,essential,premium">

For {{{ .starter }}} and Essential instances, TiDB Cloud logs the historical events at the instance level. An *event* indicates a change in your {{{ .starter }}} or Essential instance. You can view the logged events on the **Events** page, including the event type, status, message, trigger time, and trigger user.
For {{{ .starter }}}, Essential and Premium instances, TiDB Cloud logs the historical events at the instance level. An *event* indicates a change in your {{{ .starter }}}, Essential or Premium instance. You can view the logged events on the **Events** page, including the event type, status, message, trigger time, and trigger user.

</CustomContent>

Expand All @@ -23,7 +23,7 @@ This document describes how to view the historical events using the **Events** p

To view the events on the **Events** page, take the following steps:

1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target <CustomContent plan="starter,essential">{{{ .starter }}} or Essential instance</CustomContent><CustomContent plan="dedicated">TiDB Cloud Dedicated cluster</CustomContent> to go to its overview page.
1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target <CustomContent plan="starter,essential,premium">{{{ .starter }}}, Essential or Premium instance</CustomContent><CustomContent plan="dedicated">TiDB Cloud Dedicated cluster</CustomContent> to go to its overview page.

> **Tip:**
>
Expand All @@ -33,7 +33,9 @@ To view the events on the **Events** page, take the following steps:

## Logged events

TiDB Cloud logs the following types of cluster events:
<CustomContent plan="starter,essential,dedicated">

TiDB Cloud logs the following types of events:
Comment on lines +36 to +38

@coderabbitai coderabbitai Bot Aug 28, 2026

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


| Event Type| Description |
|:--- |:--- |
Expand All @@ -55,6 +57,42 @@ TiDB Cloud logs the following types of cluster events:
| UpdateSpendingLimit | Update spending limit of a {{{ .starter }}} instance |
| ResourceLimitation | Update resource limitation of a {{{ .starter }}} or {{{ .essential }}} instance |

</CustomContent>

<CustomContent plan="premium">

TiDB Cloud Premium logs the following types of events:

| Event Type| Description |
|:--- |:--- |
| CreateInstance | Create an instance |
| CreateDataMigration | Create a Data Migration Task |
| DeleteDataMigration | Delete a Data Migration Task |
| PauseDataMigration | Pause a Data Migration Task |
| ResumeDataMigration | Resume a Data Migration Task |
| ImportData | Import Data |
| CreatePrivateEndpoint | Create an AWS Private Endpoint for External Services |
| DeletePrivateEndpoint | Delete an AWS Private Endpoint for External Services |
| CreateChangefeed | Create a changefeed |
| ScaleChangefeed | Scale a changefeed |
| PauseChangefeed | Pause a changefeed |
| ResumeChangefeed | Resume a changefeed |
| EditChangefeed | Edit a changefeed |
| DeleteChangefeed | Delete a changefeed |
| BackupCluster | Back up a cluster |
| DeleteBackup | Delete a backup|
| UpdateBackupSetting | Update a backup setting |
| RestoreFromBackup | Restore from backup |
| CreateExport | Create an export |
| CancelExport | Cancel an export |
| DeleteExport | Delete an export |
| RestoreInstance | Restore to an instance |
| UpdatePublicEndpoint | Update a public endpoint |
| UpdateClusterCapacity | Update an instance capacity |
| CreatePrivateLink | Create a PrivateLink Endpoint |

</CustomContent>

For each event, the following information is logged:

- Event Type
Expand Down
Loading