mrtrace

Documentation

Index

• Constants
• func ExtractCorrelationID(ctx context.Context) string
• func ExtractKeysValues(ctx context.Context) (keyValue []any)
• func NewContextWithIDs(originalCtx context.Context) context.Context
• type ContextManager
  • func NewContextManager(idGenerator IdentifierGenerator) *ContextManager
  • func (e *ContextManager) CorrelationID(ctx context.Context) string
  • func (e *ContextManager) ExtractCorrelationID(ctx context.Context) string
  • func (e *ContextManager) ExtractKeysValues(ctx context.Context) []any
  • func (e *ContextManager) NewContextWithIDs(originalCtx context.Context) context.Context
  • func (e *ContextManager) ProcessID(ctx context.Context) string
  • func (e *ContextManager) RequestID(ctx context.Context) string
  • func (e *ContextManager) TaskID(ctx context.Context) string
  • func (e *ContextManager) TraceID(ctx context.Context) string
  • func (e *ContextManager) WithCorrelationID(ctx context.Context) context.Context
  • func (e *ContextManager) WithProcessID(ctx context.Context) context.Context
  • func (e *ContextManager) WithRequestID(ctx context.Context) context.Context
  • func (e *ContextManager) WithTaskID(ctx context.Context) context.Context
  • func (e *ContextManager) WithTraceID(ctx context.Context) context.Context
  • func (e *ContextManager) WithWorkerID(ctx context.Context) context.Context
  • func (e *ContextManager) WorkerID(ctx context.Context) string
• type IdentifierGenerator
• type IdentifierGeneratorFunc
  • func (f IdentifierGeneratorFunc) GenerateID() string
• type Tracer

Constants

const (
	// KeyTraceID - название ключа ID трейса.
	KeyTraceID = "trace_id"

	// KeyCorrelationID - название ключа ID корреляции.
	KeyCorrelationID = "correlation_id"

	// KeyRequestID - название ключа ID запроса.
	KeyRequestID = "request_id"

	// KeyProcessID - название ключа ID процесса.
	KeyProcessID = "process_id"

	// KeyWorkerID - название ключа ID воркера.
	KeyWorkerID = "worker_id"

	// KeyTaskID - название ключа ID задачи.
	KeyTaskID = "task_id"
)

Functions

func ExtractCorrelationID

func ExtractCorrelationID(ctx context.Context) string

ExtractCorrelationID - возвращает первый попавшийся ID из указанного контекста, который можно использовать в качестве CorrelationID.

func ExtractKeysValues

func ExtractKeysValues(ctx context.Context) (keyValue []any)

ExtractKeysValues - возвращает попарно (key/id-value) все имеющиеся ID процессов из указанного контекста.

func NewContextWithIDs

func NewContextWithIDs(originalCtx context.Context) context.Context

NewContextWithIDs - возвращает новый контекст содержащий только все ID процессы, скопированные из указанного контекста.

Types

type ContextManager

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

ContextManager - отвечает за установку ID процессов в контекст и за доступ к ним используемых в трейсинге.

func NewContextManager

func NewContextManager(idGenerator IdentifierGenerator) *ContextManager

NewContextManager - создаёт объект ContextManager.

func (*ContextManager) CorrelationID

func (e *ContextManager) CorrelationID(ctx context.Context) string

CorrelationID - возвращает результат вызова функции CorrelationID.

func (*ContextManager) ExtractCorrelationID

func (e *ContextManager) ExtractCorrelationID(ctx context.Context) string

ExtractCorrelationID - возвращает результат вызова функции ExtractCorrelationID.

func (*ContextManager) ExtractKeysValues

func (e *ContextManager) ExtractKeysValues(ctx context.Context) []any

ExtractKeysValues - возвращает результат вызова функции ExtractKeysValues.

func (*ContextManager) NewContextWithIDs

func (e *ContextManager) NewContextWithIDs(originalCtx context.Context) context.Context

NewContextWithIDs - возвращает результат вызова функции NewContextWithIDs.

func (*ContextManager) ProcessID

func (e *ContextManager) ProcessID(ctx context.Context) string

ProcessID - возвращает результат вызова функции ProcessID.

func (*ContextManager) RequestID

func (e *ContextManager) RequestID(ctx context.Context) string

RequestID - возвращает результат вызова функции RequestID.

func (*ContextManager) TaskID

func (e *ContextManager) TaskID(ctx context.Context) string

TaskID - возвращает результат вызова функции TaskID.

func (*ContextManager) TraceID

func (e *ContextManager) TraceID(ctx context.Context) string

TraceID - возвращает результат вызова функции TraceID.

func (*ContextManager) WithCorrelationID

func (e *ContextManager) WithCorrelationID(ctx context.Context) context.Context

WithCorrelationID - генерирует ID корреляции запроса и возвращает результат вызова функции WithCorrelationID.

func (*ContextManager) WithProcessID

func (e *ContextManager) WithProcessID(ctx context.Context) context.Context

WithProcessID - генерирует ID процесса и возвращает результат вызова функции WithRequestID.

func (*ContextManager) WithRequestID

func (e *ContextManager) WithRequestID(ctx context.Context) context.Context

WithRequestID - генерирует ID запроса и возвращает результат вызова функции WithRequestID.

func (*ContextManager) WithTaskID

func (e *ContextManager) WithTaskID(ctx context.Context) context.Context

WithTaskID - генерирует ID корреляции запроса и возвращает результат вызова функции WithCorrelationID.

func (*ContextManager) WithTraceID

func (e *ContextManager) WithTraceID(ctx context.Context) context.Context

WithTraceID - генерирует ID корреляции запроса и возвращает результат вызова функции WithTraceID.

func (*ContextManager) WithWorkerID

func (e *ContextManager) WithWorkerID(ctx context.Context) context.Context

WithWorkerID - генерирует ID воркера и возвращает результат вызова функции WithRequestID.

func (*ContextManager) WorkerID

func (e *ContextManager) WorkerID(ctx context.Context) string

WorkerID - возвращает результат вызова функции WorkerID.

type IdentifierGenerator

type IdentifierGenerator interface {
	GenerateID() string
}

IdentifierGenerator - генератор уникальных идентификаторов процессов используемых при трейсинге.

type IdentifierGeneratorFunc

type IdentifierGeneratorFunc func() string

IdentifierGeneratorFunc - реализация интерфейса IdentifierGenerator.

func (IdentifierGeneratorFunc) GenerateID

func (f IdentifierGeneratorFunc) GenerateID() string

GenerateID - реализация интерфейса IdentifierGenerator.

type Tracer

type Tracer interface {
	Enabled() bool
	Trace(ctx context.Context, args ...any)
}

Tracer - трейсер для фиксации запросов к сервисам и их ответов.