introspection

Documentation

Overview

Package introspection defines the worker that can report internal agent state through the use of a machine local socket.

The most interesting endpoints at this stage are: * `/debug/pprof/goroutine?debug=1`

• prints out all the goroutines in the agent

* `/debug/pprof/heap?debug=1`

• prints out the heap profile

Index

• func NewWorker(config Config) (worker.Worker, error)
• func WriteProfileFunctions() error
• type Config
  • func (c *Config) Validate() error
• type DepEngineReporter

Functions

func NewWorker

func NewWorker(config Config) (worker.Worker, error)

NewWorker starts an http server listening on an abstract domain socket which will be created with the specified name.

func WriteProfileFunctions

func WriteProfileFunctions() error

WriteProfileFunctions writes the bashFuncs below to a file in the /etc/profile.d directory so all bash terminals can easily access the introspection worker.

Types

type Config

type Config struct {
	SocketName string
	Reporter   DepEngineReporter
}

Config describes the arguments required to create the introspection worker.

func (*Config) Validate

func (c *Config) Validate() error

Validate checks the config values to assert they are valid to create the worker.

type DepEngineReporter

type DepEngineReporter interface {
	// Report returns a map describing the state of the receiver. It is expected
	// to be goroutine-safe.
	Report() map[string]interface{}
}

DepEngineReporter provides insight into the running dependency engine of the agent.