option

Documentation

Overview

Package option provides global singletons for storing configuration and variables used in Tetragon.

Index

• Constants
• Variables
• func AddFlags(flags *pflag.FlagSet)
• func CgroupRateEnabled() bool
• func CreateProcessLabels(namespace, workload, pod, binary string) *metrics.ProcessLabels
• func DefaultLabelFilter() metrics.LabelFilter
• func ParseMetricsLabelFilter(labelsString string) []string
• func ReadAndSetFlags() error
• func ReadConfigDir(path string) error
• func ReadConfigFile(path string, file string) error
• func ReadDirConfig(dirName string) (map[string]interface{}, error)
• type CgroupRate
  • func ParseCgroupRate(rate string) CgroupRate
• type UsernameMetadaCode
  • func (op UsernameMetadaCode) String() string

Constants

const (
	KeyConfigDir        = "config-dir"
	KeyDebug            = "debug"
	KeyHubbleLib        = "bpf-lib"
	KeyBTF              = "btf"
	KeyProcFS           = "procfs"
	KeyKernelVersion    = "kernel"
	KeyVerbosity        = "verbose"
	KeyProcessCacheSize = "process-cache-size"
	KeyDataCacheSize    = "data-cache-size"
	KeyForceSmallProgs  = "force-small-progs"
	KeyForceLargeProgs  = "force-large-progs"

	KeyLogLevel  = "log-level"
	KeyLogFormat = "log-format"

	KeyEnableK8sAPI           = "enable-k8s-api"
	KeyK8sKubeConfigPath      = "k8s-kubeconfig-path"
	KeyEnableProcessAncestors = "enable-process-ancestors"

	KeyMetricsServer      = "metrics-server"
	KeyMetricsLabelFilter = "metrics-label-filter"
	KeyServerAddress      = "server-address"
	KeyGopsAddr           = "gops-address"
	KeyEnableProcessCred  = "enable-process-cred"
	KeyEnableProcessNs    = "enable-process-ns"
	KeyTracingPolicy      = "tracing-policy"
	KeyTracingPolicyDir   = "tracing-policy-dir"

	KeyCpuProfile          = "cpuprofile"
	KeyMemProfile          = "memprofile"
	KeyPprofAddr           = "pprof-address"
	KeyDeprecatedPprofAddr = "pprof-addr"

	KeyExportFilename             = "export-filename"
	KeyExportFileMaxSizeMB        = "export-file-max-size-mb"
	KeyExportFileRotationInterval = "export-file-rotation-interval"
	KeyExportFileMaxBackups       = "export-file-max-backups"
	KeyExportFileCompress         = "export-file-compress"
	KeyExportRateLimit            = "export-rate-limit"
	KeyExportFilePerm             = "export-file-perm"

	KeyEnableExportAggregation     = "enable-export-aggregation"
	KeyExportAggregationWindowSize = "export-aggregation-window-size"
	KeyExportAggregationBufferSize = "export-aggregation-buffer-size"

	KeyExportAllowlist = "export-allowlist"
	KeyExportDenylist  = "export-denylist"

	KeyFieldFilters     = "field-filters"
	KeyRedactionFilters = "redaction-filters"

	KeyNetnsDir = "netns-dir"

	KeyDisableKprobeMulti = "disable-kprobe-multi"
	KeyDisableUprobeMulti = "disable-uprobe-multi"

	KeyRBSize      = "rb-size"
	KeyRBSizeTotal = "rb-size-total"
	KeyRBQueueSize = "rb-queue-size"

	KeyEventQueueSize = "event-queue-size"

	KeyReleasePinnedBPF = "release-pinned-bpf"

	KeyEnablePolicyFilter      = "enable-policy-filter"
	KeyEnablePolicyFilterDebug = "enable-policy-filter-debug"

	KeyEnablePidSetFilter = "enable-pid-set-filter"

	KeyEnableMsgHandlingLatency = "enable-msg-handling-latency"

	KeyEnablePodInfo          = "enable-pod-info"
	KeyEnableTracingPolicyCRD = "enable-tracing-policy-crd"

	KeyExposeStackAddresses  = "expose-stack-addresses"
	KeyExposeKernelAddresses = "expose-kernel-addresses"

	KeyGenerateDocs = "generate-docs"

	KeyCgroupRate = "cgroup-rate"

	KeyUsernameMetadata = "username-metadata"

	KeyHealthServerAddress = "health-server-address"
	KeyHealthTimeInterval  = "health-server-interval"

	KeyBpfDir = "bpf-dir"

	KeyKeepSensorsOnExit = "keep-sensors-on-exit"

	KeyEnableCRI   = "enable-cri"
	KeyCRIEndpoint = "cri-endpoint"

	KeyEnableCgIDmap      = "enable-cgidmap"
	KeyEnableCgIDmapDebug = "enable-cgidmap-debug"
)

Variables

var (

	// Config contains all the configuration used by Tetragon.
	Config = config{

		ProcFS: "/proc",

		LogOpts: make(map[string]string),

		MetricsLabelFilter: DefaultLabelFilter(),
	}
)

Functions

func AddFlags

func AddFlags(flags *pflag.FlagSet)

func CgroupRateEnabled

func CgroupRateEnabled() bool

func CreateProcessLabels

func CreateProcessLabels(namespace, workload, pod, binary string) *metrics.ProcessLabels

CreateProcessLabels creates a new ProcessLabels struct with the global labels filter applied. To have a metric respect the labels filter, we have to:

1. Define a granular metric with ProcessLabels type parameter (see pkg/metrics/granularmetric.go).
2. When calling WithLabelValues, pass a ProcessLabels struct created with CreateProcessLabels.

func DefaultLabelFilter

func DefaultLabelFilter() metrics.LabelFilter

func ParseMetricsLabelFilter

func ParseMetricsLabelFilter(labelsString string) []string

func ReadAndSetFlags

func ReadAndSetFlags() error

func ReadConfigDir

func ReadConfigDir(path string) error

func ReadConfigFile

func ReadConfigFile(path string, file string) error

func ReadDirConfig

func ReadDirConfig(dirName string) (map[string]interface{}, error)

ReadDirConfig reads the given directory and returns a map that maps the filename to the contents of that file.

Types

type CgroupRate

type CgroupRate struct {
	Events   uint64
	Interval uint64
}

func ParseCgroupRate

func ParseCgroupRate(rate string) CgroupRate

type UsernameMetadaCode

type UsernameMetadaCode int

const (
	// Username metadata collection modes
	USERNAME_METADATA_DISABLED UsernameMetadaCode = iota
	USERNAME_METADATA_UNIX     UsernameMetadaCode = 1 // Username from /etc/passwd
)

func (UsernameMetadaCode) String

func (op UsernameMetadaCode) String() string