go.temporal.io/server@v1.23.0/common/telemetry/grpc.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package telemetry
    26  
    27  import (
    28  	"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
    29  	"go.opentelemetry.io/otel/propagation"
    30  	"go.opentelemetry.io/otel/trace"
    31  	"google.golang.org/grpc"
    32  )
    33  
    34  type (
    35  	// ServerTraceInterceptor gives a named type to the
    36  	// grpc.UnaryServerInterceptor implementation provided by otelgrpc
    37  	ServerTraceInterceptor grpc.UnaryServerInterceptor
    38  
    39  	// ClientTraceInterceptor gives a named type to the
    40  	// grpc.UnaryClientInterceptor implementation provided by otelgrpc
    41  	ClientTraceInterceptor grpc.UnaryClientInterceptor
    42  )
    43  
    44  // NewServerTraceInterceptor creates a new gRPC server interceptor that tracks
    45  // each request with an encapsulating span using the provided TracerProvider and
    46  // TextMapPropagator.
    47  func NewServerTraceInterceptor(
    48  	tp trace.TracerProvider,
    49  	tmp propagation.TextMapPropagator,
    50  ) ServerTraceInterceptor {
    51  	return ServerTraceInterceptor(
    52  		otelgrpc.UnaryServerInterceptor(
    53  			otelgrpc.WithPropagators(tmp),
    54  			otelgrpc.WithTracerProvider(tp),
    55  		),
    56  	)
    57  }
    58  
    59  // NewClientTraceInterceptor creates a new gRPC client interceptor that tracks
    60  // each request with an encapsulating span using the provided TracerProvider and
    61  // TextMapPropagator.
    62  func NewClientTraceInterceptor(
    63  	tp trace.TracerProvider,
    64  	tmp propagation.TextMapPropagator,
    65  ) ClientTraceInterceptor {
    66  	return ClientTraceInterceptor(
    67  		otelgrpc.UnaryClientInterceptor(
    68  			otelgrpc.WithPropagators(tmp),
    69  			otelgrpc.WithTracerProvider(tp),
    70  		),
    71  	)
    72  }