ocgrpc

Documentation

Overview

Package ocgrpc contains OpenCensus stats and trace integrations with gRPC.

Index

• func NewClientStatsHandler() stats.Handler
• func NewServerStatsHandler() stats.Handler

Examples

• NewClientStatsHandler
• NewServerStatsHandler

Functions

func NewClientStatsHandler

func NewClientStatsHandler() stats.Handler

NewClientStatsHandler enables OpenCensus stats and trace for gRPC clients. If these features need to be indiviually turned on, see grpcstats and grpctrace packages.

Example

package main

import (
	"log"

	"go.opencensus.io/plugin/ocgrpc"
	"go.opencensus.io/plugin/ocgrpc/grpcstats"
	"google.golang.org/grpc"
)

func main() {
	// Subscribe to collect client request count.
	if err := grpcstats.RPCClientRequestCountView.Subscribe(); err != nil {
		log.Fatal(err)
	}

	// Set up a connection to the server with the OpenCensus
	// stats handler to enable stats and tracing.
	conn, err := grpc.Dial("address", grpc.WithStatsHandler(ocgrpc.NewClientStatsHandler()))
	if err != nil {
		log.Fatalf("did not connect: %v", err)
	}
	defer conn.Close()
}

func NewServerStatsHandler

func NewServerStatsHandler() stats.Handler

NewServerStatsHandler enables OpenCensus stats and trace for gRPC servers. If these features need to be indiviually turned on, see grpcstats and grpctrace packages.

Example

package main

import (
	"log"

	"go.opencensus.io/plugin/ocgrpc"
	"go.opencensus.io/plugin/ocgrpc/grpcstats"
	"google.golang.org/grpc"
)

func main() {
	// Subscribe to collect server request count.
	if err := grpcstats.RPCServerRequestCountView.Subscribe(); err != nil {
		log.Fatal(err)
	}

	// Set up a new server with the OpenCensus
	// stats handler to enable stats and tracing.
	s := grpc.NewServer(grpc.StatsHandler(ocgrpc.NewServerStatsHandler()))
	_ = s // use s
}