cadvisor

README

cadvisor

cadvisor 采集插件， 采集cadvisor 数据，如果是通过kubelet采集，可以附加pod的label和annotation

Configuration

# # collect interval
# interval = 15

[[instances]]
# 填写kubelet的ip和port
url = "https://1.2.3.4:10250/metrics/cadvisor"
# 如果path为空, 会自动补齐为/metrics/cadvisor
# url = "https://1.2.3.4:10250"
# 如果是通过kubelet采集，可以附加pod的label和annotation
type = "kubelet"

# 直接采集cadvisor , type 设置为cadvisor
#url = "http://1.2.3.4:8080/metrics"
#type = "cadvisor"

# url_label_key 和 url_label_value 用法参加下面说明
url_label_key = "instance"
url_label_value = "{{.Host}}"
# # 认证的token 或者token file
#bearer_token_string = "eyJhblonglongXXX.eyJplonglongYYY.oQsXlonglongZ-Z-Z"
bearer_token_file = "/path/to/token/file"

# 需要忽略的label key
ignore_label_keys = ["id","name", "container_label*"]
# 只采集那些label key, 建议保持为空，采集所有的label。 优先级高于ignore_label_keys。
#choose_label_keys = ["*"]

timeout = "3s"

# # Optional TLS Config
# # 想跳过自签证书，use_tls 记得要配置为true
use_tls = true
# tls_min_version = "1.2"
# tls_ca = "/etc/categraf/ca.pem"
# tls_cert = "/etc/categraf/cert.pem"
# tls_key = "/etc/categraf/key.pem"
## Use TLS but skip chain & host verification
insecure_skip_verify = true

url_label_key 和 url_label_value 用法

# 从URL中提取Host部分，放到instance label中 
# 假设 url =https://1.2.3.4:10250/metrics/cadvisor 
# 最终附加的label为 instance=1.2.3.4:10250

url_label_key = "instance" 
url_label_value = "{{.Host}}"

如果 scheme 部分和 path 部分都想取，可以这么写：

url_label_value = "{{.Scheme}}://{{.Host}}{{.Path}}"

相关变量是用这个方法生成的，供大家参考：

func (ul *UrlLabel) GenerateLabel(u *url.URL) (string, string, error) {
	if ul.LabelValue == "" {
		return ul.LabelKey, u.String(), nil
	}

	dict := map[string]string{
		"Scheme":   u.Scheme,
		"Host":     u.Host,
		"Hostname": u.Hostname(),
		"Port":     u.Port(),
		"Path":     u.Path,
		"Query":    u.RawQuery,
		"Fragment": u.Fragment,
	}

	var buffer bytes.Buffer
	err := ul.LabelValueTpl.Execute(&buffer, dict)
	if err != nil {
		return "", "", err
	}

	return ul.LabelKey, buffer.String(), nil
}

以 http://1.2.3.4:8080/search?q=keyword#results 为例, 变量及其值如下:

variable	value
{{.Scheme}}	http
{{.Host}}	1.2.3.4:8080
{{.Hostname}}	1.2.3.4
{{.Port}}	8080
{{.Path}}	search
{{.Query}}	q=keyword
{{.Fragment}}	results

Documentation

Index

• type Cadvisor
  • func (c *Cadvisor) Clone() inputs.Input
  • func (c *Cadvisor) Drop()
  • func (c *Cadvisor) GetInstances() []inputs.Instance
  • func (c *Cadvisor) Name() string
• type CadvisorType
• type Instance
  • func (ins *Instance) Drop()
  • func (ins *Instance) Empty() bool
  • func (ins *Instance) Gather(slist *types.SampleList)
  • func (ins *Instance) Init() error

Types

type Cadvisor

type Cadvisor struct {
	config.PluginConfig
	Instances []*Instance `toml:"instances"`
}

func (*Cadvisor) Clone

func (c *Cadvisor) Clone() inputs.Input

func (*Cadvisor) Drop

func (c *Cadvisor) Drop()

func (*Cadvisor) GetInstances

func (c *Cadvisor) GetInstances() []inputs.Instance

func (*Cadvisor) Name

func (c *Cadvisor) Name() string

type CadvisorType

type CadvisorType string

const (
	ContainerType CadvisorType = "cadvisor"
	NodeType      CadvisorType = "kubelet"
)

type Instance

type Instance struct {
	config.InstanceConfig

	URL  string       `toml:"url"`
	Type CadvisorType `toml:"type"`

	NamePrefix        string          `toml:"name_prefix"`
	BearerTokenString string          `toml:"bearer_token_string"`
	BearerTokeFile    string          `toml:"bearer_token_file"`
	Username          string          `toml:"username"`
	Password          string          `toml:"password"`
	Timeout           config.Duration `toml:"timeout"`
	IgnoreMetrics     []string        `toml:"ignore_metrics"`
	IgnoreLabelKeys   []string        `toml:"ignore_label_keys"`
	Headers           []string        `toml:"headers"`

	ChooseLabelKeys []string `toml:"choose_label_keys"`

	config.UrlLabel

	tls.ClientConfig

	*cache.BasicCache[string]
	// contains filtered or unexported fields
}

func (*Instance) Drop

func (ins *Instance) Drop()

func (*Instance) Empty

func (ins *Instance) Empty() bool

func (*Instance) Gather

func (ins *Instance) Gather(slist *types.SampleList)

func (*Instance) Init

func (ins *Instance) Init() error