common

Documentation

Overview

Package common provides a set of common symbols needed by different packages, to avoid circular dependencies.

Package common provides a set of common symbols needed by different packages, to avoid circular dependencies.

Index

• Constants
• Variables
• func AutoAddListeners(listeners []config.Listeners) []config.Listeners
• func GetDistPath() string
• func GetPythonPaths() []string
• func GetVersion(w http.ResponseWriter, r *http.Request)
• func GetViewsPath() string
• func ImportConfig(oldConfigDir string, newConfigDir string, force bool) error
• func IsDockerRunning() bool
• func SetupAutoConfig(confdPath string)
• func SetupConfig(confFilePath string) error
• func SetupConfigWithoutSecrets(confFilePath string, configName string) error
• func StartAutoConfig()
• type TransformationFunc

Constants

const (
	// DefaultConfPath points to the folder containing datadog.yaml
	DefaultConfPath = "/etc/datadog-agent"
	// DefaultLogFile points to the log file that will be used if not configured
	DefaultLogFile = "/var/log/datadog/agent.log"
	// DefaultDCALogFile points to the log file that will be used if not configured
	DefaultDCALogFile = "/var/log/datadog/cluster-agent.log"
)

Variables

var (
	// AC is the global object orchestrating checks' loading and running
	AC *autodiscovery.AutoConfig

	// Coll is the global collector instance
	Coll *collector.Collector

	// DSD is the global dogstastd instance
	DSD *dogstatsd.Server

	// MetadataScheduler is responsible to orchestrate metadata collection
	MetadataScheduler *metadata.Scheduler

	// Forwarder is the global forwarder instance
	Forwarder forwarder.Forwarder

	// MainCtx is the main agent context passed to components
	MainCtx context.Context

	// MainCtxCancel cancels the main agent context
	MainCtxCancel context.CancelFunc
)

var (
	// PyChecksPath holds the path to the python checks from integrations-core shipped with the agent
	PyChecksPath = filepath.Join(_here, "..", "..", "checks.d")
)

Functions

func AutoAddListeners

func AutoAddListeners(listeners []config.Listeners) []config.Listeners

AutoAddListeners checks if the listener auto is selected and adds the docker listener if the host support it no effect if the listeners already contain the docker one Note: auto listener isn't a real listener but a way to automatically starts other listeners TODO: support more listeners (kubelet, ...)

func GetDistPath

func GetDistPath() string

GetDistPath returns the fully qualified path to the 'dist' directory

func GetPythonPaths

func GetPythonPaths() []string

GetPythonPaths returns the paths (in order of precedence) from where the agent should load python modules and checks

func GetVersion

func GetVersion(w http.ResponseWriter, r *http.Request)

GetVersion returns the version of the agent in a http response json

func GetViewsPath

func GetViewsPath() string

GetViewsPath returns the fully qualified path to the 'gui/views' directory

func ImportConfig

func ImportConfig(oldConfigDir string, newConfigDir string, force bool) error

ImportConfig imports the agent5 configuration into the agent6 yaml config

func IsDockerRunning

func IsDockerRunning() bool

IsDockerRunning check if docker is running

func SetupAutoConfig

func SetupAutoConfig(confdPath string)

SetupAutoConfig configures the global AutoConfig:

1. add the configuration providers
2. add the check loaders

func SetupConfig

func SetupConfig(confFilePath string) error

SetupConfig fires up the configuration system

func SetupConfigWithoutSecrets

func SetupConfigWithoutSecrets(confFilePath string, configName string) error

SetupConfigWithoutSecrets fires up the configuration system without secrets support

func StartAutoConfig

func StartAutoConfig()

StartAutoConfig starts the autoconfig:

1. load all the configurations available at startup
2. run all the Checks for each configuration found

Types

type TransformationFunc

type TransformationFunc func(rawData []byte) ([]byte, error)

TransformationFunc type represents transformation applicable to byte slices