otgrpc

README

otgrpc

OpenTracing plugin for grpc.

Usage

Server

package main

import (
	"github.com/yuewokeji/opentracing-go-plugins/module/otgrpc"
	"google.golang.org/grpc"
	"net"
)

func main() {
	lis, err := net.Listen("tcp", ":8080")
	if err != nil {
		panic(err)
	}

	server := grpc.NewServer(
		grpc.UnaryInterceptor(otgrpc.NewUnaryServerInterceptor()),
	)

	if err := server.Serve(lis); err != nil {
		panic(err)
	}
}

Client

package main

import (
	"github.com/yuewokeji/opentracing-go-plugins/module/otgrpc"
	"google.golang.org/grpc"
)

func main() {
	// ...
	conn, err := grpc.Dial(":8080", grpc.WithUnaryInterceptor(
		otgrpc.NewUnaryClientInterceptor(),
	))

	// do something
}

Documentation

Index

• Variables
• func GetPeerAddr(ctx context.Context) string
• func NewUnaryClientInterceptor(options ...ClientOption) grpc.UnaryClientInterceptor
• func NewUnaryServerInterceptor(options ...ServerOption) grpc.UnaryServerInterceptor
• type ClientOption
  • func WithClientTracer(tracer opentracing.Tracer) ClientOption
• type MDReaderWriter
  • func (m MDReaderWriter) ForeachKey(handler func(key, val string) error) error
  • func (m MDReaderWriter) Set(key, val string)
• type RequestIgnorerFunc
• type ServerOption
  • func WithServerRequestIgnorer(r RequestIgnorerFunc) ServerOption
  • func WithServerTracer(tracer opentracing.Tracer) ServerOption

Variables

var (
	ComponentTag = opentracing.Tag{Key: string(ext.Component), Value: "grpc " + grpc.Version}
)

Functions

func GetPeerAddr

func GetPeerAddr(ctx context.Context) string

func NewUnaryClientInterceptor

func NewUnaryClientInterceptor(options ...ClientOption) grpc.UnaryClientInterceptor

func NewUnaryServerInterceptor

func NewUnaryServerInterceptor(options ...ServerOption) grpc.UnaryServerInterceptor

Types

type ClientOption

type ClientOption func(*clientOptions)

func WithClientTracer

func WithClientTracer(tracer opentracing.Tracer) ClientOption

type MDReaderWriter

type MDReaderWriter struct {
	metadata.MD
}

func (MDReaderWriter) ForeachKey

func (m MDReaderWriter) ForeachKey(handler func(key, val string) error) error

func (MDReaderWriter) Set

func (m MDReaderWriter) Set(key, val string)

type RequestIgnorerFunc

type RequestIgnorerFunc func(*grpc.UnaryServerInfo) bool

type ServerOption

type ServerOption func(*serverOptions)

func WithServerRequestIgnorer

func WithServerRequestIgnorer(r RequestIgnorerFunc) ServerOption

func WithServerTracer

func WithServerTracer(tracer opentracing.Tracer) ServerOption