grpc

Documentation

Overview

Package grpc is a generated protocol buffer package.

It is generated from these files:

fixtures_test.proto

It has these top-level messages:

FixtureRequest
FixtureReply

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.v12"

	"google.golang.org/grpc"
)

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

	// Dial in using the created interceptor...
	conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure(), grpc.WithUnaryInterceptor(i))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()

	// And continue using the connection as normal.
}

Example (Server)

package main

import (
	"log"
	"net"

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

	"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 unary server interceptor using the grpc trace package.
	i := grpctrace.UnaryServerInterceptor(grpctrace.WithServiceName("my-grpc-client"))

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

	// ... register your services

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

Index

• func RegisterFixtureServer(s *grpc1.Server, srv FixtureServer)
• func UnaryClientInterceptor(opts ...InterceptorOption) grpc.UnaryClientInterceptor
• func UnaryServerInterceptor(opts ...InterceptorOption) grpc.UnaryServerInterceptor
• type FixtureClient
  • func NewFixtureClient(cc *grpc1.ClientConn) FixtureClient
• type FixtureReply
  • func (*FixtureReply) Descriptor() ([]byte, []int)
  • func (m *FixtureReply) GetMessage() string
  • func (*FixtureReply) ProtoMessage()
  • func (m *FixtureReply) Reset()
  • func (m *FixtureReply) String() string
• type FixtureRequest
  • func (*FixtureRequest) Descriptor() ([]byte, []int)
  • func (m *FixtureRequest) GetName() string
  • func (*FixtureRequest) ProtoMessage()
  • func (m *FixtureRequest) Reset()
  • func (m *FixtureRequest) String() string
• type FixtureServer
• type InterceptorOption
  • func WithAnalytics(on bool) InterceptorOption
  • func WithAnalyticsRate(rate float64) InterceptorOption
  • func WithServiceName(name string) InterceptorOption
  • func WithSpanOptions(opts ...ddtrace.StartSpanOption) InterceptorOption

Examples

• Package (Client)
• Package (Server)

Functions

func RegisterFixtureServer

func RegisterFixtureServer(s *grpc1.Server, srv FixtureServer)

func UnaryClientInterceptor

func UnaryClientInterceptor(opts ...InterceptorOption) grpc.UnaryClientInterceptor

UnaryClientInterceptor will add tracing to a grpc client.

func UnaryServerInterceptor

func UnaryServerInterceptor(opts ...InterceptorOption) grpc.UnaryServerInterceptor

UnaryServerInterceptor will trace requests to the given grpc server.

Types

type FixtureClient

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

func NewFixtureClient

func NewFixtureClient(cc *grpc1.ClientConn) FixtureClient

type FixtureReply

type FixtureReply struct {
	Message string `protobuf:"bytes,1,opt,name=message" json:"message,omitempty"`
}

The response message containing the greetings

func (*FixtureReply) Descriptor

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

func (*FixtureReply) GetMessage

func (m *FixtureReply) GetMessage() string

func (*FixtureReply) ProtoMessage

func (*FixtureReply) ProtoMessage()

func (*FixtureReply) Reset

func (m *FixtureReply) Reset()

func (*FixtureReply) String

func (m *FixtureReply) String() string

type FixtureRequest

type FixtureRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}

The request message containing the user's name.

func (*FixtureRequest) Descriptor

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

func (*FixtureRequest) GetName

func (m *FixtureRequest) GetName() string

func (*FixtureRequest) ProtoMessage

func (*FixtureRequest) ProtoMessage()

func (*FixtureRequest) Reset

func (m *FixtureRequest) Reset()

func (*FixtureRequest) String

func (m *FixtureRequest) String() string

type FixtureServer

type FixtureServer interface {
	Ping(context.Context, *FixtureRequest) (*FixtureReply, error)
}

type InterceptorOption

type InterceptorOption func(*interceptorConfig)

InterceptorOption represents an option that can be passed to the grpc unary client and server interceptors.

func WithAnalytics

func WithAnalytics(on bool) InterceptorOption

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate

func WithAnalyticsRate(rate float64) InterceptorOption

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

func WithServiceName

func WithServiceName(name string) InterceptorOption

WithServiceName sets the given service name for the intercepted client.

func WithSpanOptions

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

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