grpc

package
v1.63.0-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 9, 2024 License: Apache-2.0, BSD-3-Clause, Apache-2.0 Imports: 38 Imported by: 78

Documentation

Overview

Package grpc provides functions to trace the google.golang.org/grpc package v1.2.

Example (Client) 
package main

import (
	"log"

	grpctrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/google.golang.org/grpc"

	"google.golang.org/grpc"
)

func main() {
	// Create the client interceptor using the grpc trace package.
	si := grpctrace.StreamClientInterceptor(grpctrace.WithServiceName("my-grpc-client"))
	ui := grpctrace.UnaryClientInterceptor(grpctrace.WithServiceName("my-grpc-client"))

	// Dial in using the created interceptor.
	// Note: To use multiple UnaryInterceptors with grpc.Dial, you must use
	// grpc.WithChainUnaryInterceptor instead (as of google.golang.org/grpc v1.51.0).
	conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure(),
		grpc.WithStreamInterceptor(si), grpc.WithUnaryInterceptor(ui))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()

	// And continue using the connection as normal.
}

Output:
Example (Server) 
package main

import (
	"log"
	"net"

	grpctrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/google.golang.org/grpc"

	"google.golang.org/grpc"
)

func main() {
	// Create a listener for the server.
	ln, err := net.Listen("tcp", ":50051")
	if err != nil {
		log.Fatal(err)
	}

	// Create the server interceptor using the grpc trace package.
	si := grpctrace.StreamServerInterceptor(grpctrace.WithServiceName("my-grpc-server"))
	ui := grpctrace.UnaryServerInterceptor(grpctrace.WithServiceName("my-grpc-server"))

	// Initialize the grpc server as normal, using the tracing interceptor.
	s := grpc.NewServer(grpc.StreamInterceptor(si), grpc.UnaryInterceptor(ui))

	// ... register your services

	// Start serving incoming connections.
	if err := s.Serve(ln); err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

Output:

Index

Examples

Constants

View Source 
const (
	Fixture_Ping_FullMethodName       = "/grpc.Fixture/Ping"
	Fixture_StreamPing_FullMethodName = "/grpc.Fixture/StreamPing"
)

Variables

View Source 
var File_fixtures_test_proto protoreflect.FileDescriptor
View Source 
var Fixture_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "grpc.Fixture",
	HandlerType: (*FixtureServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Ping",
			Handler:    _Fixture_Ping_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamPing",
			Handler:       _Fixture_StreamPing_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "fixtures_test.proto",
}

Fixture_ServiceDesc is the grpc.ServiceDesc for Fixture service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func NewClientStatsHandler added in v1.11.0 

func NewClientStatsHandler(opts ...Option) stats.Handler

NewClientStatsHandler returns a gRPC client stats.Handler to trace RPC calls.

func NewServerStatsHandler added in v1.11.0 

func NewServerStatsHandler(opts ...Option) stats.Handler

NewServerStatsHandler returns a gRPC server stats.Handler to trace RPC calls.

func RegisterFixtureServer 

func RegisterFixtureServer(s grpc.ServiceRegistrar, srv FixtureServer)

func StreamClientInterceptor added in v1.1.0 

func StreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor

StreamClientInterceptor returns a grpc.StreamClientInterceptor which will trace client streams using the given set of options.

func StreamServerInterceptor added in v1.1.0 

func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor

StreamServerInterceptor will trace streaming requests to the given gRPC server.

func UnaryClientInterceptor 

func UnaryClientInterceptor(opts ...Option) grpc.UnaryClientInterceptor

UnaryClientInterceptor returns a grpc.UnaryClientInterceptor which will trace requests using the given set of options.

func UnaryServerInterceptor 

func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor

UnaryServerInterceptor will trace requests to the given grpc server.

Types

type FixtureClient 

type FixtureClient interface {
	Ping(ctx context.Context, in *FixtureRequest, opts ...grpc.CallOption) (*FixtureReply, error)
	StreamPing(ctx context.Context, opts ...grpc.CallOption) (Fixture_StreamPingClient, error)
}

FixtureClient is the client API for Fixture service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewFixtureClient 

func NewFixtureClient(cc grpc.ClientConnInterface) FixtureClient

type FixtureReply 

type FixtureReply struct {
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The response message containing the greetings

func (*FixtureReply) Descriptor deprecated 

func (*FixtureReply) Descriptor() ([]byte, []int)

Deprecated: Use FixtureReply.ProtoReflect.Descriptor instead.

func (*FixtureReply) GetMessage 

func (x *FixtureReply) GetMessage() string

func (*FixtureReply) ProtoMessage 

func (*FixtureReply) ProtoMessage()

func (*FixtureReply) ProtoReflect added in v1.55.0 

func (x *FixtureReply) ProtoReflect() protoreflect.Message

func (*FixtureReply) Reset 

func (x *FixtureReply) Reset()

func (*FixtureReply) String 

func (x *FixtureReply) String() string

type FixtureRequest 

type FixtureRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request message containing the user's name.

func (*FixtureRequest) Descriptor deprecated 

func (*FixtureRequest) Descriptor() ([]byte, []int)

Deprecated: Use FixtureRequest.ProtoReflect.Descriptor instead.

func (*FixtureRequest) GetName 

func (x *FixtureRequest) GetName() string

func (*FixtureRequest) ProtoMessage 

func (*FixtureRequest) ProtoMessage()

func (*FixtureRequest) ProtoReflect added in v1.55.0 

func (x *FixtureRequest) ProtoReflect() protoreflect.Message

func (*FixtureRequest) Reset 

func (x *FixtureRequest) Reset()

func (*FixtureRequest) String 

func (x *FixtureRequest) String() string

type FixtureServer 

type FixtureServer interface {
	Ping(context.Context, *FixtureRequest) (*FixtureReply, error)
	StreamPing(Fixture_StreamPingServer) error
	// contains filtered or unexported methods
}

FixtureServer is the server API for Fixture service. All implementations must embed UnimplementedFixtureServer for forward compatibility

type Fixture_StreamPingClient added in v1.1.0 

type Fixture_StreamPingClient interface {
	Send(*FixtureRequest) error
	Recv() (*FixtureReply, error)
	grpc.ClientStream
}

type Fixture_StreamPingServer added in v1.1.0 

type Fixture_StreamPingServer interface {
	Send(*FixtureReply) error
	Recv() (*FixtureRequest, error)
	grpc.ServerStream
}

type InterceptorOption 

type InterceptorOption = Option

InterceptorOption represents an option that can be passed to the grpc unary client and server interceptors. InterceptorOption is deprecated in favor of Option.

func NonErrorCodes added in v1.12.0 

func NonErrorCodes(cs ...codes.Code) InterceptorOption

NonErrorCodes determines the list of codes which will not be considered errors in instrumentation. This call overrides the default handling of codes.Canceled as a non-error.

type Option added in v1.11.0 

type Option func(*config)

Option specifies a configuration option for the grpc package. Not all options apply to all instrumented structures.

func NoDebugStack added in v1.5.0 

func NoDebugStack() Option

NoDebugStack disables debug stacks for traces with errors. This is useful in situations where errors are frequent and the overhead of calling debug.Stack may affect performance.

func WithAnalytics added in v1.11.0 

func WithAnalytics(on bool) Option

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate added in v1.11.0 

func WithAnalyticsRate(rate float64) Option

WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.

func WithCustomTag added in v1.42.0 

func WithCustomTag(key string, value interface{}) Option

WithCustomTag will attach the value to the span tagged by the key.

func WithErrorDetailTags added in v1.60.0 

func WithErrorDetailTags() Option

WithErrorDetailTags specifies whether gRPC responses details contain should be added to spans as tags.

func WithIgnoredMetadata added in v1.25.0 

func WithIgnoredMetadata(ms ...string) Option

WithIgnoredMetadata specifies keys to be ignored while tracing the metadata. Must be used in conjunction with WithMetadataTags.

func WithIgnoredMethods deprecated added in v1.24.0 

func WithIgnoredMethods(ms ...string) Option

WithIgnoredMethods specifies full methods to be ignored by the server side interceptor. When an incoming request's full method is in ms, no spans will be created.

Deprecated: This is deprecated in favor of WithUntracedMethods which applies to both the server side and client side interceptors.

func WithMetadataTags added in v1.25.0 

func WithMetadataTags() Option

WithMetadataTags specifies whether gRPC metadata should be added to spans as tags.

func WithRequestTags added in v1.25.0 

func WithRequestTags() Option

WithRequestTags specifies whether gRPC requests should be added to spans as tags.

func WithServiceName 

func WithServiceName(name string) Option

WithServiceName sets the given service name for the intercepted client.

func WithSpanOptions added in v1.49.0 

func WithSpanOptions(opts ...ddtrace.StartSpanOption) Option

WithSpanOptions defines a set of additional ddtrace.StartSpanOption to be added to spans started by the integration.

func WithStreamCalls added in v1.1.0 

func WithStreamCalls(enabled bool) Option

WithStreamCalls enables or disables tracing of streaming calls. This option does not apply to the stats handler.

func WithStreamMessages added in v1.1.0 

func WithStreamMessages(enabled bool) Option

WithStreamMessages enables or disables tracing of streaming messages. This option does not apply to the stats handler.

func WithUntracedMethods added in v1.44.0 

func WithUntracedMethods(ms ...string) Option

WithUntracedMethods specifies full methods to be ignored by the server side and client side interceptors. When a request's full method is in ms, no spans will be created.

type UnimplementedFixtureServer added in v1.55.0 

type UnimplementedFixtureServer struct {
}

UnimplementedFixtureServer must be embedded to have forward compatible implementations.

func (UnimplementedFixtureServer) Ping added in v1.55.0 

func (UnimplementedFixtureServer) Ping(context.Context, *FixtureRequest) (*FixtureReply, error)

func (UnimplementedFixtureServer) StreamPing added in v1.55.0 

func (UnimplementedFixtureServer) StreamPing(Fixture_StreamPingServer) error

type UnsafeFixtureServer added in v1.55.0 

type UnsafeFixtureServer interface {
	// contains filtered or unexported methods
}

UnsafeFixtureServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to FixtureServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.