agent

Documentation

Index

• Constants
• type Flag
  • func (f Flag) MarshalText() (text []byte, err error)
  • func (f Flag) String() string
  • func (f *Flag) UnmarshalText(text []byte) error
• type FlagSet
  • func UsageFlags() FlagSet
• type OperationsFilter
  • func NewOperationsFilter(operations ...string) OperationsFilter
  • func (of OperationsFilter) IsAllowed(operationName string) bool
• type Stats
  • func (s *Stats) Marshal() (string, error)
  • func (s *Stats) Merge(other Stats)
• type StatsConfig
• type StatsProvider

Constants

const (
	AllowAllOperations = "*"
)

Types

type Flag

type Flag int

const (
	FlagIMDSFallbackSuccess Flag = iota
	FlagSharedConfigFallback
	FlagAppSignal
	FlagEnhancedContainerInsights
	FlagRunningInContainer
	FlagMode
	FlagRegionType
)

func (Flag) MarshalText

func (f Flag) MarshalText() (text []byte, err error)

func (Flag) String

func (f Flag) String() string

func (*Flag) UnmarshalText

func (f *Flag) UnmarshalText(text []byte) error

type FlagSet

type FlagSet interface {
	// IsSet returns if the flag is present in the backing map.
	IsSet(flag Flag) bool
	// GetString if the value stored with the flag is a string. If not, returns nil.
	GetString(flag Flag) *string
	// Set adds the Flag with an unused value.
	Set(flag Flag)
	// SetValue adds the Flag with a value.
	SetValue(flag Flag, value any)
	// SetValues adds each Flag/value pair.
	SetValues(flags map[Flag]any)
	// OnChange registers a callback that triggers on flag sets.
	OnChange(callback func())
}

FlagSet is a getter/setter for flag/value pairs. Once a flag key is set, its value is immutable.

func UsageFlags

func UsageFlags() FlagSet

type OperationsFilter

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

func NewOperationsFilter

func NewOperationsFilter(operations ...string) OperationsFilter

func (OperationsFilter) IsAllowed

func (of OperationsFilter) IsAllowed(operationName string) bool

type Stats

type Stats struct {
	CpuPercent                *float64 `json:"cpu,omitempty"`
	MemoryBytes               *uint64  `json:"mem,omitempty"`
	FileDescriptorCount       *int32   `json:"fd,omitempty"`
	ThreadCount               *int32   `json:"th,omitempty"`
	LatencyMillis             *int64   `json:"lat,omitempty"`
	PayloadBytes              *int     `json:"load,omitempty"`
	StatusCode                *int     `json:"code,omitempty"`
	SharedConfigFallback      *int     `json:"scfb,omitempty"`
	ImdsFallbackSucceed       *int     `json:"ifs,omitempty"`
	AppSignals                *int     `json:"as,omitempty"`
	EnhancedContainerInsights *int     `json:"eci,omitempty"`
	RunningInContainer        *int     `json:"ric,omitempty"`
	RegionType                *string  `json:"rt,omitempty"`
	Mode                      *string  `json:"m,omitempty"`
}

func (*Stats) Marshal

func (s *Stats) Marshal() (string, error)

func (*Stats) Merge

func (s *Stats) Merge(other Stats)

Merge the other Stats into the current. If the field is not nil, then it'll overwrite the existing one.

type StatsConfig

type StatsConfig struct {
	// Operations are the allowed operation names to gather stats for.
	Operations []string `mapstructure:"operations,omitempty"`
	// UsageFlags are the usage flags to set on start up.
	UsageFlags map[Flag]any `mapstructure:"usage_flags,omitempty"`
}

type StatsProvider

type StatsProvider interface {
	Stats(operation string) Stats
}