processor

package

v1.6.2 Latest Latest Go to latest Published: Apr 17, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nikolaydubina/go-instrument

Links

Open Source Insights

Documentation ¶

Index ¶

func BasicSpanName(receiver, function string) string
func IsBuildExclude(s string) bool
func IsBuildIgnore(s string) bool
func IsGoBuildExclude(s string) bool
func IsGoBuildIgnore(s string) bool
type Command
- func CommandsFromFile(file ast.File) ([]Command, error)
- func ParseCommand(s string) (Command, error)
type FunctionSelector
type GoBuildDirective
- func GoBuildDirectivesFromFile(file ast.File) (directives []GoBuildDirective)
- func ParseGoBuildDirective(s string) GoBuildDirective
- func (v GoBuildDirective) SkipFile() bool
type Instrumenter
type MapFunctionSelector
- func NewMapFunctionSelectorFromCommands(defaultSelect bool, commands []Command) MapFunctionSelector
- func (s MapFunctionSelector) AcceptFunction(functionName string) bool
type Processor
- func (p *Processor) Process(fset *token.FileSet, file *ast.File) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BasicSpanName ¶

func BasicSpanName(receiver, function string) string

BasicSpanName is common notation of <class>.<method> or <pkg>.<func>

func IsBuildExclude ¶ added in v1.2.0

func IsBuildExclude(s string) bool

func IsBuildIgnore ¶ added in v1.2.0

func IsBuildIgnore(s string) bool

func IsGoBuildExclude ¶ added in v1.2.0

func IsGoBuildExclude(s string) bool

func IsGoBuildIgnore ¶ added in v1.2.0

func IsGoBuildIgnore(s string) bool

Types ¶

type Command ¶

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

Command to change behavior of Processor or Instrumentor

func CommandsFromFile ¶

func CommandsFromFile(file ast.File) ([]Command, error)

CommandsFromFile that has been parsed by `go/parse` with comments

func ParseCommand ¶

func ParseCommand(s string) (Command, error)

ParseCommand from string representation

type FunctionSelector ¶ added in v1.1.0

type FunctionSelector interface {
	AcceptFunction(functionName string) bool
}

FunctionSelector tells if function has to be instrumented.

type GoBuildDirective ¶ added in v1.2.0

type GoBuildDirective uint

GoBuildDirective is standard Go compiler directive.

const (
	UnknownDirective GoBuildDirective = iota
	GoBuildIgnore
	GoBuildExclude
	BuildIgnore
	BuildExclude
)

func GoBuildDirectivesFromFile ¶ added in v1.2.0

func GoBuildDirectivesFromFile(file ast.File) (directives []GoBuildDirective)

func ParseGoBuildDirective ¶ added in v1.2.0

func ParseGoBuildDirective(s string) GoBuildDirective

func (GoBuildDirective) SkipFile ¶ added in v1.2.0

func (v GoBuildDirective) SkipFile() bool

type Instrumenter ¶

type Instrumenter interface {
	Imports() []*types.Package
	PrefixStatements(spanName string, hasError bool) []ast.Stmt
}

Instrumenter supplies ast of Go code that will be inserted and required dependencies.

type MapFunctionSelector ¶ added in v1.1.0

type MapFunctionSelector struct {
	AcceptFunctions map[string]bool
	Default         bool
}

MapFunctionSelector makes decision basedd on map value or else default.

func NewMapFunctionSelectorFromCommands ¶ added in v1.1.0

func NewMapFunctionSelectorFromCommands(defaultSelect bool, commands []Command) MapFunctionSelector

NewMapFunctionSelectorFromCommands performs join of function names stored in maps of commands.

func (MapFunctionSelector) AcceptFunction ¶ added in v1.1.0

func (s MapFunctionSelector) AcceptFunction(functionName string) bool

type Processor ¶

type Processor struct {
	Instrumenter     Instrumenter
	FunctionSelector FunctionSelector
	SpanName         func(receiver, function string) string
	ContextName      string
	ContextPackage   string
	ContextType      string
	ErrorName        string
	ErrorType        string
}

Processor traverses AST, collects details on functions and methods, and invokes Instrumenter

func (*Processor) Process ¶

func (p *Processor) Process(fset *token.FileSet, file *ast.File) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL