forked from open-telemetry/opentelemetry-go-contrib
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
otelgrpc: add custom attributes to the stats handler
Fixes open-telemetry#3894
- Loading branch information
Showing
2 changed files
with
130 additions
and
79 deletions.
There are no files selected for viewing
76 changes: 76 additions & 0 deletions
76
instrumentation/google.golang.org/grpc/otelgrpc/grpccontext.go
This file contains 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,76 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package otelgrpc // import "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc" | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| // metricsInfo contains metrics information for an RPC. | ||
| type metricsInfo struct { | ||
| msgReceived int64 | ||
| msgSent int64 | ||
| } | ||
|
|
||
| // traceInfo contains tracing information for an RPC. | ||
| type traceInfo struct { | ||
| name string | ||
| kind trace.SpanKind | ||
| } | ||
|
|
||
| // gRPCContext contains all the information needed to record metrics and traces. | ||
| type gRPCContext struct { | ||
| metricsInfo *metricsInfo | ||
| traceInfo *traceInfo | ||
| attrs []attribute.KeyValue | ||
| record bool | ||
| } | ||
|
|
||
| // AddAttrs adds attributes to the given context. | ||
| func AddAttrs(ctx context.Context, attrs ...attribute.KeyValue) context.Context { | ||
| gctx, _ := gRPCContextFromContext(ctx) | ||
| gctx.addAttrs(attrs...) | ||
| return contextWithGRPCContext(ctx, gctx) | ||
| } | ||
|
|
||
| // add attributes to a gRPCContext. | ||
| func (g *gRPCContext) addAttrs(attrs ...attribute.KeyValue) { | ||
| g.attrs = append(g.attrs, attrs...) | ||
| } | ||
|
|
||
| type gRPCContextKey struct{} | ||
|
|
||
| // contextWithGRPCContext returns a new context with the provided gRPCContext attached. | ||
| func contextWithGRPCContext(ctx context.Context, gctx *gRPCContext) context.Context { | ||
| return context.WithValue(ctx, gRPCContextKey{}, gctx) | ||
| } | ||
|
|
||
| // gRPCContextFromContext retrieves a GRPCContext instance from the provided context if | ||
| // one is available. If no GRPCContext was found in the provided context a new, empty | ||
| // GRPCContext is returned and the second return value is false. In this case it is | ||
| // safe to use the GRPCContext but any attributes added to it will not be used. | ||
| func gRPCContextFromContext(ctx context.Context) (*gRPCContext, bool) { // nolint: revive | ||
| l, ok := ctx.Value(gRPCContextKey{}).(*gRPCContext) | ||
| if !ok { | ||
| l = &gRPCContext{ | ||
| metricsInfo: &metricsInfo{}, | ||
| traceInfo: &traceInfo{}, | ||
| } | ||
| } | ||
| return l, ok | ||
| } |
This file contains 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