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

Add OpenTelemetry attributes to the metrics backend #2292

Open
adamw opened this issue Sep 23, 2024 · 6 comments
Open

Add OpenTelemetry attributes to the metrics backend #2292

adamw opened this issue Sep 23, 2024 · 6 comments

Comments

@adamw
Copy link
Member

adamw commented Sep 23, 2024

Currently the OpenTelemetryMetricsBackend reports a number of metrics, following the naming conventions of OpenTelemetry.

However, we only report raw metric values, without any of the attributes as defined here.

The goal of this issue is to report the metrics along with the required attributes. Optionally, we might include other attributes, if this is feasible and "makes sense".

The abstractions currently present in OpenTelemetryMetricsBackend might need updating/extending/refactoring; since this targets version 4 (yet unreleased), there are no compatibility requirements.

@adamw adamw changed the title Add opentelemetry attributes to the metrics backend Add OpenTelemetry attributes to the metrics backend Oct 16, 2024
@adamw
Copy link
Member Author

adamw commented Oct 16, 2024

/bounty $500

Copy link

algora-pbc bot commented Oct 16, 2024

💎 $500 bounty • SoftwareMill

Steps to solve:

  1. Start working: Comment /attempt #2292 with your implementation plan
  2. Submit work: Create a pull request including /claim #2292 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to softwaremill/sttp!

Add a bountyShare on socials

Attempt Started (GMT+0) Solution
🟢 @varshith257 Oct 16, 2024, 1:10:58 PM WIP

@varshith257
Copy link

varshith257 commented Oct 16, 2024

@adamw I have experience with OTEL and my experience through an internship and contributions to OTEL and Jaeger. I am throwing my hat to crack this
/attempt #2292

Algora profile Completed bounties Tech Active attempts Options
@varshith257 16 bounties from 8 projects
Scala, Rust,
TypeScript & more
Cancel attempt

@iRevive
Copy link

iRevive commented Oct 16, 2024

The goal of this issue is to report the metrics along with the required attributes

(copy-paste from softwaremill/tapir#4057).

You can use OpenTelemetry semantic conventions to generate specs and use them in tests to ensure all required attributes are in place.

Here are a few examples:

@adamw
Copy link
Member Author

adamw commented Oct 16, 2024

@iRevive thanks, this looks interesting. @varshith257 if we could use this somehow to simplify / automate the testing, that would be great

@adamw
Copy link
Member Author

adamw commented Oct 21, 2024

As we are getting first PRs for the bounties, I've published our "How to prepare a good PR" guide. I should have probably done this right away, sorry! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants