Documentation
¶
Index ¶
- Variables
- func New(logger log.Logger, c *Config) (integrations.Integration, error)
- type Config
- func (c *Config) GetIncludedMetrics() (container.MetricSet, error)
- func (c *Config) InstanceKey(agentKey string) (string, error)
- func (c *Config) Name() string
- func (c *Config) NewIntegration(logger log.Logger) (integrations.Integration, error)
- func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultConfig = Config{
StoreContainerLabels: true,
ResctrlInterval: 0,
StorageDuration: 2 * time.Minute,
Containerd: "/run/containerd/containerd.sock",
ContainerdNamespace: "k8s.io",
Docker: "unix:///var/run/docker.sock",
DockerTLS: false,
DockerTLSCert: "cert.pem",
DockerTLSKey: "key.pem",
DockerTLSCA: "ca.pem",
DockerOnly: false,
DisableRootCgroupStats: false,
}
DefaultConfig holds the default settings for the cadvisor integration
Functions ¶
Types ¶
type Config ¶
type Config struct {
// Common cadvisor config options
// StoreContainerLabels converts container labels and environment variables into labels on prometheus metrics for each container. If false, then only metrics exported are container name, first alias, and image name.
StoreContainerLabels bool `yaml:"store_container_labels,omitempty"`
// AllowlistedContainerLabels list of container labels to be converted to labels on prometheus metrics for each container. store_container_labels must be set to false for this to take effect.
AllowlistedContainerLabels []string `yaml:"allowlisted_container_labels,omitempty"`
// EnvMetadataAllowlist list of environment variable keys matched with specified prefix that needs to be collected for containers, only support containerd and docker runtime for now.
EnvMetadataAllowlist []string `yaml:"env_metadata_allowlist,omitempty"`
// RawCgroupPrefixAllowlist list of cgroup path prefix that needs to be collected even when -docker_only is specified.
RawCgroupPrefixAllowlist []string `yaml:"raw_cgroup_prefix_allowlist,omitempty"`
// PerfEventsConfig path to a JSON file containing configuration of perf events to measure. Empty value disabled perf events measuring.
PerfEventsConfig string `yaml:"perf_events_config,omitempty"`
// ResctrlInterval resctrl mon groups updating interval. Zero value disables updating mon groups.
ResctrlInterval int64 `yaml:"resctrl_interval,omitempty"`
// DisableMetrics list of `metrics` to be disabled.
DisabledMetrics []string `yaml:"disabled_metrics,omitempty"`
// EnableMetrics list of `metrics` to be enabled. If set, overrides 'disable_metrics'.
EnabledMetrics []string `yaml:"enabled_metrics,omitempty"`
// StorageDuration length of time to keep data stored in memory (Default: 2m)
StorageDuration time.Duration `yaml:"storage_duration,omitempty"`
// Containerd config options
// Containerd containerd endpoint
Containerd string `yaml:"containerd,omitempty"`
// ContainerdNamespace containerd namespace
ContainerdNamespace string `yaml:"containerd_namespace,omitempty"`
// Docker config options
// Docker docker endpoint
Docker string `yaml:"docker,omitempty"`
// DockerTLS use TLS to connect to docker
DockerTLS bool `yaml:"docker_tls,omitempty"`
// DockerTLSCert path to client certificate
DockerTLSCert string `yaml:"docker_tls_cert,omitempty"`
// DockerTLSKey path to private key
DockerTLSKey string `yaml:"docker_tls_key,omitempty"`
// DockerTLSCA path to trusted CA
DockerTLSCA string `yaml:"docker_tls_ca,omitempty"`
// Raw config options
// DockerOnly only report docker containers in addition to root stats
DockerOnly bool `yaml:"docker_only,omitempty"`
// DisableRootCgroupStats informs the exporter not collecting stats from the root cgroup.
DisableRootCgroupStats bool `yaml:"disable_root_cgroup_stats,omitempty"`
// contains filtered or unexported fields
}
Config controls cadvisor
func (*Config) GetIncludedMetrics ¶
func (c *Config) GetIncludedMetrics() (container.MetricSet, error)
GetIncludedMetrics applies some logic to determine the final set of metrics to be scraped and returned by the cAdvisor integration
func (*Config) InstanceKey ¶
func (c *Config) InstanceKey(agentKey string) (string, error)
InstanceKey returns the agentKey
func (*Config) Name ¶
func (c *Config) Name() string
Name returns the name of the integration that this config represents.
func (*Config) NewIntegration ¶
func (c *Config) NewIntegration(logger log.Logger) (integrations.Integration, error)
NewIntegration creates a new cadvisor integration
func (*Config) UnmarshalYAML ¶
func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements yaml.Unmarshaler for Config
Click to show internal directories.
Click to hide internal directories.