package
0.7.0
Repository: https://github.com/intel/goresctrl.git
Documentation: pkg.go.dev

# Functions

ContainerClassFromAnnotations determines the effective RDT class of a container from the Pod annotations and CRI level container annotations of a container.
DiscoverClasses discovers existing classes from the resctrl filesystem.
GetClass returns one RDT class.
GetClasses returns all available RDT classes.
GetMonFeatures returns the available monitoring stats of each available monitoring technology.
Initialize detects RDT from the system and initializes control interface of the package.
IsQualifiedClassName returns true if given string qualifies as a class name.
MonSupported returns true if RDT monitoring features are available.
NewCollector creates new Prometheus collector of RDT metrics.
RegisterCustomPrometheusLabels registers monitor group annotations to be exported as Prometheus metrics labels.
SetConfig (re-)configures the resctrl filesystem according to the specified configuration.
SetConfigFromData takes configuration as raw data, parses it and reconfigures the resctrl filesystem.
SetConfigFromFile reads configuration from the filesystem and reconfigures the resctrl filesystem.
SetLogger sets the logger instance to be used by the package.

# Constants

CacheIdAll is a special cache id used to denote a default, used as a fallback for all cache ids that are not explicitly specified.
No description provided by the author
No description provided by the author
MonResourceL3 is the RDT L3 cache monitor resource.
RdtContainerAnnotation is the CRI level container annotation for setting the RDT class (CLOS) of a container.
RdtPodAnnotation is a Pod annotation for setting the RDT class (CLOS) of all containers of the pod.
RdtPodAnnotationContainerPrefix is prefix for per-container Pod annotation for setting the RDT class (CLOS) of one container of the pod.
RootClassAlias is an alternative name for the root class.
RootClassName is the name we use in our config for the special class that configures the "root" resctrl group of the system.

# Structs

CacheIdCatConfig is the cache allocation configuration for one cache id.
CatOptions contains the common settings for cache allocation.
Config is the user-specified RDT configuration.
KubernetesOptions contains per-class settings for the Kubernetes-related functionality.
MbOptions contains the common settings for memory bandwidth allocation.
MonData contains monitoring stats of one monitoring group.
Options contains common settings.

# Interfaces

CtrlGroup defines the interface of one goresctrl managed RDT class.
MonGroup represents the interface to a RDT monitoring group.
ResctrlGroup is the generic interface for resctrl CTRL and MON groups.

# Type aliases

CacheIdMbaConfig is the memory bandwidth configuration for one cache id.
CacheProportion specifies a share of the available cache lines.
CatConfig contains the L2 or L3 cache allocation configuration for one partition or class.
MbaConfig contains the memory bandwidth configuration for one partition or class.
MbProportion specifies a share of available memory bandwidth.
MonL3Data contains L3 monitoring stats of one monitoring group.
MonLeafData represents the raw numerical stats from one RDT monitor data leaf.
MonResource is the type of RDT monitoring resource.