feat(dashboard): support TiDB Dashboard searching TiCDC logs #3852
Conversation
ti-chi-bot
bot
added
do-not-merge/needs-triage-completed
release-note-none
Summary of ChangesHello @wlwilliamx, 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! This pull request introduces a significant enhancement to TiCDC's observability by enabling TiDB Dashboard to search TiCDC logs directly. By integrating a new gRPC diagnostics service, users can now efficiently troubleshoot and monitor TiCDC instances through a centralized dashboard, improving the ease of identifying and resolving issues without manual log file inspection. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
ti-chi-bot
bot
added
the
size/L
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds support for searching TiCDC logs via a new diagnostics gRPC service, which will be used by TiDB Dashboard. The changes involve registering the diagnostics service in the main gRPC server and adding a new integration test to verify the log search functionality. The implementation looks good, but I have a suggestion to improve the robustness of the new test case by properly handling the gRPC stream.
| resp, err := stream.Recv() | ||
| require.NoError(t, err) | ||
| require.NotEmpty(t, resp.Messages) | ||
|
|
||
| found := false | ||
| for _, msg := range resp.Messages { | ||
| if strings.Contains(msg.Message, "hello world") { | ||
| found = true | ||
| break | ||
| } | ||
| } | ||
| require.True(t, found, "expected log message to contain hello world") |
There was a problem hiding this comment.
The current implementation for receiving from the stream is not robust. It only receives one message and doesn't correctly handle the end of the stream (io.EOF), which could lead to test failures if the streaming behavior changes (e.g., multiple message chunks) or if no messages are returned.
It's better to loop over stream.Recv() until io.EOF is received to collect all messages from the stream before asserting the content. This makes the test more resilient to changes in the server's streaming implementation.
Please also remember to add "io" to the imports.
var allMessages []*diagnosticspb.LogMessage
for {
resp, err := stream.Recv()
if err == io.EOF {
break
}
require.NoError(t, err)
allMessages = append(allMessages, resp.Messages...)
}
require.NotEmpty(t, allMessages)
found := false
for _, msg := range allMessages {
if strings.Contains(msg.Message, "hello world") {
found = true
break
}
}
require.True(t, found, "expected log message to contain hello world")
ti-chi-bot
bot
added
needs-1-more-lgtm
|
/test all |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lidezhu, wk989898 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
|
/retest |
3 participants
What problem does this PR solve?
Issue Number: ref #2128
What is changed and how it works?
Support TiDB Dashboard searching TiCDC logs.
Check List
Tests
Questions
Will it cause performance regression or break compatibility?
None
Do you need to update user documentation, design documentation or monitoring documentation?
None
Release note