tracygo

README

tracygo

How to import

import "github.com/Clarilab/tracygo"

How to use

Check the main.go in the example folder. There are two middleware functions for atreugo. UseBefore(CheckRequestID) which checks if the IDs are set if not its creates and saves them in the Uservalues. UseAfter(WriteHeader) which writes the the userValues into the response Header.

There is one resty middleware. OnBeforeRequest(CheckTracingIDs) which checks if the IDs are set and writes them into the Header.

Documentation

Index

• type Option
  • func CorrelationID(id string) Option
  • func RequestID(id string) Option
• type TracyGo
  • func New(options ...Option) *TracyGo
  • func (t *TracyGo) AtreugoCheckTracingIDs(ctx *atreugo.RequestCtx) error
  • func (t *TracyGo) RestyCheckTracingIDs(client *resty.Client, request *resty.Request) error

Types

type Option

type Option func(tracy *TracyGo)

Option is an optional func.

func CorrelationID

func CorrelationID(id string) Option

CorrelationID returns a function that sets the key for the correlationId header.

func RequestID

func RequestID(id string) Option

RequestID returns a function that sets the key for the requestId 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) AtreugoCheckTracingIDs

func (t *TracyGo) AtreugoCheckTracingIDs(ctx *atreugo.RequestCtx) error

AtreugoCheckTracingIDs is a useBefore middleware for atreugo that checks if a correlationID and requestID have been set and creates a new one if they have not been set yet.

func (*TracyGo) RestyCheckTracingIDs

func (t *TracyGo) RestyCheckTracingIDs(client *resty.Client, request *resty.Request) error

RestyCheckTracingIDs is a OnBeforeRequest middleware for resty which check if the context has the tracing ids set. If they are set, they should be put into the request headers.