opentracing

README

opentracing

Opentracing tracer for Kitex

Server usage

import (
    ...
    "github.com/cloudwego/kitex/server"
    internal_opentracing "github.com/kitex-contrib/tracer-opentracing"
    ...
)

func main() {
    ...
    tracer := internal_opentracing.NewDefaultServerSuite()
    svr := echo.NewServer(new(EchoImpl), server.WithSuite(tracer))
    ...
}

DefaultServerOption will use opentracing global tracer as tracer, and {Service Name}::{Method Name} as operation name. You can customize both by ServerOption.

Client usage

import (
    ...
    "github.com/cloudwego/kitex/client"
    internal_opentracing "github.com/kitex-contrib/tracer-opentracing"
    ...
)

func main() {
    ...
    tracer := internal_opentracing.NewDefaultClientSuite()
    client, err := echo.NewClient("echo", client.WithSuite(tracer))
	if err != nil {
		log.Fatal(err)
	}
    ...
}

Just like server, DefaultClientOption will use opentracing global tracer as tracer, and {Service Name}::{Method Name} as operation name. You can customize both by ClientOption.

Example

Executable Example

Documentation

Overview

Package opentracing implements KiteX tracer with opentracing.

Index

• Constants
• func NewClientSuite(tracer opentracing.Tracer, formOperationName func(c context.Context) string) client.Suite
• func NewDefaultClientSuite() client.Suite
• func NewDefaultServerSuite() server.Suite
• func NewServerSuite(tracer opentracing.Tracer, formOperationName func(c context.Context) string) server.Suite
• func SpanContextExtractMW(next endpoint.Endpoint) endpoint.Endpoint
• func SpanContextInjectMW(next endpoint.Endpoint) endpoint.Endpoint

Constants

const (
	SpanContextKey = "JaegerSpanContext"
)

Functions

func NewClientSuite

func NewClientSuite(tracer opentracing.Tracer, formOperationName func(c context.Context) string) client.Suite

func NewDefaultClientSuite

func NewDefaultClientSuite() client.Suite

func NewDefaultServerSuite

func NewDefaultServerSuite() server.Suite

func NewServerSuite

func NewServerSuite(tracer opentracing.Tracer, formOperationName func(c context.Context) string) server.Suite

func SpanContextExtractMW

func SpanContextExtractMW(next endpoint.Endpoint) endpoint.Endpoint

func SpanContextInjectMW

func SpanContextInjectMW(next endpoint.Endpoint) endpoint.Endpoint