logid

Documentation

Index

• Constants
• func AddLogIDIfNotExists(ctx context.Context) context.Context
• func Gen() string
• func GetLogID(ctx context.Context) string
• func NewCtx() context.Context
• func SetLogID(ctx context.Context, logId string) context.Context
• func SetRequestID(ctx context.Context, req *http.Request) string
• type Info
  • func Decode(s string) (info Info)
  • func (i Info) String() string
  • func (i Info) Valid() bool

Constants

const (
	// IPUnknown represents unknown IP address.
	IPUnknown = "00000000000000000000000000000000"
)

Functions

func AddLogIDIfNotExists

func AddLogIDIfNotExists(ctx context.Context) context.Context

AddLogIDIfNotExists checks log ID from ctx, if there is no log ID associated with it, it returns a new context with a new log ID.

func Gen

func Gen() string

Gen generates a new log ID string using the default generator.

func GetLogID

func GetLogID(ctx context.Context) string

GetLogID returns the associated log ID with ctx.

func NewCtx

func NewCtx() context.Context

NewCtx returns a new context with a log ID associated.

func SetLogID

func SetLogID(ctx context.Context, logId string) context.Context

SetLogID sets logId to ctx.

func SetRequestID

func SetRequestID(ctx context.Context, req *http.Request) string

SetRequestID gets log ID from ctx if available, or generates a new one, it sets the log ID to req as header "X-Request-ID".

Types

type Info

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

func Decode

func Decode(s string) (info Info)

func (Info) String

func (i Info) String() string

func (Info) Valid

func (i Info) Valid() bool