tracygo

README

TracyGo

INFO

TracyGo provides functionality for tracing a correlation identifier through multiple go microservices.

The library includes middlewares for the following frameworks:

• Atreugo
• Fiber
• Resty
• net/http

Supported Go Versions

This library supports the most recent Go, currently 1.22.3.

How to install

go get github.com/Clarilab/tracygo/v2

How to import

import "github.com/Clarilab/tracygo/v2"

How to use

In the examples folder you will find some example applications. One using the atreugo middleware, one using the fiber middleware. Both examples also demonstrate how to use the resty middleware.

Documentation

Overview

The TracyGo package provides functionality for tracing a correlation identifier through multiple go microservices.

Index

• type Option
  • func WithCorrelationID(id string) Option
  • func WithRequestID(id string) Option
• type TracyGo
  • func New(options ...Option) *TracyGo
  • func (t *TracyGo) CorrelationIDKey() string
  • func (t *TracyGo) CorrelationIDromContext(ctx context.Context) string
  • func (t *TracyGo) NewContextWithCorrelationID(ctx context.Context, correlationID string) context.Context
  • func (t *TracyGo) NewContextWithRequestID(ctx context.Context, requestID string) context.Context
  • func (t *TracyGo) RequestIDFromContext(ctx context.Context) string
  • func (t *TracyGo) RequestIDKey() string

Types

type Option

type Option func(tracy *TracyGo)

Option is an optional func.

func WithCorrelationID

func WithCorrelationID(id string) Option

WithCorrelationID returns a function that sets the key for the correlation id header.

func WithRequestID

func WithRequestID(id string) Option

WithRequestID returns a function that sets the key for the request id header.

type TracyGo

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

TracyGo is a struct for the tracy object.

func New

func New(options ...Option) *TracyGo

New creates a new TracyGo object and uses the options on it.

func (*TracyGo) CorrelationIDKey

func (t *TracyGo) CorrelationIDKey() string

CorrelationIDKey returns the underlying correlation id key.

func (*TracyGo) CorrelationIDromContext

func (t *TracyGo) CorrelationIDromContext(ctx context.Context) string

FromContext returns the correlation id from the given context, or the an empty string.

func (*TracyGo) NewContextWithCorrelationID

func (t *TracyGo) NewContextWithCorrelationID(ctx context.Context, correlationID string) context.Context

NewContextWithCorrelationID sets the correlation id to use in the given context. If ctx is nil, a new context without value is created.

func (*TracyGo) NewContextWithRequestID

func (t *TracyGo) NewContextWithRequestID(ctx context.Context, requestID string) context.Context

NewContextWithRequestID sets the request id to use in the given context. If ctx is nil, a new context without value is created.

func (*TracyGo) RequestIDFromContext

func (t *TracyGo) RequestIDFromContext(ctx context.Context) string

FromContext returns the correlationID from the given context, or the an empty string.

func (*TracyGo) RequestIDKey

func (t *TracyGo) RequestIDKey() string

RequestIDKey returns the underlying request id key.