grpcutil

Documentation

Index

• Constants
• func ClientIP(md metadata.MD) string
• func ClientName(md metadata.MD) string
• func ContextWithStats(ctx context.Context, stats *GRPCStats) context.Context
• func EnableAdmin(s grpc.ServiceRegistrar) (cleanup func(), _ error)
• func EnableDebug(s *grpc.Server)
• func EnableHealth(srv string, s *grpc.Server)
• func EnableReflection(s *grpc.Server)
• func HeaderGet(h Header, name string) string
• func IsGRPCRequest(r *http.Request) bool
• func ListGRPCResources(server *grpc.Server) []string
• func WithClientApp(ctx context.Context, name string) context.Context
• func WithClientIp(ctx context.Context, ip string) context.Context
• type GRPCStats
  • func StatsFromContext(ctx context.Context) *GRPCStats
• type GRPCStatsHandler
  • func NewGRPCStatsHandler() *GRPCStatsHandler
  • func (c *GRPCStatsHandler) Close()
  • func (c *GRPCStatsHandler) Collect(ch chan<- prometheus.Metric)
  • func (c *GRPCStatsHandler) Describe(ch chan<- *prometheus.Desc)
  • func (c *GRPCStatsHandler) HandleConn(ctx context.Context, s stats.ConnStats)
  • func (c *GRPCStatsHandler) HandleRPC(ctx context.Context, s stats.RPCStats)
  • func (c *GRPCStatsHandler) TagConn(ctx context.Context, _ *stats.ConnTagInfo) context.Context
  • func (c *GRPCStatsHandler) TagRPC(ctx context.Context, tagInfo *stats.RPCTagInfo) context.Context
• type Header

Constants

const (
	DefaultContentType = "application/grpc"
	DefaultTimeout     = time.Second * 2
)

const (
	ClientNameKey     = "client-name"
	ClientIpKey       = "client-ip"
	ClientHostnameKey = "client-hostname"
	ClientPathKey     = "client-path"
	ClientVersionKey  = "client-version"
)

Functions

func ClientIP

func ClientIP(md metadata.MD) string

ClientIP 获取对端ip

func ClientName

func ClientName(md metadata.MD) string

ClientName 获取对端应用名称

func ContextWithStats

func ContextWithStats(ctx context.Context, stats *GRPCStats) context.Context

ContextWithStats Returns a new `context.Context` that holds a reference to `GRPCStats`.

func EnableAdmin

func EnableAdmin(s grpc.ServiceRegistrar) (cleanup func(), _ error)

func EnableDebug

func EnableDebug(s *grpc.Server)

func EnableHealth

func EnableHealth(srv string, s *grpc.Server)

func EnableReflection

func EnableReflection(s *grpc.Server)

func HeaderGet

func HeaderGet(h Header, name string) string

func IsGRPCRequest

func IsGRPCRequest(r *http.Request) bool

IsGRPCRequest returns true if the message is considered to be a GRPC message

func ListGRPCResources

func ListGRPCResources(server *grpc.Server) []string

ListGRPCResources is a helper function that lists all URLs that are registered on gRPC server.

This makes it easy to register all the relevant routes in your HTTP router of choice.

func WithClientApp

func WithClientApp(ctx context.Context, name string) context.Context

WithClientApp 获取对端应用名称

func WithClientIp

func WithClientIp(ctx context.Context, ip string) context.Context

Types

type GRPCStats

type GRPCStats struct {
	Duration clock.Duration
	Method   string
	Failed   float64
	Success  float64
}

func StatsFromContext

func StatsFromContext(ctx context.Context) *GRPCStats

StatsFromContext Returns the `GRPCStats` previously associated with `ctx`.

type GRPCStatsHandler

type GRPCStatsHandler struct {
	// contains filtered or unexported fields
}

GRPCStatsHandler Implements the Prometheus collector interface. Such that when the /metrics handler is called this collector pulls all the stats from

func NewGRPCStatsHandler

func NewGRPCStatsHandler() *GRPCStatsHandler

func (*GRPCStatsHandler) Close

func (c *GRPCStatsHandler) Close()

func (*GRPCStatsHandler) Collect

func (c *GRPCStatsHandler) Collect(ch chan<- prometheus.Metric)

func (*GRPCStatsHandler) Describe

func (c *GRPCStatsHandler) Describe(ch chan<- *prometheus.Desc)

func (*GRPCStatsHandler) HandleConn

func (c *GRPCStatsHandler) HandleConn(ctx context.Context, s stats.ConnStats)

func (*GRPCStatsHandler) HandleRPC

func (c *GRPCStatsHandler) HandleRPC(ctx context.Context, s stats.RPCStats)

func (*GRPCStatsHandler) TagConn

func (c *GRPCStatsHandler) TagConn(ctx context.Context, _ *stats.ConnTagInfo) context.Context

func (*GRPCStatsHandler) TagRPC

func (c *GRPCStatsHandler) TagRPC(ctx context.Context, tagInfo *stats.RPCTagInfo) context.Context

type Header

type Header = metadata.MD