feat: [#726] Add HTTP server and client telemetry instrumentation [5] #1326

krishankumar01 · 2025-12-29T20:42:09Z

📑 Description

✅ Checks

Added test cases for my code

Copilot

Pull request overview

This PR adds HTTP server and client telemetry instrumentation capabilities to the Goravel framework, enabling automatic tracing and metrics collection for HTTP requests and responses. This is part of the broader telemetry instrumentation feature set (issue #726).

Key Changes:

Implemented HTTP middleware for server-side request instrumentation with configurable filtering
Created HTTP client transport wrapper for outbound request instrumentation
Added configuration support for HTTP server instrumentation with exclusion patterns

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
`telemetry/setup/stubs.go`	Adds instrumentation configuration section with http_server settings for enabled state and path/method exclusions
`telemetry/instrumentation/http/middleware.go`	Implements Telemetry middleware that captures traces, metrics, and handles panics for incoming HTTP requests
`telemetry/instrumentation/http/middleware_test.go`	Provides test suite with test helpers for middleware functionality including success cases, exclusions, disabled state, and panic handling
`telemetry/instrumentation/http/config.go`	Defines ServerConfig structure and option functions for customizing HTTP server instrumentation behavior
`telemetry/instrumentation/http/transport.go`	Implements NewTransport function to wrap HTTP clients with telemetry instrumentation
`telemetry/instrumentation/http/transport_test.go`	Tests for transport wrapper covering fallback scenarios and successful wrapping cases
`go.mod`	Adds dependency on otelhttp instrumentation library
`go.sum`	Updates dependency checksums for otelhttp and its transitive dependency httpsnoop

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

telemetry/instrumentation/http/transport.go

telemetry/instrumentation/http/middleware_test.go

telemetry/instrumentation/http/middleware.go

telemetry/instrumentation/http/middleware_test.go

telemetry/instrumentation/http/middleware.go

codecov · 2025-12-29T20:50:30Z

Codecov Report

❌ Patch coverage is 62.17949% with 59 lines in your changes missing coverage. Please review.
✅ Project coverage is 70.15%. Comparing base (b4cd0dd) to head (98ec1f7).

Files with missing lines	Patch %	Lines
telemetry/instrumentation/http/middleware.go	71.91%	14 Missing and 11 partials ⚠️
telemetry/setup/stubs.go	0.00%	22 Missing ⚠️
telemetry/instrumentation/http/config.go	18.18%	9 Missing ⚠️
http/client/factory.go	75.00%	1 Missing and 1 partial ⚠️
telemetry/instrumentation/log/handler.go	50.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1326      +/-   ##
==========================================
- Coverage   70.22%   70.15%   -0.08%     
==========================================
  Files         281      284       +3     
  Lines       16852    16995     +143     
==========================================
+ Hits        11834    11922      +88     
- Misses       4525     4568      +43     
- Partials      493      505      +12

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

hwbrzzl · 2026-01-03T07:57:01Z

The report is sent by default currently, it should be unexpected. Could you optimize it in this PR?

krishankumar01 · 2026-01-03T07:58:53Z

The report is sent by default currently, it should be unexpected. Could you optimize it in this PR?

Is it for grpc?

hwbrzzl · 2026-01-03T08:00:41Z

@krishankumar01 No, just using the default configuration and run the project.

krishankumar01 · 2026-01-03T08:06:39Z

Okay, I’ll check. I’m thinking of using a kill switch for all instrumentation in config/telemetry.go to disable telemetry globally. This switch would override all other configuration and help enable or disable telemetry across different environments without changing multiple files.

Instrumentation:
  HttpServer:
    Enabled: true
  HttpClient:
    Enabled: false
  Log:
    Enabled: false

In this case, regardless of whether the log driver or HTTP middleware is registered, telemetry will not be published when it is disabled.

krishankumar01 · 2026-01-04T09:52:34Z

The report is sent by default currently, it should be unexpected. Could you optimize it in this PR?

@hwbrzzl I think the issue is in telemetry.metrics.exporter. We are setting it to otelmetric, which by default enables metrics publishing. Since OpenTelemetry is push-based, it tries to push metrics automatically. To disable metrics, we need to set this value to an empty string.

krishankumar01 · 2026-01-04T17:44:37Z

foundation/application_builder.go

 	}

-	// Register routes
-	for _, route := range r.routes {


Moving the route registration to the end, because if a user registers any gRPC stats handler or interceptors after calling routes.Grpc() (since in this file we usually call facades.Grpc().Server()), they will be ignored as the server is initialized only once in grpc/application.go.

krishankumar01 · 2026-01-04T17:49:18Z

log/application.go

 		}
 	case log.DriverOtel:
-		logLogger := telemetrylog.NewTelemetryChannel()
+		logLogger := telemetrylog.NewTelemetryChannel(config)


This won’t work if we call the otel driver logger inside providers or from the application builder callbacks, or any callback that runs before provider bootstrap, because telemetry.TelemetryFacade won’t be initialized and therefore won’t be able to lazily initialize the logger. This is expected, as telemetry is typically available only within the request lifecycle context.

How about passing TelemetryFacade here instead of using telemetry.TelemetryFacade directly? telemetry/instrumentation/* should not use the global telemetry.TelemetryFacade and telemetry.ConfigFacade. They should be passed into.

Then how do we ensure that a telemetry log channel can accept a telemetry facade instance? When we initialize the telemetry channel in NewApplication, the telemetry facade won’t be available yet. This would require making telemetry a dependency of the log facade.

When we initialize the telemetry channel in NewApplication, the telemetry facade won’t be available yet.

It should be impossible if the telemetry facade is registered, the telemetry channel should not be initialized during registering service providers but during booting. Return an error here if the telemetry facade is nil during booting.

But if the user sets the OTEL driver as the default or includes it in the stack, then log.NewApplication will try to resolve the telemetry channel instance, which depends on the telemetry facade. Since telemetry depends on log facade it will register and boot after it.

Basically, facades.* should be used inside a callback function if users want to use them in bootstrap.go.

Can we also add an annotation here explaining the different scenarios in which this(WithCallback) should be used? Since this is called before bootstrapping the service providers, it would be helpful to clarify that. Could you please add that?

Good point, will do.

The optimization is a bit complex, I need about two or three days. Please continue other parts for this PR.

No problem, In mean time I will work on #1339.

…on_builder

krishankumar01 added 5 commits December 23, 2025 22:53

add http middleware

2c9466a

add http transport

7ccca56

optimise http telemetry package

8df0782

add test cases for Telemetry middleware

01ecf4b

add auto instrumentation configs

0d8fda5

krishankumar01 requested a review from a team as a code owner December 29, 2025 20:42

Copilot AI review requested due to automatic review settings December 29, 2025 20:42

krishankumar01 marked this pull request as draft December 29, 2025 20:42

Copilot started reviewing on behalf of krishankumar01 December 29, 2025 20:42 View session

Copilot AI reviewed Dec 29, 2025

View reviewed changes

krishankumar01 added 4 commits January 3, 2026 02:18

Merge branch 'master' into kkumar-gcc/#726-auto-instrumentation-2

b2c07d5

add config to enable Telemetry for http clients

395f109

add docs for config facade

bb1f529

add ConfigFacade nil warning

441ba96

krishankumar01 added 8 commits January 4, 2026 15:29

Merge branch 'master' into kkumar-gcc/#726-auto-instrumentation-2

cb3cb89

disable default telemetry

7c59c97

optimise transport

ab72e2a

add kill switch for instrumentation

413bdd6

update the stubs

f999029

remove unnecessary handler

98ec1f7

optimise log instrumentation

ad59c56

move route registration in the end

1fea34b

krishankumar01 commented Jan 4, 2026

View reviewed changes

krishankumar01 added 8 commits January 5, 2026 00:22

lazily initialize middleware and transport to work with new applicati…

794ed71

…on_builder

optimise channel test

76021c2

optimise channel test

eb97e1b

merge master

c23884a

accept telemetry facade as an input instead of using global instance

e4faad6

use a callback to resolve the telemetry facade instance

5141d18

optimise grpc handler to remove usage of telemetry and config facade

5a26971

optimise the grpc handler

5a5d9fc

feat: [#726] Add HTTP server and client telemetry instrumentation [5] #1326

Are you sure you want to change the base?

feat: [#726] Add HTTP server and client telemetry instrumentation [5] #1326

Uh oh!

Conversation

krishankumar01 commented Dec 29, 2025

📑 Description

✅ Checks

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

hwbrzzl commented Jan 3, 2026

Uh oh!

krishankumar01 commented Jan 3, 2026

Uh oh!

hwbrzzl commented Jan 3, 2026

Uh oh!

krishankumar01 commented Jan 3, 2026

Uh oh!

krishankumar01 commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krishankumar01 Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krishankumar01 Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Dec 29, 2025 •

edited

Loading

krishankumar01 commented Jan 4, 2026 •

edited

Loading

krishankumar01 Jan 5, 2026 •

edited

Loading

krishankumar01 Jan 5, 2026 •

edited

Loading