trace

README

Trace

This package contains filter for generating traceID (X-Ab-TraceID header field) if there is no X-Ab-TraceID in request header.

Usage

Importing

import "github.com/AccelByte/go-restful-plugins/v4/pkg/trace"

Filter

Filter is restful.FilterFunction for generating traceID (X-Ab-TraceID header field) if there is no X-Ab-TraceID in request header.

Example usage of filter for all endpoints

Simple initialization:

ws := new(restful.WebService)
ws.Filter(trace.Filter())

With option initialization:

ws := new(restful.WebService)
ws.Filter(trace.FilterWithOption(trace.SimpleTraceID))

Supported TraceID Type:

• SimpleTraceID = "uuid" format
• TimeBasedTraceID (default) = "requestTime-uuid" format

Documentation

Index

• func Filter() restful.FilterFunction
• func FilterWithOption(traceIDType IDType) restful.FilterFunction
• type IDType

Functions

func Filter

func Filter() restful.FilterFunction

func FilterWithOption

func FilterWithOption(traceIDType IDType) restful.FilterFunction

Types

type IDType

type IDType string

IDType is the type for trace_id

const (
	TraceIDKey = "X-Ab-TraceID"

	SimpleTraceID    IDType = "Simple"    // format: uuid
	TimeBasedTraceID IDType = "TimeBased" // format: requestTime-uuid
)