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

Request to Add Metrics Instrumentation for Mux & Chi #5936

Open
10 tasks
jwafle opened this issue Jul 22, 2024 · 0 comments
Open
10 tasks

Request to Add Metrics Instrumentation for Mux & Chi #5936

jwafle opened this issue Jul 22, 2024 · 0 comments
Labels
area: instrumentation Related to an instrumentation package enhancement New feature or request

Comments

@jwafle
Copy link

jwafle commented Jul 22, 2024

Background

Package Link: package instrumentation already exists for tracing.

Why can this instrumentation not be included in the package itself?

These packages already have tracing instrumentation in opentelemetry-go-contrib. I am seeking further guidance on whether the inclusion of HTTP metrics should be pursued in this repository, or if these packages should begin migration to the packages themselves.

N.B. I have already opened issues in the package repositories to raise issues about OTEL instrumentation:
chi: go-chi/chi#937
mux: gorilla/handlers#257

Why can this instrumentation not be hosted in a dedicated repository?

See above. Asking for clarification on this matter.

Proposed Solution

Either:

  1. Begin migration of tracing instrumentation to the individual libraries, and continue adding metrics instrumentation from there.
  2. Continue in opentelemetry-go-contrib and add metrics instrumentation here.

Tracing

n/a, already exists

Metrics

Instruments

All metrics instrumentation that I would like implemented for these packages are well defined in the semantic conventions: https://opentelemetry.io/docs/specs/semconv/http/http-metrics/

Prior Art

Tasks

  • Code complete:
    • Comprehensive unit tests.
    • End-to-end integration tests.
    • Tests all passing.
    • Instrumentation functionality verified.
  • Documented
  • Examples
    • Dockerfile file to build example application.
    • docker-compose.yml to run example in a docker environment to demonstrate instrumentation.
@jwafle jwafle added area: instrumentation Related to an instrumentation package enhancement New feature or request labels Jul 22, 2024
@jwafle jwafle changed the title Request to Add Metrics Instrumentation for Mux & Gin Request to Add Metrics Instrumentation for Mux & Chi Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: instrumentation Related to an instrumentation package enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant