ydb

README

ydb_opentelemetry adapter

Opentelemetry traces over ydb-go-sdk events

Usage

import (
    "github.com/ydb-platform/ydb-go-sdk/v3"
    "github.com/ydb-platform/ydb-go-sdk/v3/trace"
    jaegerConfig "github.com/uber/jaeger-client-go/config"
	
    ydbOtel "github.com/ydb-platform/ydb-go-sdk-otel"
)

...
    // init jaeger client
    tracer, closer, err := jaegerConfig.Configuration{
        ServiceName: serviceName,
        Sampler: &jaegerConfig.SamplerConfig{
            Type:  "const",
            Param: 1,
        },
        Reporter: &jaegerConfig.ReporterConfig{
            LogSpans:            true,
            BufferFlushInterval: 1 * time.Second,
            LocalAgentHostPort:  tracerURL,
        },
    }.NewTracer()
    if err != nil {
        panic(err)
    }

    db, err := ydb.Open(
        ctx,
        os.Getenv("YDB_CONNECTION_STRING"),
        ydbOtel.WithTraces(
            tracer,
            ydbOtel.WithDetails(trace.DetailsAll),
        ),
    )

Documentation

Index

• func Coordination(cfg *config) (t trace.Coordination)
• func DatabaseSQL(cfg *config) (t trace.DatabaseSQL)
• func Discovery(cfg *config) (t trace.Discovery)
• func Driver(cfg *config) (t trace.Driver)
• func Ratelimiter(cfg *config) (t trace.Ratelimiter)
• func Retry(tracer otelTrace.Tracer, d Detailer) (t trace.Retry)
• func Scheme(cfg *config) (t trace.Scheme)
• func Scripting(cfg *config) (t trace.Scripting)
• func Table(cfg *config) (t trace.Table)
• func WithTraces(opts ...Option) ydb.Option
• type Detailer
• type Option
  • func WithDetailer(d Detailer) Option
  • func WithDetails(d trace.Details) Option
  • func WithTracer(tracer otelTrace.Tracer) Option

Functions

func Coordination

func Coordination(cfg *config) (t trace.Coordination)

func DatabaseSQL

func DatabaseSQL(cfg *config) (t trace.DatabaseSQL)

DatabaseSQL makes trace.DatabaseSQL with logging events from details

func Discovery

func Discovery(cfg *config) (t trace.Discovery)

func Driver

func Driver(cfg *config) (t trace.Driver)

Driver makes Driver with publishing traces

func Ratelimiter

func Ratelimiter(cfg *config) (t trace.Ratelimiter)

func Retry

func Retry(tracer otelTrace.Tracer, d Detailer) (t trace.Retry)

func Scheme

func Scheme(cfg *config) (t trace.Scheme)

func Scripting

func Scripting(cfg *config) (t trace.Scripting)

func Table

func Table(cfg *config) (t trace.Table)

Table makes table.ClientTrace with solomon metrics publishing

func WithTraces

func WithTraces(opts ...Option) ydb.Option

Types

type Detailer

type Detailer interface {
	Details() trace.Details
}

type Option

type Option func(c *config)

func WithDetailer

func WithDetailer(d Detailer) Option

func WithDetails

func WithDetails(d trace.Details) Option

func WithTracer

func WithTracer(tracer otelTrace.Tracer) Option