Skip to content
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

chore: reduce tracing volume #466

Merged
merged 5 commits into from
Aug 18, 2024
Merged

chore: reduce tracing volume #466

merged 5 commits into from
Aug 18, 2024

Conversation

morgante
Copy link
Contributor

@morgante morgante commented Aug 17, 2024

Also fall back to the default exporter.

Summary by CodeRabbit

  • New Features

    • Enhanced logging for OpenTelemetry setup now includes deployment environment information.
    • Improved clarity in tracing setup with detailed logging for OTLP key handling.
  • Bug Fixes

    • Adjusted logic for OTLP key absence to provide clearer fallback mechanisms.
  • Improvements

    • Updated filtering for tracing logs to exclude noisy messages from specific libraries, streamlining output.

@morgante morgante marked this pull request as ready for review August 18, 2024 00:38
@morgante morgante requested a review from a team as a code owner August 18, 2024 00:38
Copy link
Contributor

coderabbitai bot commented Aug 18, 2024

Walkthrough

Walkthrough

The recent changes enhance the management of OpenTelemetry keys and improve logging within the tracing setup process. A new environment variable captures the deployment context, enriching log messages with clearer indications of the operating environment. Additionally, the handling of missing OTLP keys has been refined to provide better fallback indications. The tracing log filter has been updated to exclude specific noisy libraries, ensuring the output remains focused and relevant. Overall, these updates streamline the tracing functionality and enhance user clarity.

Changes

File Path Change Summary
crates/cli/src/commands/mod.rs Enhanced get_otel_setup for better deployment environment and OTLP key management with improved logging clarity. Updated run_command_with_tracing to filter out noisy logs from specific libraries.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Tracing
    participant Logger

    User->>CLI: Execute command
    CLI->>Tracing: Initialize tracing setup
    Tracing->>Tracing: Check for OTLP keys
    alt OTLP keys present
        Tracing->>Logger: Log OTLP key usage
    else OTLP keys absent
        Tracing->>Tracing: Check for explicit OTLP endpoint
        alt Endpoint found
            Tracing->>Logger: Log using default endpoint
        else No endpoint
            Tracing->>Logger: Log tracing disabled
        end
    end
    CLI->>User: Return command result
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8d58cea and 2f2eb40.

Files selected for processing (1)
  • crates/cli/src/commands/mod.rs (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/cli/src/commands/mod.rs
Additional context used
Learnings (1)
Common learnings
Learnt from: morgante
URL: https://github.com/getgrit/gritql/pull/231

Timestamp: 2024-04-15T05:47:47.743Z
Learning: User morgante prefers not to be asked for documentation.

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

grit-app bot commented Aug 18, 2024

On commit 8d58cea, Grit tried to heal these tests:

Job Original Status Final Status
main / Rust tests (marzano) ❌ Failed ❗ Failed on attempt #3 after trying strategies ai, rerun

Tip

You can view and edit CI healing settings on the Grit App.

@morgante morgante merged commit 6349a02 into main Aug 18, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant