feat: [#726] Add HTTP server and client telemetry instrumentation [5] #1326
+1,214
−326
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package http | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "go.opentelemetry.io/otel/attribute" | ||
|
|
||
| "github.com/goravel/framework/contracts/http" | ||
| ) | ||
|
|
||
| // Filter allows excluding specific requests from being traced. | ||
| type Filter func(ctx http.Context) bool | ||
|
|
||
| // SpanNameFormatter allows customizing the span name. | ||
| type SpanNameFormatter func(route string, ctx http.Context) string | ||
|
|
||
| // Option applies configuration to the server instrumentation. | ||
| type Option func(*ServerConfig) | ||
|
|
||
| // ServerConfig maps to "telemetry.instrumentation.http_server". | ||
| type ServerConfig struct { | ||
| Enabled bool `mapstructure:"enabled"` | ||
krishankumar01 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ExcludedPaths []string `mapstructure:"excluded_paths"` | ||
| ExcludedMethods []string `mapstructure:"excluded_methods"` | ||
| Filters []Filter `mapstructure:"-"` | ||
| SpanNameFormatter SpanNameFormatter `mapstructure:"-"` | ||
| MetricAttributes []attribute.KeyValue `mapstructure:"-"` | ||
| } | ||
|
|
||
| func WithFilter(f Filter) Option { | ||
| return func(c *ServerConfig) { | ||
| c.Filters = append(c.Filters, f) | ||
| } | ||
| } | ||
|
|
||
| func WithSpanNameFormatter(f SpanNameFormatter) Option { | ||
| return func(c *ServerConfig) { | ||
| c.SpanNameFormatter = f | ||
| } | ||
| } | ||
|
|
||
| func WithMetricAttributes(attrs ...attribute.KeyValue) Option { | ||
| return func(c *ServerConfig) { | ||
| c.MetricAttributes = append(c.MetricAttributes, attrs...) | ||
| } | ||
| } | ||
|
|
||
| func defaultSpanNameFormatter(route string, ctx http.Context) string { | ||
| return fmt.Sprintf("%s %s", ctx.Request().Method(), route) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| package http | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/goravel/framework/contracts/http" | ||
| "github.com/goravel/framework/support/color" | ||
| "github.com/goravel/framework/telemetry" | ||
| "go.opentelemetry.io/otel/codes" | ||
| "go.opentelemetry.io/otel/metric" | ||
| "go.opentelemetry.io/otel/propagation" | ||
| semconv "go.opentelemetry.io/otel/semconv/v1.37.0" | ||
| ) | ||
|
|
||
| const ( | ||
| instrumentationName = "github.com/goravel/framework/telemetry/instrumentation/http" | ||
|
|
||
| metricRequestDuration = "http.server.request.duration" | ||
| metricRequestBodySize = "http.server.request.body.size" | ||
| metricResponseBodySize = "http.server.response.body.size" | ||
|
|
||
| unitSeconds = "s" | ||
| unitBytes = "By" | ||
| ) | ||
|
|
||
krishankumar01 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| func Telemetry(opts ...Option) http.Middleware { | ||
| if telemetry.TelemetryFacade == nil { | ||
| color.Warningln("[Telemetry] Facade not initialized. HTTP middleware disabled.") | ||
| return func(ctx http.Context) { ctx.Request().Next() } | ||
| } | ||
|
|
||
krishankumar01 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| var cfg ServerConfig | ||
| _ = telemetry.ConfigFacade.UnmarshalKey("telemetry.instrumentation.http_server", &cfg) | ||
|
|
||
| for _, opt := range opts { | ||
| opt(&cfg) | ||
| } | ||
|
|
||
| if !cfg.Enabled { | ||
| return func(ctx http.Context) { ctx.Request().Next() } | ||
| } | ||
|
|
||
| if cfg.SpanNameFormatter == nil { | ||
| cfg.SpanNameFormatter = defaultSpanNameFormatter | ||
| } | ||
|
|
||
| tracer := telemetry.TelemetryFacade.Tracer(instrumentationName) | ||
| meter := telemetry.TelemetryFacade.Meter(instrumentationName) | ||
| propagator := telemetry.TelemetryFacade.Propagator() | ||
|
|
||
| durationHist, _ := meter.Float64Histogram(metricRequestDuration, metric.WithUnit(unitSeconds), metric.WithDescription("Duration of HTTP server requests")) | ||
| requestSizeHist, _ := meter.Int64Histogram(metricRequestBodySize, metric.WithUnit(unitBytes), metric.WithDescription("Size of HTTP server request body")) | ||
| responseSizeHist, _ := meter.Int64Histogram(metricResponseBodySize, metric.WithUnit(unitBytes), metric.WithDescription("Size of HTTP server response body")) | ||
|
|
||
| excludedPaths := make(map[string]bool, len(cfg.ExcludedPaths)) | ||
|
Contributor
There was a problem hiding this comment. Can |
||
| for _, p := range cfg.ExcludedPaths { | ||
| excludedPaths[p] = true | ||
| } | ||
| excludedMethods := make(map[string]bool, len(cfg.ExcludedMethods)) | ||
| for _, m := range cfg.ExcludedMethods { | ||
| excludedMethods[m] = true | ||
| } | ||
|
|
||
| return func(ctx http.Context) { | ||
| req := ctx.Request() | ||
|
|
||
| routePath := req.OriginPath() | ||
| if routePath == "" { | ||
| routePath = req.Path() | ||
| } | ||
|
|
||
| if excludedPaths[routePath] || excludedMethods[req.Method()] { | ||
| req.Next() | ||
| return | ||
| } | ||
|
|
||
| for _, f := range cfg.Filters { | ||
| if !f(ctx) { | ||
| req.Next() | ||
| return | ||
| } | ||
| } | ||
|
|
||
| start := time.Now() | ||
| parentCtx := propagator.Extract(ctx.Context(), propagation.HeaderCarrier(req.Headers())) | ||
| spanName := cfg.SpanNameFormatter(routePath, ctx) | ||
|
|
||
| scheme := "http" | ||
| if proto := req.Header("X-Forwarded-Proto"); proto != "" { | ||
| scheme = proto | ||
| } | ||
|
|
||
| baseAttrs := []telemetry.KeyValue{ | ||
| semconv.HTTPRequestMethodKey.String(req.Method()), | ||
| semconv.HTTPRoute(routePath), | ||
| semconv.URLScheme(scheme), | ||
| semconv.ServerAddress(req.Host()), | ||
| semconv.ClientAddress(req.Ip()), | ||
| semconv.UserAgentOriginal(req.Header("User-Agent")), | ||
| } | ||
|
|
||
| baseAttrs = append(baseAttrs, cfg.MetricAttributes...) | ||
|
|
||
| spanCtx, span := tracer.Start(parentCtx, spanName, | ||
| telemetry.WithAttributes(baseAttrs...), | ||
| telemetry.WithSpanKind(telemetry.SpanKindServer), | ||
| ) | ||
|
|
||
| ctx.WithContext(spanCtx) | ||
|
|
||
| func() { | ||
| defer func() { | ||
| if r := recover(); r != nil { | ||
| err := fmt.Errorf("panic: %v", r) | ||
| span.RecordError(err) | ||
| span.SetStatus(codes.Error, "Internal Server Error") | ||
|
|
||
| metricAttrs := metric.WithAttributes(append(baseAttrs, semconv.HTTPResponseStatusCode(500))...) | ||
|
|
||
| durationHist.Record(spanCtx, time.Since(start).Seconds(), metricAttrs) | ||
| requestSizeHist.Record(spanCtx, getRequestSize(req), metricAttrs) | ||
| responseSizeHist.Record(spanCtx, 0, metricAttrs) | ||
|
|
||
| span.End() | ||
| panic(r) | ||
| } | ||
| }() | ||
| req.Next() | ||
| }() | ||
|
|
||
| status := ctx.Response().Origin().Status() | ||
|
|
||
| span.SetAttributes(semconv.HTTPResponseStatusCode(status)) | ||
|
|
||
| if status >= 500 { | ||
| span.SetStatus(codes.Error, "") | ||
| } else { | ||
| span.SetStatus(codes.Ok, "") | ||
| } | ||
|
|
||
| if err := ctx.Err(); err != nil { | ||
| span.RecordError(err) | ||
| } | ||
|
|
||
| span.End() | ||
|
|
||
| metricAttrs := metric.WithAttributes(append(baseAttrs, semconv.HTTPResponseStatusCode(status))...) | ||
|
|
||
| durationHist.Record(spanCtx, time.Since(start).Seconds(), metricAttrs) | ||
| requestSizeHist.Record(spanCtx, getRequestSize(req), metricAttrs) | ||
| responseSizeHist.Record(spanCtx, int64(ctx.Response().Origin().Size()), metricAttrs) | ||
| } | ||
| } | ||
|
|
||
| func getRequestSize(req http.ContextRequest) int64 { | ||
| size := req.Origin().ContentLength | ||
| if size < 0 { | ||
| return 0 | ||
| } | ||
| return size | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the code, the specific requests won't be traced when the filter returns false. I think it's a bit confusing here. The specific requests should be traced when the filter returns false based on the annotation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated the annotation