mfctx

README

mfctx

Documentation

Index

• Constants
• func GetAppID() string
• func GetAppIDUUID() ints.Uuid
• func GetAppName() (name string)
• func GetAppVersion() (version string)
• func GetDataCenter() (name string)
• func GetUnsecure() (unsec bool)
• func SetAppName(name string)
• func SetAppVersion(version string)
• func SetDataCenter(name string)
• func SetDefaultProvider(p *Provider)
• func SetUnsecure(unsec bool)
• func ToJson(sp JsonifyProvider, value any) json.RawMessage
• func WriteLog(lp LogProvider, c *Crumps, level LogLevel, ...)
• func WriteMetricRequest(mp MetricsProvider, c *Crumps, segment, method string)
• func WriteMetricResponse(mp MetricsProvider, c *Crumps, mRequest time.Time, segment, method string, ...)
• func WriteTrace(tp TraceProvider, span trace.Span, c *Crumps, ...)
• type Crumps
  • func FromCtx(ctx context.Context) *Crumps
  • func (c *Crumps) Complete(err error)
  • func (c *Crumps) Copy() *Crumps
  • func (c *Crumps) Deadline() (deadline time.Time, ok bool)
  • func (c *Crumps) Done() <-chan struct{}
  • func (c *Crumps) Err() error
  • func (c *Crumps) GetOperationID() string
  • func (c *Crumps) Log(level LogLevel, message string)
  • func (c *Crumps) LogUnsec(level LogLevel, message string)
  • func (c *Crumps) Start(method string) *Crumps
  • func (c *Crumps) StartSegment(segment, method string) *Crumps
  • func (c *Crumps) Value(key any) any
  • func (c *Crumps) With(name string, value any) *Crumps
  • func (c *Crumps) WithCancel() (*Crumps, context.CancelFunc)
  • func (c *Crumps) WithCancelCause() (*Crumps, context.CancelCauseFunc)
  • func (c *Crumps) WithDeadline(d time.Time) (*Crumps, context.CancelFunc)
  • func (c *Crumps) WithDeadlineCause(d time.Time, cause error) (*Crumps, context.CancelFunc)
  • func (c *Crumps) WithTimeout(timeout time.Duration) (*Crumps, context.CancelFunc)
  • func (c *Crumps) WithTimeoutCause(timeout time.Duration, cause error) (*Crumps, context.CancelFunc)
  • func (c *Crumps) WithUnsec(name string, value any) *Crumps
  • func (c *Crumps) WithValue(key any, val any) (*Crumps, context.CancelFunc)
  • func (c *Crumps) WithoutCancel(key any, val any) (*Crumps, context.CancelFunc)
• type JsonifyProvider
• type LogLevel
• type LogProvider
• type MetricsProvider
• type Provider
  • func (p *Provider) MakeCrumps() (c *Crumps)
• type StepInfo
• type TraceProvider
• type Values

Constants

const (
	MsgComplete = "complete"
	MsgError    = "error"
)

const (
	CtxValName string = "_Crumps"
)

Functions

func GetAppID

func GetAppID() string

func GetAppIDUUID

func GetAppIDUUID() ints.Uuid

func GetAppName

func GetAppName() (name string)

func GetAppVersion

func GetAppVersion() (version string)

func GetDataCenter

func GetDataCenter() (name string)

func GetUnsecure

func GetUnsecure() (unsec bool)

func SetAppName

func SetAppName(name string)

func SetAppVersion

func SetAppVersion(version string)

func SetDataCenter

func SetDataCenter(name string)

func SetDefaultProvider

func SetDefaultProvider(p *Provider)

func SetUnsecure

func SetUnsecure(unsec bool)

func ToJson

func ToJson(sp JsonifyProvider, value any) json.RawMessage

func WriteLog

func WriteLog(lp LogProvider, c *Crumps, level LogLevel, message, segment, method, operationID, traceID string, steps []StepInfo, values map[string]Values)

func WriteMetricRequest

func WriteMetricRequest(mp MetricsProvider, c *Crumps, segment, method string)

func WriteMetricResponse

func WriteMetricResponse(mp MetricsProvider, c *Crumps, mRequest time.Time, segment, method string, resultResult string)

func WriteTrace

func WriteTrace(tp TraceProvider, span trace.Span, c *Crumps, segment, method, operationID string, steps []StepInfo, values map[string]Values)

Types

type Crumps

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

func FromCtx

func FromCtx(ctx context.Context) *Crumps

func (*Crumps) Complete

func (c *Crumps) Complete(err error)

func (*Crumps) Copy

func (c *Crumps) Copy() *Crumps

func (*Crumps) Deadline

func (c *Crumps) Deadline() (deadline time.Time, ok bool)

func (*Crumps) Done

func (c *Crumps) Done() <-chan struct{}

func (*Crumps) Err

func (c *Crumps) Err() error

func (*Crumps) GetOperationID

func (c *Crumps) GetOperationID() string

func (*Crumps) Log

func (c *Crumps) Log(level LogLevel, message string)

func (*Crumps) LogUnsec

func (c *Crumps) LogUnsec(level LogLevel, message string)

LogUnsec logs when unsecure is true

func (*Crumps) Start

func (c *Crumps) Start(method string) *Crumps

func (*Crumps) StartSegment

func (c *Crumps) StartSegment(segment, method string) *Crumps

func (*Crumps) Value

func (c *Crumps) Value(key any) any

func (*Crumps) With

func (c *Crumps) With(name string, value any) *Crumps

With adds jsonify value and adds it

func (*Crumps) WithCancel

func (c *Crumps) WithCancel() (*Crumps, context.CancelFunc)

func (*Crumps) WithCancelCause

func (c *Crumps) WithCancelCause() (*Crumps, context.CancelCauseFunc)

func (*Crumps) WithDeadline

func (c *Crumps) WithDeadline(d time.Time) (*Crumps, context.CancelFunc)

func (*Crumps) WithDeadlineCause

func (c *Crumps) WithDeadlineCause(d time.Time, cause error) (*Crumps, context.CancelFunc)

func (*Crumps) WithTimeout

func (c *Crumps) WithTimeout(timeout time.Duration) (*Crumps, context.CancelFunc)

func (*Crumps) WithTimeoutCause

func (c *Crumps) WithTimeoutCause(timeout time.Duration, cause error) (*Crumps, context.CancelFunc)

func (*Crumps) WithUnsec

func (c *Crumps) WithUnsec(name string, value any) *Crumps

WithUnsec adds jsonify value and adds it when unsecure is true

func (*Crumps) WithValue

func (c *Crumps) WithValue(key any, val any) (*Crumps, context.CancelFunc)

func (*Crumps) WithoutCancel

func (c *Crumps) WithoutCancel(key any, val any) (*Crumps, context.CancelFunc)

type JsonifyProvider

type JsonifyProvider interface {
	ToJson(value any) json.RawMessage
}

type LogLevel

type LogLevel string

const (
	Trace       LogLevel = "trace"
	Debug       LogLevel = "debug"
	Start       LogLevel = "start"
	Finish      LogLevel = "finish"
	Info        LogLevel = "info"
	FinishError LogLevel = "finish_error"
	Warning     LogLevel = "warning"
	Error       LogLevel = "error"
	Fatal       LogLevel = "fatal"
)

type LogProvider

type LogProvider interface {
	WriteLog(c *Crumps, level LogLevel, message, segment, method, operationID, traceID string, steps []StepInfo, values map[string]Values)
}

type MetricsProvider

type MetricsProvider interface {
	WriteMetricRequest(c *Crumps, segment, method string)
	WriteMetricResponse(c *Crumps, mRequest time.Time, segment, method string, resultResult string)
}

type Provider

type Provider struct {
	LP LogProvider
	MP MetricsProvider
	SP JsonifyProvider
	TP TraceProvider
}

var DefaultProvider *Provider = nil

func (*Provider) MakeCrumps

func (p *Provider) MakeCrumps() (c *Crumps)

type StepInfo

type StepInfo struct {
	StepID  string    `json:"step_id"`
	StartTS time.Time `json:"start"`
	Segment string    `json:"segment"`
	Method  string    `json:"method"`
}

type TraceProvider

type TraceProvider interface {
	WriteTrace(span trace.Span, c *Crumps, segment, method, operationID string, steps []StepInfo, values map[string]Values)
}

type Values

type Values []json.RawMessage