fix: OTEL schema incompatibility after upgrade

[jamestelfer]

After the recent upgrade, the server failed to start because the OTel schema version had changed.

This is undesirable behaviour: added a unit test to catch this easily before commit.

Summary by CodeRabbit

• New Features

  • Updated OpenTelemetry integration to the latest version for improved performance.
  • Introduced a new function for creating resources with service names, enhancing modularity.

• Bug Fixes

  • Improved error handling during resource merging to ensure compatibility with schema updates.

• Tests

  • Added a test to verify schema compatibility during resource merging, ensuring reliability in telemetry updates.

• Documentation

  • Enhanced logging configuration for better integration and error reporting.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on the internal/observe/telemetry.go and internal/observe/telemetry_test.go files. Key modifications include updating the OpenTelemetry semantic conventions version, adding a new function for resource creation, and enhancing error handling and logging capabilities. A corresponding test function has been introduced to ensure schema compatibility during resource merging. These updates aim to improve code modularity, readability, and robustness in telemetry integration.

Changes

File	Change Summary
internal/observe/telemetry.go	- Updated OpenTelemetry version from v1.24.0 to v1.26.0. - Added resourceWithServiceName function. - Modified newTraceProvider to call resourceWithServiceName. - Updated HttpTransport to check cfg.HttpTransportEnabled. - Enhanced configureLogging for better logging level handling and added warning for invalid configurations.
internal/observe/telemetry_test.go	- Added Test_ResourceMerge to verify schema compatibility during resource merging.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Telemetry
    participant Resource

    User->>Telemetry: Initialize Telemetry
    Telemetry->>Resource: resourceWithServiceName(base, serviceName)
    Resource-->>Telemetry: Return Resource
    Telemetry->>Telemetry: Configure Logging
    Telemetry->>User: Telemetry Ready

Loading

🐰 "In the meadow where bunnies play,
New functions hop in, brightening the day!
With logs that sing and resources that gleam,
Our code now flows like a sweet, gentle stream.
Hooray for the changes, let's leap and rejoice,
For every new feature, we cheer with our voice!" 🐇

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.40%. Comparing base (6bbb904) to head (1014aea).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #67   +/-   ##
=======================================
  Coverage   90.40%   90.40%           
=======================================
  Files          13       13           
  Lines         521      521           
=======================================
  Hits          471      471           
  Misses         34       34           
  Partials       16       16           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.