uptrace

Documentation

Index

• func ConfigureOpentelemetry(opts ...Option)
• func ForceFlush(ctx context.Context) error
• func ReportError(ctx context.Context, err error, opts ...trace.EventOption)
• func ReportPanic(ctx context.Context)
• func SetLogger(logger internal.ILogger)
• func Shutdown(ctx context.Context) error
• func TraceURL(span trace.Span) string
• func TracerProvider() *sdktrace.TracerProvider
• func Version() string
• type DSN
  • func ParseDSN(dsnStr string) (*DSN, error)
  • func (dsn *DSN) AppAddr() string
  • func (dsn *DSN) OTLPHost() string
  • func (dsn *DSN) String() string
• type MetricsOption
  • func WithMetricsDisabled() MetricsOption
  • func WithMetricsEnabled(on bool) MetricsOption
• type Option
  • func WithDSN(dsn string) Option
  • func WithDeploymentEnvironment(env string) Option
  • func WithResource(resource *resource.Resource) Option
  • func WithResourceAttributes(attrs []attribute.KeyValue) Option
  • func WithResourceDetectors(detectors ...resource.Detector) Option
  • func WithServiceName(serviceName string) Option
  • func WithServiceVersion(serviceVersion string) Option
• type TracingOption
  • func WithBatchSpanProcessorOption(opts ...sdktrace.BatchSpanProcessorOption) TracingOption
  • func WithPrettyPrintSpanExporter() TracingOption
  • func WithPropagator(propagator propagation.TextMapPropagator) TracingOption
  • func WithTextMapPropagator(propagator propagation.TextMapPropagator) TracingOption
  • func WithTraceSampler(sampler sdktrace.Sampler) TracingOption
  • func WithTracerProvider(provider *sdktrace.TracerProvider) TracingOption
  • func WithTracingDisabled() TracingOption
  • func WithTracingEnabled(on bool) TracingOption

Functions

func ConfigureOpentelemetry

func ConfigureOpentelemetry(opts ...Option)

ConfigureOpentelemetry configures OpenTelemetry to export data to Uptrace. By default it:

• creates tracer provider;
• registers Uptrace span exporter;
• sets tracecontext + baggage composite context propagator.

You can use UPTRACE_DISABLED env var to completely skip Uptrace configuration.

func ForceFlush

func ForceFlush(ctx context.Context) error

func ReportError

func ReportError(ctx context.Context, err error, opts ...trace.EventOption)

func ReportPanic

func ReportPanic(ctx context.Context)

func SetLogger

func SetLogger(logger internal.ILogger)

SetLogger sets the logger to the given one.

func Shutdown

func Shutdown(ctx context.Context) error

func TraceURL

func TraceURL(span trace.Span) string

func TracerProvider

func TracerProvider() *sdktrace.TracerProvider

func Version

func Version() string

Version is the current release version.

Types

type DSN

type DSN struct {
	Scheme string
	Host   string

	ProjectID string
	Token     string
	// contains filtered or unexported fields
}

func ParseDSN

func ParseDSN(dsnStr string) (*DSN, error)

func (*DSN) AppAddr

func (dsn *DSN) AppAddr() string

func (*DSN) OTLPHost

func (dsn *DSN) OTLPHost() string

func (*DSN) String

func (dsn *DSN) String() string

type MetricsOption

type MetricsOption interface {
	Option
	// contains filtered or unexported methods
}

func WithMetricsDisabled

func WithMetricsDisabled() MetricsOption

WithMetricsDisabled disables metrics.

func WithMetricsEnabled

func WithMetricsEnabled(on bool) MetricsOption

WithMetricsEnabled can be used to enable/disable metrics.

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithDSN

func WithDSN(dsn string) Option

WithDSN configures a data source name that is used to connect to Uptrace, for example, `https://<token>@api.uptrace.dev/<project_id>`.

The default is to use UPTRACE_DSN environment variable.

func WithDeploymentEnvironment

func WithDeploymentEnvironment(env string) Option

WithDeploymentEnvironment configures `deployment.environment` resource attribute, for example, `production`.

func WithResource

func WithResource(resource *resource.Resource) Option

WithResource configures a resource that describes an entity that produces telemetry, for example, such attributes as host.name and service.name. All produced spans and metrics will have these attributes.

WithResource overrides and replaces any other resource attributes.

func WithResourceAttributes

func WithResourceAttributes(attrs []attribute.KeyValue) Option

WithResourceAttributes configures resource attributes that describe an entity that produces telemetry, for example, such attributes as host.name, service.name, etc.

The default is to use `OTEL_RESOURCE_ATTRIBUTES` env var, for example, `OTEL_RESOURCE_ATTRIBUTES=service.name=myservice,service.version=1.0.0`.

func WithResourceDetectors

func WithResourceDetectors(detectors ...resource.Detector) Option

WithResourceDetectors adds detectors to be evaluated for the configured resource.

func WithServiceName

func WithServiceName(serviceName string) Option

WithServiceVersion configures `service.name` resource attribute.

func WithServiceVersion

func WithServiceVersion(serviceVersion string) Option

WithServiceVersion configures `service.version` resource attribute, for example, `1.0.0`.

type TracingOption

type TracingOption interface {
	Option
	// contains filtered or unexported methods
}

func WithBatchSpanProcessorOption

func WithBatchSpanProcessorOption(opts ...sdktrace.BatchSpanProcessorOption) TracingOption

WithBatchSpanProcessorOption specifies options used to created BatchSpanProcessor.

func WithPrettyPrintSpanExporter

func WithPrettyPrintSpanExporter() TracingOption

WithPrettyPrintSpanExporter adds a span exproter that prints spans to stdout. It is useful for debugging or demonstration purposes.

func WithPropagator

func WithPropagator(propagator propagation.TextMapPropagator) TracingOption

WithPropagator sets the global TextMapPropagator used by OpenTelemetry. The default is propagation.TraceContext and propagation.Baggage.

func WithTextMapPropagator

func WithTextMapPropagator(propagator propagation.TextMapPropagator) TracingOption

WithTextMapPropagator is an alias for WithPropagator.

func WithTraceSampler

func WithTraceSampler(sampler sdktrace.Sampler) TracingOption

WithTraceSampler configures a span sampler.

func WithTracerProvider

func WithTracerProvider(provider *sdktrace.TracerProvider) TracingOption

TracerProvider overwrites the default Uptrace tracer provider. You can use it to configure Uptrace distro to use OTLP exporter.

func WithTracingDisabled

func WithTracingDisabled() TracingOption

WithTracingDisabled disables tracing.

func WithTracingEnabled

func WithTracingEnabled(on bool) TracingOption

WithTracingEnabled can be used to enable/disable tracing.