opencensus

README

Go Agent for OpenCensus

Go Agent provides a set of complementary features for OpenCensus instrumentation

Package net/http

HTTP server

The server instrumentation relies on the http.Handler component of the server declarations.

import (
    "net/http"

    "github.com/gorilla/mux"
    "github.com/hypertrace/goagent/instrumentation/opencensus/net/hyperhttp"
	ochttp "go.opencensus.io/plugin/ochttp"
)

func main() {
    // ...

    r := mux.NewRouter()
    r.Handle("/foo/{bar}", &ochttp.Handler{
        Handler: hyperhttp.WrapHandler(http.HandlerFunc(fooHandler)),
    })

    // ...
}

HTTP client

The client instrumentation relies on the http.Transport component of the HTTP client in Go.

import (
    "net/http"
    "github.com/hypertrace/goagent/instrumentation/net/hyperhttp"
    "go.opencensus.io/plugin/ochttp"
)

// ...

client := http.Client{
    Transport: &ochttp.Transport{
        Base: hyperhttp.WrapTransport(http.DefaultTransport),
    },
}

req, _ := http.NewRequest("GET", "http://example.com", nil)

res, err := client.Do(req)

// ...

Running HTTP examples

In terminal 1 run the client:

go run ./net/hyperhttp/examples/client/main.go

In terminal 2 run the server:

go run ./net/hyperhttp/examples/server/main.go

Package google.golang.org/grpc

GRPC server

The server instrumentation relies on the grpc.UnaryServerInterceptor component of the server declarations.

import (
    // ...

    "github.com/hypertrace/goagent/instrumentation/opencensus/google.golang.org/hypergrpc"
    "go.opencensus.io/plugin/ocgrpc"
    "google.golang.org/grpc"
)


server := grpc.NewServer(
    grpc.UnaryInterceptor(
        grpc.StatsHandler(hypergrpc.WrapServerHandler(&ocgrpc.ServerHandler{})),
    ),
)

GRPC client

The client instrumentation relies on the http.Transport component of the HTTP client in Go.

import (
    // ...

    "github.com/hypertrace/goagent/instrumentation/google.golang.org/hypergrpc"
    "go.opencensus.io/plugin/ocgrpc"
    "google.golang.org/grpc"
)

func main() {
    // ...
    conn, err := grpc.Dial(
        address,
        grpc.WithInsecure(),
        grpc.WithBlock(),
        grpc.WithStatsHandler(hypergrpc.WrapClientHandler(&ocgrpc.ClientHandler{})),
    )
    if err != nil {
        log.Fatalf("could not dial: %v", err)
    }
    defer conn.Close()

    client := pb.NewCustomClient(conn)

    // ...
}

Running GRPC examples

In terminal 1 run the client:

go run ./google.golang.org/hypergrpc/examples/client/main.go

In terminal 2 run the server:

go run ./google.golang.org/hypergrpc/examples/server/main.go

Documentation

Index

• func Init(cfg *config.AgentConfig) func()
• func SpanFromContext(ctx context.Context) sdk.Span
• func StartSpan(ctx context.Context, name string, opts *sdk.SpanOptions) (context.Context, sdk.Span, func())
• type Span
  • func (s *Span) IsNoop() bool
  • func (s *Span) SetAttribute(key string, value interface{})
  • func (s *Span) SetError(err error)
  • func (s *Span) SetStatus(code sdk.Code, message string)

Examples

• Init

Functions

func Init

func Init(cfg *config.AgentConfig) func()

Init initializes opencensus tracing and returns a shutdown function to flush data immediately on a termination signal.

Example

cfg := config.Load()
cfg.ServiceName = config.String("my_example_svc")
cfg.DataCapture.HttpHeaders.Request = config.Bool(true)
cfg.Reporting.Endpoint = config.String("https://api.traceable.ai:9411/api/v2/spans")

shutdown := Init(cfg)
defer shutdown()

func SpanFromContext

func SpanFromContext(ctx context.Context) sdk.Span

func StartSpan

func StartSpan(ctx context.Context, name string, opts *sdk.SpanOptions) (context.Context, sdk.Span, func())

Types

type Span

type Span struct {
	*trace.Span
}

func (*Span) IsNoop

func (s *Span) IsNoop() bool

func (*Span) SetAttribute

func (s *Span) SetAttribute(key string, value interface{})

func (*Span) SetError

func (s *Span) SetError(err error)

func (*Span) SetStatus

func (s *Span) SetStatus(code sdk.Code, message string)

Borrowed from https://github.com/open-telemetry/opentelemetry-go/blob/d18c13/bridge/opencensus/internal/span.go#L75