trace

Documentation

Index

• type CloudTraceTracerProvider
  • func (c CloudTraceTracerProvider) Tracer(ctx context.Context) (trace.Tracer, func(context.Context) error, error)
• type CloudTraceTracerProviderParams
• type JaegerTracerProvider
  • func (c JaegerTracerProvider) Tracer(ctx context.Context) (trace.Tracer, func(context.Context) error, error)
• type JaegerTracerProviderParams
• type TraceClient
  • func MustNewTraceClient(params TraceClientParams) *TraceClient
  • func NewTraceClient(params TraceClientParams) (*TraceClient, error)
  • func (c TraceClient) Tracer(ctx context.Context) (trace.Tracer, func(context.Context) error)
• type TraceClientParams
• type TracerProvider
  • func MustNewCloudTraceTracerProvider(params CloudTraceTracerProviderParams) TracerProvider
  • func MustNewJaegerTracerProvider(params JaegerTracerProviderParams) TracerProvider
  • func NewCloudTraceTracerProvider(params CloudTraceTracerProviderParams) (TracerProvider, error)
  • func NewJaegerTracerProvider(params JaegerTracerProviderParams) (TracerProvider, error)

Types

type CloudTraceTracerProvider

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

CloudTraceTracerProvider creates CloudTrace tracers.

func (CloudTraceTracerProvider) Tracer

func (c CloudTraceTracerProvider) Tracer(ctx context.Context) (trace.Tracer, func(context.Context) error, error)

Tracer produces a new CloudTrace tracer and a Flush function. The flush function is designed to flush all pending tracer into provider. Usually used during application's shutdown.

type CloudTraceTracerProviderParams

type CloudTraceTracerProviderParams struct {
	ApplicationName    string
	ApplicationVersion string
	ProjectID          string

	// TraceRatio indicates how often the system should collect traces.
	// Use it with caution: It may overload the system and also be too expensive to mantain its value too high in a high throwput system
	// Values vary between 0 and 1, with 0 meaning No Sampling and 1 meaning Always Sampling.
	// Values lower than 0 are treated as 0 and values greater than 1 are treated as 1.
	TraceRatio float64
}

CloudTraceTracerProviderParams encapsulates the necessary parameters to initialize a CloudTraceTracerProvider.

type JaegerTracerProvider

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

JaegerTracerProvider creates Jaeger tracers.

func (JaegerTracerProvider) Tracer

func (c JaegerTracerProvider) Tracer(ctx context.Context) (trace.Tracer, func(context.Context) error, error)

Tracer produces a new Jaeger tracer and a Flush function. The flush function is designed to flush all pending tracer into provider. Usually used during application's shutdown.

type JaegerTracerProviderParams

type JaegerTracerProviderParams struct {
	ApplicationName    string
	ApplicationVersion string
	Endpoint           string

	// TraceRatio indicates how often the system should collect traces.
	// Use it with caution: It may overload the system and also be too expensive to mantain its value too high in a high throwput system
	// Values vary between 0 and 1, with 0 meaning No Sampling and 1 meaning Always Sampling.
	// Values lower than 0 are treated as 0 and values greater than 1 are treated as 1.
	TraceRatio float64
}

JaegerTracerProviderParams encapsulates the necessary parameters to initialize a JaegerTracerProvider.

type TraceClient

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

TraceClient creates Trace tracers.

func MustNewTraceClient

func MustNewTraceClient(params TraceClientParams) *TraceClient

MustNewTraceClient create a new instance of a TraceClient. It panics if any error is found.

func NewTraceClient

func NewTraceClient(params TraceClientParams) (*TraceClient, error)

NewTraceClient create a new instance of a TraceClient.

func (TraceClient) Tracer

func (c TraceClient) Tracer(ctx context.Context) (trace.Tracer, func(context.Context) error)

Tracer produces a new Trace tracer and a Flush function. The flush function is designed to flush all pending tracer into provider. Usually used during application's shutdown.

type TraceClientParams

type TraceClientParams struct {
	ApplicationName    string
	ApplicationVersion string
	Exporter           sdktrace.SpanExporter

	// TraceRatio indicates how often the system should collect traces.
	// Use it with caution: It may overload the system and also be too expensive to mantain its value too high in a high throwput system
	// Values vary between 0 and 1, with 0 meaning No Sampling and 1 meaning Always Sampling.
	// Values lower than 0 are treated as 0 and values greater than 1 are treated as 1.
	TraceRatio float64
}

TraceClientParams encapsulates the necessary parameters to initialize a TraceClient.

type TracerProvider

type TracerProvider interface {
	// Tracer produces a new Trace tracer and a Flush function.
	// The flush function is designed to flush all pending tracer into provider. Usually used during application's shutdown.
	Tracer(context.Context) (trace.Tracer, func(context.Context) error, error)
}

TracerProvider defines how providers of Traces should behavior.

func MustNewCloudTraceTracerProvider

func MustNewCloudTraceTracerProvider(params CloudTraceTracerProviderParams) TracerProvider

MustNewCloudTraceTracerProvider create a new instance of a CloudTraceTracerProvider. It panics if any error is found.

func MustNewJaegerTracerProvider

func MustNewJaegerTracerProvider(params JaegerTracerProviderParams) TracerProvider

MustNewJaegerTracerProvider create a new instance of a JaegerTracerProvider. It panics if any error is found.

func NewCloudTraceTracerProvider

func NewCloudTraceTracerProvider(params CloudTraceTracerProviderParams) (TracerProvider, error)

NewCloudTraceTracerProvider create a new instance of a CloudTraceTracerProvider.

func NewJaegerTracerProvider

func NewJaegerTracerProvider(params JaegerTracerProviderParams) (TracerProvider, error)

NewJaegerTracerProvider create a new instance of a JaegerTracerProvider.