go.opencensus.iogo.opencensus.io/plugin/grpc Index | Examples | Files | Directories

package grpc

import "go.opencensus.io/plugin/grpc"

Package grpc contains OpenCensus stats and trace integrations with gRPC.

Index

Examples

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

Code:play 

package main

import (
	"log"

	ocgrpc "go.opencensus.io/plugin/grpc"
	"go.opencensus.io/plugin/grpc/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

Code:play 

package main

import (
	"log"

	ocgrpc "go.opencensus.io/plugin/grpc"
	"go.opencensus.io/plugin/grpc/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
}

Source Files

grpc.go

Directories

PathSynopsis
plugin/grpc/grpcstatsPackage grpcstats provides OpenCensus stats support for gRPC clients and servers.
plugin/grpc/grpctracePackage grpctrace is a package to assist with tracing incoming and outgoing gRPC requests.
Version
v0.2.0
Published
Jan 30, 2018
Platform
js/wasm
Imports
4 packages
Last checked
45 minutes ago

Tools for package owners.