README
¶
Package sql_tracing
Пакет sql_tracing предоставляет инструменты трассировки SQL-запросов для PostgreSQL-драйвера pgx с использованием OpenTelemetry. Поддерживает автоматическое создание span'ов, запись аргументов и SQL-выражений, а также метрики SQL-операций через sql_metrics.
Types
Tracer
Структура Tracer реализует интерфейс pgx.QueryTracer и обеспечивает создание и завершение span'ов при выполнении SQL-запросов. Позволяет гибко настраивать включение SQL-выражений и параметров в span'ы.
Methods:
NewTracer(tracer trace.Tracer, config Config) Tracer
Создаёт трейсер.
(t Tracer) TraceQueryStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceQueryStartData) context.Context
Создаёт span перед выполнением SQL-запроса. Возвращает новый context.Context с активным span.
(t Tracer) TraceQueryEnd(ctx context.Context, conn *pgx.Conn, data pgx.TraceQueryEndData)
Завершает span после выполнения SQL-запроса. В случае ошибки (кроме sql.ErrNoRows) записывает её в span и устанавливает статус Error.
Config
Структура Config содержит параметры конфигурации для трассировки SQL-запросов.
Fields:
Provider tracing.TracerProvider
Провайдер трассировки (по умолчанию tracing.DefaultProvider)
EnableStatement bool
Включает добавление SQL-выражения в атрибуты span'а
EnableArgs bool
Включает добавление аргументов запроса в атрибуты span'а
Methods
NewConfig() Config
Создаёт конфигурацию трассировки с провайдером по умолчанию.
(c Config) QueryTracer() pgx.QueryTracer
Возвращает либо полноценный трассировщик Tracer, либо noop, если провайдер трассировки является "заглушкой".
Usage
Подключение трассировки SQL-запросов
import (
"github.com/txix-open/isp-kit/observability/tracing"
"github.com/txix-open/isp-kit/observability/sql_tracing"
"github.com/jackc/pgx/v5"
)
func setupTracer() pgx.QueryTracer {
cfg := sql_tracing.NewConfig()
cfg.EnableStatement = true
cfg.EnableArgs = true
return cfg.QueryTracer()
}
Регистрация в pgx соединении
connConfig := pgx.ConnConfig{ /* ваша конфигурация */ }
connConfig.Tracer = setupTracer()
Теперь каждый SQL-запрос будет автоматически трассироваться с учётом включённых опций (запрос, параметры, request ID и т.п.).
Documentation
¶
Overview ¶
Package sql_tracing provides pgx v5 query tracing for distributed tracing.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var QueryParametersKey = attribute.Key("pgx.query.parameters")
QueryParametersKey is the attribute key for storing query arguments.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Provider is the tracer provider used to create tracers.
Provider tracing.TracerProvider
// EnableStatement determines whether to include SQL statements in spans.
EnableStatement bool
// EnableArgs determines whether to include query arguments in spans.
EnableArgs bool
}
Config holds the configuration for SQL query tracing.
func (Config) QueryTracer ¶
func (c Config) QueryTracer() pgx.QueryTracer
QueryTracer returns a pgx QueryTracer for instrumenting database queries. It returns a no-op tracer if the provider is a no-op.
type Tracer ¶
type Tracer struct {
// contains filtered or unexported fields
}
Tracer implements pgx.QueryTracer for tracing SQL queries.
func (Tracer) TraceQueryEnd ¶
TraceQueryEnd ends the span for a database query and records any errors. It skips recording errors for sql.ErrNoRows.
func (Tracer) TraceQueryStart ¶
func (t Tracer) TraceQueryStart(ctx context.Context, _ *pgx.Conn, data pgx.TraceQueryStartData) context.Context
TraceQueryStart creates a span for the beginning of a database query. It extracts the operation label from context or from the SQL statement (for BEGIN/COMMIT). The span includes the SQL statement and arguments if configured. Returns the context with the span attached.
Source Files