Skip to content

fix(api): Disable otel rpc server attributes#3043

Merged
imeyer merged 1 commit intomainfrom
otelconnect-remove-server-peer-attributes
Mar 31, 2025
Merged

fix(api): Disable otel rpc server attributes#3043
imeyer merged 1 commit intomainfrom
otelconnect-remove-server-peer-attributes

Conversation

@imeyer
Copy link
Contributor

@imeyer imeyer commented Mar 29, 2025

By default OpenTelemetry RPC includes peer ports and names which increase metric cardinality by a significant amount. Setting the option WithoutServerPeerAttributes() on the interceptor removes those attributes.

Summary by CodeRabbit

  • New Features
    • Updated the system's telemetry configuration to exclude specific server connection attributes, ensuring more focused and precise performance data.
    • Enhanced monitoring capabilities while maintaining robust error logging, resulting in clearer operational insights.

@vercel
Copy link

vercel bot commented Mar 29, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 7:11am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 7:11am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 7:11am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 31, 2025 7:11am

@changeset-bot
Copy link

changeset-bot bot commented Mar 29, 2025

⚠️ No Changeset found

Latest commit: f0fe3ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 29, 2025

📝 Walkthrough

Walkthrough

This change updates the configuration of telemetry interceptors by adding the WithoutServerPeerAttributes option during their creation. In both the rate limiting service’s peer initialization and the RPC module’s initialization, the interceptor is now configured to exclude server peer attributes from its telemetry data. The error handling and logging remain unchanged.

Changes

File(s) Change Summary
go/internal/.../ratelimit/peers.go, go/pkg/.../rpc.go Modified interceptor creation calls by adding the WithoutServerPeerAttributes option, which alters the telemetry configuration by excluding server peer attributes.

Sequence Diagram(s)

Service Peer Creation Flow

sequenceDiagram
    actor Client as "Caller"
    participant S as "service.newPeer"
    participant I as "otelconnect.NewInterceptor"

    Client->>S: newPeer(ctx, key)
    S->>I: NewInterceptor(tracerProvider, WithoutServerPeerAttributes)
    alt Success
        I-->>S: interceptor instance
        S-->>Client: returns peer
    else Error
        I-->>S: error
        S-->>Client: returns error
    end
Loading

RPC Initialization Flow

sequenceDiagram
    actor Client as "Caller"
    participant R as "rpc.New"
    participant I as "otelconnect.NewInterceptor"

    Client->>R: New()
    R->>I: NewInterceptor(tracerProvider, trustRemoteOptions, WithoutServerPeerAttributes)
    alt Success
        I-->>R: interceptor instance
        R-->>Client: returns service instance
    else Error
        I-->>R: error
        R-->>Client: returns error
    end
Loading

Possibly related PRs

  • feat(chproxy): Add OTEL instrumentation #2949: The changes in the main PR regarding the newPeer function's interceptor configuration are directly related to the addition of the WithoutServerPeerAttributes option in the rpc.go file, indicating a shared focus on modifying interceptor behavior.
  • feat(chproxy): OTEL optimizations #2962: The changes in the main PR regarding the newPeer function's interceptor configuration are related to the addition of the WithoutServerPeerAttributes option in the rpc.go file, as both modifications involve altering how server peer attributes are handled in interceptor configurations.
  • feat(chproxy): refactor OTEL telemetry #2959: The changes in the main PR regarding the newPeer function's interceptor configuration are directly related to the addition of the WithoutServerPeerAttributes option in the otelconnect.NewInterceptor function in the retrieved PR, as both modifications involve altering the behavior of interceptors in the context of telemetry.

Suggested reviewers

  • mcstepp
  • perkinsjr
  • MichaelUnkey
  • chronark

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70dc0f9 and f0fe3ec.

📒 Files selected for processing (2)
  • go/internal/services/ratelimit/peers.go (1 hunks)
  • go/pkg/rpc/rpc.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • go/internal/services/ratelimit/peers.go
  • go/pkg/rpc/rpc.go
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Test Go API Local / Test (Shard 7/8)
  • GitHub Check: Test Go API Local / Test (Shard 2/8)
  • GitHub Check: Test Go API Local / Test (Shard 1/8)
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Build / Build

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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
Copy link
Contributor

github-actions bot commented Mar 29, 2025

Thank you for following the naming conventions for pull request titles! 🙏

@vercel vercel bot temporarily deployed to Preview – play March 29, 2025 00:38 Inactive
@vercel vercel bot temporarily deployed to Preview – engineering March 29, 2025 00:38 Inactive
@vercel vercel bot temporarily deployed to Preview – www March 29, 2025 00:38 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard March 29, 2025 00:39 Inactive
By default OpenTelemetry RPC includes peer ports and names which
increase metric cardinality by a significant amount. Setting the
option WithoutServerPeerAttributes() on the interceptor removes
those attributes.

Signed-off-by: Ian Meyer (imeyer) <k@imeyer.io>
@imeyer imeyer force-pushed the otelconnect-remove-server-peer-attributes branch from 70dc0f9 to f0fe3ec Compare March 31, 2025 07:07
@vercel vercel bot temporarily deployed to Preview – engineering March 31, 2025 07:08 Inactive
@vercel vercel bot temporarily deployed to Preview – www March 31, 2025 07:10 Inactive
@vercel vercel bot temporarily deployed to Preview – play March 31, 2025 07:11 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard March 31, 2025 07:11 Inactive
@imeyer imeyer added this pull request to the merge queue Mar 31, 2025
Merged via the queue into main with commit ee0b672 Mar 31, 2025
54 of 60 checks passed
@imeyer imeyer deleted the otelconnect-remove-server-peer-attributes branch March 31, 2025 08:01
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.

2 participants