发现.ionos
发现.ionos
允许您从 IONOS Cloud API 获取抓取目标。
使用方法
discovery.ionos "LABEL" {
datacenter_id = DATACENTER_ID
}
参数
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
datacenter_id | 字符串 | 数据中心的唯一ID。 | 是 | |
刷新间隔 | 持续时间 | 服务器刷新后的时间。 | 60秒 | 否 |
端口 | 整数 | 抓取指标的端口。 | 80 | 否 |
bearer_token_file | 字符串 | 包含认证令牌的文件。 | 否 | |
bearer_token | 密钥 | 用于认证的令牌。 | 否 | |
启用http2 | 布尔值 | 是否支持HTTP2用于请求。 | 是 | 否 |
跟随重定向 | 布尔值 | 是否应跟随服务器返回的重定向。 | 是 | 否 |
代理_url | 字符串 | 要通过其发送请求的HTTP代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的IP地址、CIDR表示法和域名列表,用于排除从代理。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量中指示的代理URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在CONNECT请求期间发送到代理的标头。 | 否 |
以下信息中最多提供一个
no_proxy
可以包含IP、CIDR表示法和域名。IP和域名可以包含端口号。proxy_url
必须配置,如果no_proxy
配置了的话。
proxy_from_environment
使用环境变量HTTP_PROXY、HTTPS_PROXY和NO_PROXY(或其小写版本)。请求使用匹配其方案的环境变量中的代理,除非被NO_PROXY排除。proxy_url
和no_proxy
不能配置,如果proxy_from_environment
已配置。
proxy_connect_header
只应在配置了proxy_url
或proxy_from_environment
时配置。
块
在discovery.ionos
定义内支持以下块
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
basic_auth | basic_auth | 配置基本认证到端点。 | 否 |
authorization | authorization | 配置端点的通用认证。 | 否 |
oauth2 | oauth2 | 配置OAuth2到端点的认证。 | 否 |
oauth2 > tls_config | tls_config | 配置连接到端点的TLS设置。 | 否 |
tls_config | tls_config | 配置连接到端点的TLS设置。 | 否 |
符号《》表示更深层次的嵌套。例如,oauth2 《 tls_config
指的是定义在 oauth2
块内部的 tls_config
块。
基本身份验证块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | 字符串 | 包含基本身份验证密码的文件。 | 否 | |
password | 密钥 | 基本身份验证密码。 | 否 | |
username | 字符串 | 基本身份验证用户名。 | 否 |
password
和 password_file
是相互排斥的,一个 basic_auth
块内只能提供其中之一。
授权块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
credentials_file | 字符串 | 包含秘密值的文件。 | 否 | |
credentials | 密钥 | 秘密值。 | 否 | |
type | 字符串 | 授权类型,例如,“Bearer”。 | 否 |
credential
和 credentials_file
是相互排斥的,一个 authorization
块内只能提供其中之一。
oauth2 块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | 字符串 | OAuth2 客户端 ID。 | 否 | |
client_secret_file | 字符串 | 包含 OAuth2 客户端密钥的文件。 | 否 | |
client_secret | 密钥 | OAuth2 客户端密钥。 | 否 | |
endpoint_params | map(string) | 可选参数,用于附加到令牌 URL。 | 否 | |
代理_url | 字符串 | 要通过其发送请求的HTTP代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的IP地址、CIDR表示法和域名列表,用于排除从代理。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量中指示的代理URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在CONNECT请求期间发送到代理的标头。 | 否 | |
scopes | list(string) | 用于身份验证的作用域列表。 | 否 | |
token_url | 字符串 | 获取令牌的 URL。 | 否 |
client_secret
和 client_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_url
和no_proxy
不能配置,如果proxy_from_environment
已配置。
proxy_connect_header
只应在配置了proxy_url
或proxy_from_environment
时配置。
tls_config 块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
ca_pem | 字符串 | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
ca_file | 字符串 | 用于验证服务器的 CA 证书。 | 否 | |
cert_pem | 字符串 | 用于客户端身份验证的证书 PEM 编码文本。 | 否 | |
cert_file | 字符串 | 用于客户端身份验证的证书文件。 | 否 | |
insecure_skip_verify | 布尔值 | 禁用服务器证书验证。 | 否 | |
key_file | 字符串 | 用于客户端身份验证的密钥文件。 | 否 | |
key_pem | 密钥 | 用于客户端身份验证的密钥 PEM 编码文本。 | 否 | |
min_version | 字符串 | 可接受的最低 TLS 版本。 | 否 | |
server_name | 字符串 | 指示服务器名称的 ServerName 扩展。 | 否 |
以下参数对是相互排斥的,不能同时设置
ca_pem
和ca_file
cert_pem
和cert_file
key_pem
和key_file
在配置客户端身份验证时,必须提供客户端证书(使用 cert_pem
或 cert_file
)和客户端密钥(使用 key_pem
或 key_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)
导出字段
以下字段是导出的,可以被其他组件引用
名称 | 类型 | 描述 |
---|---|---|
targets | list(map(string)) | 来自 IONOS 云 API 发现的目标集合。 |
每个目标包含以下标签
__meta_ionos_server_availability_zone
:服务器所在的可用区。__meta_ionos_server_boot_cdrom_id
:服务器启动的 CD-ROM 的 ID。__meta_ionos_server_boot_image_id
:服务器启动的引导镜像或快照的 ID。__meta_ionos_server_boot_volume_id
:启动卷的 ID。__meta_ionos_server_cpu_family
:服务器的 CPU 类型。__meta_ionos_server_id
:服务器的 ID。__meta_ionos_server_ip
:分配给服务器的所有 IP 的逗号分隔列表。__meta_ionos_server_lifecycle
:服务器资源的生命周期状态。__meta_ionos_server_name
:服务器的名称。__meta_ionos_server_nic_ip_<nic_name>
:按每个连接到服务器的网络接口卡 (NIC) 的名称分组的所有 IP 的逗号分隔列表。__meta_ionos_server_servers_id
:服务器所属的服务器 ID。__meta_ionos_server_state
:服务器的执行状态。__meta_ionos_server_type
:服务器的类型。
组件健康状态
discovery.ionos
仅在提供无效配置时报告为不健康。在这些情况下,导出的字段保留其最后健康的值。
调试信息
discovery.ionos
不暴露任何特定组件的调试信息。
调试指标
discovery.ionos
不暴露任何特定组件的调试指标。
示例
discovery.ionos "example" {
datacenter_id = "15f67991-0f51-4efc-a8ad-ef1fb31a480c"
}
prometheus.scrape "demo" {
targets = discovery.ionos.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
:用于远程_write API 认证的用户名。PASSWORD
:用于远程_write API 认证的密码。
兼容组件
discovery.ionos
直接导出的功能可以被以下组件使用
- 消耗 目标 的组件
注意
连接某些组件可能不合理或可能需要进一步的配置来正确连接。有关更多详细信息,请参考链接的文档。