util

Documentation

Index

• Constants
• func CopyDir(src, dst string) error
• func CopyFile(src, dst string) error
• func CopyFileAll(src, dst string) error
• func DetectCloudProvider()
• func EnsureParentDirsExist(p string) error
• func Fqdn(hostname string) string
• func GetAgentNetworkMode() (string, error)
• func GetAgentUTSMode() (containers.UTSMode, error)
• func GetGoRoutinesDump() (string, error)
• func GetHostname() (string, error)
• func GetJSONSerializableMap(m interface{}) interface{}
• func GetNetworkID() (string, error)
• func HTTPHeaders() map[string]string
• func InsertionSort(elements []string)
• func LogVersionHistory()
• func SortUniqInPlace(elements []string) []string
• type BiMap
  • func NewBiMap(k, v interface{}) *BiMap
  • func (b *BiMap) AddKV(k, v interface{}) error
  • func (b *BiMap) GetKV(key interface{}) (interface{}, error)
  • func (b *BiMap) GetKVBimap(key interface{}) (interface{}, error)
  • func (b *BiMap) GetKVReverse(key interface{}) (interface{}, error)
  • func (b *BiMap) Keys() []interface{}
  • func (b *BiMap) Values() []interface{}
• type HostnameData
  • func GetHostnameData() (HostnameData, error)
• type NamedPipe
  • func GetPipe(path string) (NamedPipe, error)
• type Stat
• type Stats
  • func NewStats(sz uint32) (*Stats, error)
  • func (s *Stats) Process()
  • func (s *Stats) StatEvent(v int64)
  • func (s *Stats) Stop()
  • func (s *Stats) Update(expStat *expvar.Int)
• type WinNamedPipe
  • func (p *WinNamedPipe) Close() error
  • func (p *WinNamedPipe) Open() error
  • func (p *WinNamedPipe) Read(b []byte) (int, error)
  • func (p *WinNamedPipe) Ready() bool
  • func (p *WinNamedPipe) Write(b []byte) (int, error)

Constants

const HostnameProviderConfiguration = "configuration"

HostnameProviderConfiguration is the key for the hostname provider associated to datadog.yaml

const InsertionSortThreshold = 40

InsertionSortThreshold is the slice size after which we should consider using the stdlib sort method instead of the InsertionSort implemented below.

Functions

func CopyDir

func CopyDir(src, dst string) error

CopyDir copies directory recursively

func CopyFile

func CopyFile(src, dst string) error

CopyFile atomically copies file path `src“ to file path `dst`.

func CopyFileAll

func CopyFileAll(src, dst string) error

CopyFileAll calls CopyFile, but will create necessary directories for `dst`.

func DetectCloudProvider

func DetectCloudProvider()

DetectCloudProvider detects the cloud provider where the agent is running in order: * AWS ECS/Fargate * AWS EC2 * GCE * Azure * Alibaba * Tencent

func EnsureParentDirsExist

func EnsureParentDirsExist(p string) error

EnsureParentDirsExist makes a path immediately available for writing by creating the necessary parent directories.

func Fqdn

func Fqdn(hostname string) string

Fqdn returns the FQDN for the host if any

func GetAgentNetworkMode

func GetAgentNetworkMode() (string, error)

GetAgentNetworkMode retrieves from Docker the network mode of the Agent container

func GetAgentUTSMode

func GetAgentUTSMode() (containers.UTSMode, error)

GetAgentUTSMode retrieves from Docker the UTS mode of the Agent container

func GetGoRoutinesDump

func GetGoRoutinesDump() (string, error)

GetGoRoutinesDump returns the stack trace of every Go routine of a running Agent.

func GetHostname

func GetHostname() (string, error)

GetHostname retrieves the host name from GetHostnameData

func GetJSONSerializableMap

func GetJSONSerializableMap(m interface{}) interface{}

GetJSONSerializableMap returns a JSON serializable map from a raw map

func GetNetworkID

func GetNetworkID() (string, error)

GetNetworkID retrieves the network_id which can be used to improve network connection resolution. This can be configured or detected. The following sources will be queried: * configuration * GCE * EC2

func HTTPHeaders

func HTTPHeaders() map[string]string

HTTPHeaders returns a http headers including various basic information (User-Agent, Content-Type...).

func InsertionSort

func InsertionSort(elements []string)

InsertionSort sorts in-place the given elements, not doing any allocation. It is very efficient for on slices but if memory allocation is not an issue, consider using the stdlib `sort.Sort` method on slices having a size > InsertionSortThreshold. See `pkg/util/sort_benchmarks_note.md` for more details.

func LogVersionHistory

func LogVersionHistory()

LogVersionHistory loads version history file, append new entry if agent version is different than the last entry in the JSON file, trim the file if too many entries then save the file.

func SortUniqInPlace

func SortUniqInPlace(elements []string) []string

SortUniqInPlace sorts and remove duplicates from elements in place The returned slice is a subslice of elements

Types

type BiMap

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

BiMap provides a bidirectional map of keys and values.

func NewBiMap

func NewBiMap(k, v interface{}) *BiMap

NewBiMap instantiates BiMap

func (*BiMap) AddKV

func (b *BiMap) AddKV(k, v interface{}) error

AddKV adds value `v` to map the map indexed with key `k`.

func (*BiMap) GetKV

func (b *BiMap) GetKV(key interface{}) (interface{}, error)

GetKV gets value provided the key.

func (*BiMap) GetKVBimap

func (b *BiMap) GetKVBimap(key interface{}) (interface{}, error)

GetKVBimap looks for the provided key both for keys and values in the map.

The first occurrence will be returned.

func (*BiMap) GetKVReverse

func (b *BiMap) GetKVReverse(key interface{}) (interface{}, error)

GetKVReverse gets key provided the value.

func (*BiMap) Keys

func (b *BiMap) Keys() []interface{}

Keys returns a slice with all keys in the map.

func (*BiMap) Values

func (b *BiMap) Values() []interface{}

Values returns a slice with all values in the map.

type HostnameData

type HostnameData struct {
	Hostname string
	Provider string
}

HostnameData contains hostname and the hostname provider

func GetHostnameData

func GetHostnameData() (HostnameData, error)

GetHostnameData retrieves the host name for the Agent and hostname provider, trying to query these environments/api, in order: * GCE * Docker * kubernetes * os * EC2

type NamedPipe

type NamedPipe interface {
	Open() error
	Ready() bool
	Read(b []byte) (int, error)
	Write(b []byte) (int, error)
	Close() error
}

NamedPipe interface to NamedPipes (multi-platform)

func GetPipe

func GetPipe(path string) (NamedPipe, error)

GetPipe returns a named pipe to path

type Stat

type Stat struct {
	Val int64
	Ts  time.Time
}

Stat type includes a statted value and its timestamp.

type Stats

type Stats struct {
	Aggregated chan Stat
	// contains filtered or unexported fields
}

Stats type structure enabling statting facilities.

func NewStats

func NewStats(sz uint32) (*Stats, error)

NewStats constructor for Stats

func (*Stats) Process

func (s *Stats) Process()

Process call to start processing statistics

func (*Stats) StatEvent

func (s *Stats) StatEvent(v int64)

StatEvent aggregates an event with value v

func (*Stats) Stop

func (s *Stats) Stop()

Stop call to stop processing statistics. Once stopped, Stats cannot be restarted.

func (*Stats) Update

func (s *Stats) Update(expStat *expvar.Int)

Update update the expvar parameter with the last aggregated value

type WinNamedPipe

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

WinNamedPipe holds the named pipe configuration

func (*WinNamedPipe) Close

func (p *WinNamedPipe) Close() error

Close the underlying named pipe

func (*WinNamedPipe) Open

func (p *WinNamedPipe) Open() error

Open named pipe

func (*WinNamedPipe) Read

func (p *WinNamedPipe) Read(b []byte) (int, error)

Read from the pipe

func (*WinNamedPipe) Ready

func (p *WinNamedPipe) Ready() bool

Ready returns whether the pipe is ready to read and write

func (*WinNamedPipe) Write

func (p *WinNamedPipe) Write(b []byte) (int, error)

Write to the pipe