Skip to content

Update monitor-datadog-integration.md #21542

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.

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
wants to merge 1 commit into
base: release-8.5
Choose a base branch
from

Conversation

huoyao1125
Copy link

@huoyao1125 huoyao1125 commented Aug 8, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

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

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

Copy link

ti-chi-bot bot commented Aug 8, 2025

[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 lance6716 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.

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

@ti-chi-bot ti-chi-bot bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Aug 8, 2025
Copy link

ti-chi-bot bot commented Aug 8, 2025

Hi @huoyao1125. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@ti-chi-bot ti-chi-bot bot added needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. missing-translation-status This PR does not have translation status info. labels Aug 8, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @huoyao1125, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've updated the documentation for the TiDB Cloud Datadog integration. The primary goal of these changes is to streamline the process for users to install and access the TiDB Cloud dashboard within Datadog, ensuring the instructions are clear and accurate for different integration versions.

Highlights

  • Datadog Dashboard Installation: I've updated the instructions for installing the TiDB Cloud dashboard in Datadog, removing the manual JSON import steps and providing a more direct installation path for new users, while also clarifying the experience for existing users.
  • Viewing Pre-built Dashboard: I've simplified the steps for viewing the pre-built Datadog dashboard and added clearer notes explaining how the "Dashboard" link behaves differently for "Preview" and "Beta" versions of the Datadog integration.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 8, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Datadog integration documentation, likely reflecting that the integration is now generally available within Datadog. The changes simplify the instructions for setting up the dashboard and viewing metrics. My review provides a couple of suggestions to improve clarity and conciseness, such as rephrasing a passive statement and removing redundant text, in line with the documentation style guide.

Comment on lines +82 to +83
For users who have previously installed the TiDB Cloud integration in Datadog:
1. The [**TiDB Cloud Dynamic Tracker**](https://app.datadoghq.com/dash/integration/32021/tidb-cloud-dynamic-tracker) dashboard is displayed in your [**Dashboard List**](https://app.datadoghq.com/dashboard/lists).

Choose a reason for hiding this comment

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

low

The instruction for users who have previously installed the integration is a bit unclear. It's presented as a single-item list that states a fact rather than providing an action for the user to take. To improve clarity and align with the style guide's principles of active voice and clear instructions, consider rephrasing this as a simple sentence. 12

Style Guide References

Suggested change
For users who have previously installed the TiDB Cloud integration in Datadog:
1. The [**TiDB Cloud Dynamic Tracker**](https://app.datadoghq.com/dash/integration/32021/tidb-cloud-dynamic-tracker) dashboard is displayed in your [**Dashboard List**](https://app.datadoghq.com/dashboard/lists).
For users who have previously installed the TiDB Cloud integration in Datadog, the [**TiDB Cloud Dynamic Tracker**](https://app.datadoghq.com/dash/integration/32021/tidb-cloud-dynamic-tracker) dashboard is automatically available in your [**Dashboard List**](https://app.datadoghq.com/dashboard/lists).

Footnotes

  1. The style guide recommends using active voice. (link)

  2. The style guide recommends providing clear step instructions. (link)

Comment on lines +102 to +105
> Please note the following:
>
> - Before the pending [PR](https://github.com/DataDog/integrations-extras/pull/2751) is merged by Datadog, the **Dashboard** link redirects to the legacy dashboard, which does not include the latest metrics introduced in the preview version.
> - Once the pending [PR](https://github.com/DataDog/integrations-extras/pull/2751) is merged , the **Dashboard** link in the **Datadog** section will redirect to the new dashboard.
> - For Datadog integration (Preview), the **Dashboard** link redirects to the new dashboard, which will include the latest metrics introduced in the preview version.
> - For Datadog integration (Beta), the **Dashboard** link redirects to the legacy dashboard, which does not include the latest metrics introduced in the preview version.

Choose a reason for hiding this comment

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

low

The phrase "Please note the following:" is redundant within a Note block. To make the text more concise and adhere to the present tense preference, you can remove the introductory phrase and rephrase the verb. 12

Style Guide References

Suggested change
> Please note the following:
>
> - Before the pending [PR](https://github.com/DataDog/integrations-extras/pull/2751) is merged by Datadog, the **Dashboard** link redirects to the legacy dashboard, which does not include the latest metrics introduced in the preview version.
> - Once the pending [PR](https://github.com/DataDog/integrations-extras/pull/2751) is merged , the **Dashboard** link in the **Datadog** section will redirect to the new dashboard.
> - For Datadog integration (Preview), the **Dashboard** link redirects to the new dashboard, which will include the latest metrics introduced in the preview version.
> - For Datadog integration (Beta), the **Dashboard** link redirects to the legacy dashboard, which does not include the latest metrics introduced in the preview version.
> - For Datadog integration (Preview), the **Dashboard** link redirects to the new dashboard, which includes the latest metrics introduced in the preview version.
> - For Datadog integration (Beta), the **Dashboard** link redirects to the legacy dashboard, which does not include the latest metrics introduced in the preview version.

Footnotes

  1. The style guide advises avoiding unnecessary words and repetition to keep the documentation concise. (link)

  2. The style guide recommends using present tense unless describing historical behavior. (link)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant