Skip to content

fix: add more tracing for search #4534

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

Jump to bottom
Merged
hengfeiyang merged 1 commit into from
Sep 12, 2024
Merged

fix: add more tracing for search #4534

hengfeiyang merged 1 commit into from
Sep 12, 2024

Conversation

@haohuaijin
Copy link
Collaborator

@haohuaijin haohuaijin commented Sep 12, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Enhanced observability for the search functionality with new tracing instrumentation for better performance monitoring and debugging.

  • Bug Fixes

    • Improved traceability of the sql and exec_query functions without altering their core logic.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024 •
edited
Loading

Walkthrough

The changes involve the addition of tracing instrumentation to several asynchronous functions in the codebase. Specifically, the sql and exec_query functions in the src/service/search/datafusion/exec.rs file, as well as the search function in the src/service/search/mod.rs file, have been annotated with #[tracing::instrument] attributes. These modifications enhance the observability of the functions without altering their core logic or control flow.

Changes

Files Change Summary
src/service/search/datafusion/exec.rs Added tracing instrumentation to sql and exec_query functions with skip_all parameter.
src/service/search/mod.rs Added tracing instrumentation to search function with skip(in_req) parameter.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Service
    participant DataFusion

    Client->>Service: Call search()
    Service->>DataFusion: Call sql()
    DataFusion->>DataFusion: Execute SQL query
    DataFusion-->>Service: Return results
    Service-->>Client: Return search results
Loading
Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1a4e53a and 4f7c7d2.

Files selected for processing (2)
  • src/service/search/datafusion/exec.rs (2 hunks)
  • src/service/search/mod.rs (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/service/search/datafusion/exec.rs
Additional context used
Path-based instructions (1)
src/service/search/mod.rs (1)

Pattern **/*.rs: You are a smart rustlang pull request reviewer.
You are going to review all the rustlang files.
Be concise, and add a brief explanation to your suggestions

Make sure the responses are not too verbose and keep the suggestions to the point i.e. actionable.

Additional comments not posted (1)
src/service/search/mod.rs (1)

76-76: LGTM!

The tracing instrumentation attribute is correctly added to the search function. The name parameter is appropriately set, and the skip(in_req) parameter is used to avoid including potentially sensitive information from the request in the tracing data.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added ☢️ Bug Something isn't working ✏️ Feature labels Sep 12, 2024
@hengfeiyang hengfeiyang merged commit fdfefc0 into main Sep 12, 2024
@hengfeiyang hengfeiyang deleted the hj/fix-tracing branch September 12, 2024 12:02
This was referenced Sep 16, 2024
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2024
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 1, 2024
Merged
This was referenced Nov 26, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hengfeiyang hengfeiyang hengfeiyang approved these changes

@oasisk oasisk oasisk approved these changes

Assignees

No one assigned

Labels

☢️ Bug Something isn't working ✏️ Feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@haohuaijin @hengfeiyang @oasisk