菜单
开源

发现.linode

discovery.linode 允许您从 Linode 的 Linode APIv4 中检索抓取目标。此服务发现默认使用公网 IPv4 地址,但可以通过重命名来更改。

用法

alloy
discovery.linode "LABEL" {
	bearer_token = LINODE_API_TOKEN
}

注意

必须使用作用域 linodes:read_onlyips:read_onlyevents:read_only 创建 linode APIv4 Token。

参数

以下是支持的参数

名称类型描述默认值必需
refresh_intervalduration轮询更新请求之间的等待时间。"60s"no
portint抓取指标所用的端口。80no
tag_separatorstringLinode 实例标签通过该字符串连接到标签标签。,no
bearer_token_filestring包含用于身份验证的承载令牌的文件。no
bearer_tokensecret用于身份验证的承载令牌。no
enable_http2bool是否支持针对请求的 HTTP2。trueno
follow_redirectsbool是否应遵循服务器返回的重定向。trueno
proxy_urlstring通过其发送请求的 HTTP 代理。no
no_proxystring逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除代理。no
proxy_from_environmentbool使用环境变量指示的代理 URL。falseno
proxy_connect_headermap(list(secret))指定在连接请求期间发送到代理的头。no

最多可以提供以下之一

no_proxy 可以包含 IP 地址、CIDR 表示法和域名。IP 和域名可以包含端口号。《proxy_url》必须在配置 no_proxy 时配置。

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或其小写版本)。请求使用与它们的方案匹配的环境变量中的代理,除非被 NO_PROXY 排除。如果配置了 proxy_from_environment,则不得配置 proxy_urlno_proxy

proxy_connect_header 仅当配置了 proxy_urlproxy_from_environment 时才应配置。

以下是定义 discovery.linode 时支持的块

层级描述必需
basic_authbasic_auth配置对端点的基本身份验证。no
authorizationauthorization配置对端点的通用身份验证。no
oauth2oauth2配置OAuth2以对端点进行身份验证。no
oauth2 > tls_configtls_config配置连接到端点的TLS设置。no
tls_configtls_config配置连接到端点的TLS设置。no

符号“>”表示更深的嵌套级别。例如,oauth2 > tls_config指的是在oauth2块内定义的tls_config块。

基本身份验证块

名称类型描述默认值必需
password_filestring包含基本认证密码的文件。no
passwordsecret基本认证密码。no
usernamestring基本认证用户名。no

passwordpassword_file是相互排斥的,并且在basic_auth块中只能提供一个。

授权块

名称类型描述默认值必需
credentials_filestring包含密钥值的文件。no
credentialssecret密钥值。no
typestring授权类型,例如,“Bearer”。no

credentialcredentials_file是相互排斥的,并且在authorization块中只能提供一个。

oauth2块

名称类型描述默认值必需
client_idstringOAuth2客户端ID。no
client_secret_filestring包含OAuth2客户端密钥的文件。no
client_secretsecretOAuth2客户端密钥。no
endpoint_paramsmap(string)要附加到令牌URL的可选参数。no
proxy_urlstring通过其发送请求的 HTTP 代理。no
no_proxystring逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除代理。no
proxy_from_environmentbool使用环境变量指示的代理 URL。falseno
proxy_connect_headermap(list(secret))指定在连接请求期间发送到代理的头。no
scopeslist(string)要身份验证的作用域列表。no
token_urlstring用于获取令牌的URL。no

client_secretclient_secret_file是相互排斥的,并且在oauth2块中只能提供一个。

oauth2块还可以包含单独的tls_config子块。

no_proxy 可以包含 IP 地址、CIDR 表示法和域名。IP 和域名可以包含端口号。《proxy_url》必须在配置 no_proxy 时配置。

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或其小写版本)。请求使用与它们的方案匹配的环境变量中的代理,除非被 NO_PROXY 排除。如果配置了 proxy_from_environment,则不得配置 proxy_urlno_proxy

proxy_connect_header 仅当配置了 proxy_urlproxy_from_environment 时才应配置。

tls_config块

名称类型描述默认值必需
ca_pemstring用于验证服务器的CA PEM编码文本。no
ca_filestring用于验证服务器的CA证书。no
cert_pemstring用于客户端认证的证书PEM编码文本。no
cert_filestring用于客户端认证的证书文件。no
insecure_skip_verifybool禁用服务器证书的验证。no
key_filestring用于客户端认证的密钥文件。no
key_pemsecret用于客户端认证的密钥PEM编码文本。no
min_versionstring接受的最小TLS版本。no
server_namestring用于指示服务器名的ServerName扩展。no

以下参数组是相互排斥的,不能同时设置

  • ca_pemca_file
  • cert_pemcert_file
  • key_pemkey_file

在配置客户端认证时,必须提供客户端证书(使用cert_pemcert_file)和客户端密钥(使用key_pemkey_file)。

当不提供min_version时,接受的最小TLS版本继承自Go的默认最小版本,TLS 1.2。如果提供min_version,则必须将其设置为以下字符串之一

  • "TLS10"(TLS 1.0)
  • "TLS11"(TLS 1.1)
  • "TLS12"(TLS 1.2)
  • "TLS13"(TLS 1.3)

导出字段

以下字段是导出的,可以被其他组件引用

名称类型描述
targetslist(map(string))从Linode API发现的目标集。

以下元标签在目标上可用,并可以被discovery.relabel组件使用

  • __meta_linode_instance_id:Linode实例的ID
  • __meta_linode_instance_label:Linode实例的标签
  • __meta_linode_image:Linode实例镜像的slug
  • __meta_linode_private_ipv4:Linode实例的私有IPv4
  • __meta_linode_public_ipv4:Linode实例的公共IPv4
  • __meta_linode_public_ipv6:Linode实例的公共IPv6
  • __meta_linode_region:Linode实例的区域
  • __meta_linode_type:Linode实例的类型
  • __meta_linode_status:Linode实例的状态
  • __meta_linode_tags:使用标签分隔符连接的Linode实例标签列表
  • __meta_linode_group:Linode实例所属的显示组
  • __meta_linode_hypervisor:为Linode实例提供虚拟化的软件
  • __meta_linode_backups:Linode实例的备份服务状态
  • __meta_linode_specs_disk_bytes:Linode实例可访问的存储空间量
  • __meta_linode_specs_memory_bytes:Linode实例可访问的RAM量
  • __meta_linode_specs_vcpus:此Linode可访问的VCPUS数量
  • __meta_linode_specs_transfer_bytes:Linode实例每月分配的网络传输量
  • __meta_linode_extra_ips:用标签分隔符连接的所有分配给Linode实例的额外IPv4地址列表

组件健康状态

discovery.linode只有在给出无效配置时才会报告为不健康。在这些情况下,导出的字段保留其最后的健康值。

调试信息

discovery.linode不公开任何特定组件的调试信息。

调试指标

discovery.linode不公开任何特定组件的调试指标。

示例

alloy
discovery.linode "example" {
    bearer_token = env("LINODE_TOKEN")
    port = 8876
}
prometheus.scrape "demo" {
	targets    = discovery.linode.example.targets
	forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
	endpoint {
		url = PROMETHEUS_REMOTE_WRITE_URL
		basic_auth {
			username = USERNAME
			password = PASSWORD
		}
	}
}

替换以下

  • PROMETHEUS_REMOTE_WRITE_URL:将指标发送到的Prometheus remote_write兼容服务器的URL。
  • USERNAME:用于远程写入API认证的用户名。
  • PASSWORD:用于远程写入API认证的密码。

使用私有IP地址

discovery.linode "example" {
    bearer_token = env("LINODE_TOKEN")
    port = 8876
}
discovery.relabel "private_ips" {
	targets = discovery.linode.example.targets
	rule {
    	source_labels = ["__meta_linode_private_ipv4"]
    	replacement     = "[$1]:8876"
    	target_label  = "__address__"
  	}
}
prometheus.scrape "demo" {
	targets    = discovery.relabel.private_ips.targets
	forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
	endpoint {
		url = PROMETHEUS_REMOTE_WRITE_URL
		basic_auth {
			username = USERNAME
			password = PASSWORD
		}
	}
}

兼容组件

discovery.linode有导出,这些导出可以由以下组件消费

注意

连接某些组件可能不合理或组件可能需要进一步配置才能正确建立连接。请参阅相关文档了解详细信息。