mod_trace

README

mod_trace

Introduction

mod_trace is a BFE plugin for OpenTracing.

Usage

See:

• https://www.bfe-networks.net/en_us/modules/mod_trace/mod_trace/
• https://www.bfe-networks.net/zh_cn/modules/mod_trace/mod_trace/

Documentation

Index

• Constants
• func InjectRequestHeader(span opentracing.Span, r *bfe_http.Request)
• func StartSpan(r *bfe_http.Request) opentracing.Span
• func TraceRuleCheck(traceRuleFile *TraceRuleFile) error
• type ConfModTrace
  • func ConfLoad(filePath string, confRoot string) (*ConfModTrace, error)
  • func (cfg *ConfModTrace) Check(confRoot string) error
  • func (cfg *ConfModTrace) GetTraceConfig() trace.TraceAgent
• type ModuleTrace
  • func NewModuleTrace() *ModuleTrace
  • func (m *ModuleTrace) Init(cbs *bfe_module.BfeCallbacks, whs *web_monitor.WebHandlers, cr string) error
  • func (m *ModuleTrace) Name() string
• type ModuleTraceState
• type ProductRuleList
• type ProductRuleRawList
• type RuleRawList
• type TraceRule
• type TraceRuleConf
  • func TraceRuleFileLoad(filename string) (*TraceRuleConf, error)
• type TraceRuleFile
• type TraceRuleList
• type TraceRuleRaw
• type TraceRuleTable
  • func NewTraceRuleTable() *TraceRuleTable
  • func (t *TraceRuleTable) Search(product string) (TraceRuleList, bool)
  • func (t *TraceRuleTable) Update(ruleConf *TraceRuleConf)

Constants

const (
	ModTrace = "mod_trace"
	CtxSpan  = "mod_trace.span"
)

Functions

func InjectRequestHeader

func InjectRequestHeader(span opentracing.Span, r *bfe_http.Request)

InjectRequestHeaders used to inject opentracing headers into the request.

func StartSpan

func StartSpan(r *bfe_http.Request) opentracing.Span

StartSpan starts a new span

func TraceRuleCheck

func TraceRuleCheck(traceRuleFile *TraceRuleFile) error

Types

type ConfModTrace

type ConfModTrace struct {
	Basic struct {
		DataPath    string // The path of rule data
		ServiceName string // The name of this service
		TraceAgent  string // The type of trace agent: zipkin, jaeger or elastic
	}

	Log struct {
		OpenDebug bool
	}

	Zipkin  zipkin.Config  // Settings for zipkin, only useful when TraceAgent is zipkin
	Jaeger  jaeger.Config  // Settings for jaeger, only useful when TraceAgent is jaeger
	Elastic elastic.Config // Settings for elastic, only useful when TraceAgent is elastic
}

func ConfLoad

func ConfLoad(filePath string, confRoot string) (*ConfModTrace, error)

func (*ConfModTrace) Check

func (cfg *ConfModTrace) Check(confRoot string) error

func (*ConfModTrace) GetTraceConfig

func (cfg *ConfModTrace) GetTraceConfig() trace.TraceAgent

type ModuleTrace

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

func NewModuleTrace

func NewModuleTrace() *ModuleTrace

func (*ModuleTrace) Init

func (m *ModuleTrace) Init(cbs *bfe_module.BfeCallbacks, whs *web_monitor.WebHandlers, cr string) error

func (*ModuleTrace) Name

func (m *ModuleTrace) Name() string

type ModuleTraceState

type ModuleTraceState struct {
	StartSpanCount  *metrics.Counter
	FinishSpanCount *metrics.Counter
}

type ProductRuleList

type ProductRuleList map[string]TraceRuleList // product => list of trace rule list

type ProductRuleRawList

type ProductRuleRawList map[string]RuleRawList // product => raw rule list

type RuleRawList

type RuleRawList []TraceRuleRaw

type TraceRule

type TraceRule struct {
	Cond   condition.Condition
	Enable bool
}

type TraceRuleConf

type TraceRuleConf struct {
	Version string          // version
	Config  ProductRuleList // product -> rule list
}

func TraceRuleFileLoad

func TraceRuleFileLoad(filename string) (*TraceRuleConf, error)

type TraceRuleFile

type TraceRuleFile struct {
	Version string             // version
	Config  ProductRuleRawList // product -> raw rule list
}

type TraceRuleList

type TraceRuleList []TraceRule

type TraceRuleRaw

type TraceRuleRaw struct {
	Cond   string // condition
	Enable bool   // enable trace
}

type TraceRuleTable

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

func NewTraceRuleTable

func NewTraceRuleTable() *TraceRuleTable

func (*TraceRuleTable) Search

func (t *TraceRuleTable) Search(product string) (TraceRuleList, bool)

func (*TraceRuleTable) Update

func (t *TraceRuleTable) Update(ruleConf *TraceRuleConf)