发现lightsail
discovery.lightsail
允许从 Amazon Lightsail 实例检索抓取目标。默认情况下使用私有 IP 地址,但可以通过重命名更改到公共 IP 地址。
用法
discovery.lightsail "LABEL" {
}
参数
支持以下参数
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
端点 | 字符串 | 要使用的自定义端点。 | 否 | |
区域 | 字符串 | AWS区域。如果为空,则使用实例元数据中的区域。 | 否 | |
access_key | 字符串 | AWS API密钥ID。如果为空,则使用环境变量AWS_ACCESS_KEY_ID 。 | 否 | |
secret_key | 字符串 | AWS API密钥秘密。如果为空,则使用环境变量AWS_SECRET_ACCESS_KEY 。 | 否 | |
profile | 字符串 | 用于连接API的命名AWS配置文件。 | 否 | |
role_arn | 字符串 | AWS角色ARN,是使用AWS API密钥的替代方案。 | 否 | |
refresh_interval | 字符串 | 刷新间隔以重新读取实例列表。 | 60s | 否 |
端口 | int | 从其中抓取指标的端口。如果使用公共IP地址,则必须在重写规则中指定此值。 | 80 | 否 |
bearer_token_file | 字符串 | 包含用于认证的承载令牌的文件。 | 否 | |
bearer_token | secret | 用于认证的承载令牌。 | 否 | |
enable_http2 | bool | 是否支持HTTP2进行请求。 | true | 否 |
follow_redirects | bool | 是否应跟随服务器返回的重定向。 | true | 否 |
proxy_url | 字符串 | 发送请求要通过的HTTP代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的IP地址、CIDR表示法和域名列表,不包括在代理中。 | 否 | |
proxy_from_environment | bool | 使用环境变量中指示的代理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_from_environment
,则不得配置proxy_url
和no_proxy
。
proxy_connect_header
应仅在配置了proxy_url
或proxy_from_environment
时配置。
块
以下块支持在discovery.lightsail
定义内
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
basic_auth | 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
块。
basic_auth块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
password_file | 字符串 | 包含基本认证密码的文件。 | 否 | |
password | secret | 基本认证密码。 | 否 | |
username | 字符串 | 基本认证用户名。 | 否 |
password
和password_file
互斥,并且在basic_auth
块内只能提供其中一个。
authorization块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
credentials_file | 字符串 | 包含秘密值的文件。 | 否 | |
credentials | secret | 秘密值。 | 否 | |
type | 字符串 | 授权类型,例如,“Bearer”。 | 否 |
credential
和credentials_file
互斥,并且在authorization
块内只能提供其中一个。
oauth2块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
client_id | 字符串 | OAuth2客户端ID。 | 否 | |
client_secret_file | 字符串 | 包含OAuth2客户端秘密的文件。 | 否 | |
client_secret | secret | OAuth2客户端秘密。 | 否 | |
endpoint_params | map(string) | 可选参数,用于追加到令牌URL中。 | 否 | |
proxy_url | 字符串 | 发送请求要通过的HTTP代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的IP地址、CIDR表示法和域名列表,不包括在代理中。 | 否 | |
proxy_from_environment | bool | 使用环境变量中指示的代理URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在CONNECT请求期间发送到代理的标题。 | 否 | |
作用域 | 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_from_environment
,则不得配置proxy_url
和no_proxy
。
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 | bool | 禁用服务器证书的验证。 | 否 | |
key_file | 字符串 | 客户端认证的密钥文件。 | 否 | |
key_pem | secret | 客户端认证的密钥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)) | 发现的Lightsail目标集合。 |
每个目标包含以下标签
__meta_lightsail_availability_zone
:实例运行的可用区。__meta_lightsail_blueprint_id
:Lightsail蓝图ID。__meta_lightsail_bundle_id
:Lightsail捆绑ID。__meta_lightsail_instance_name
:Lightsail实例的名称。__meta_lightsail_instance_state
:Lightsail实例的状态。__meta_lightsail_instance_support_code
:Lightsail实例的支持代码。__meta_lightsail_ipv6_addresses
:如果存在,则为实例的网络接口分配的IPv6地址的逗号分隔列表。__meta_lightsail_private_ip
:实例的私有IP地址。__meta_lightsail_public_ip
:如果可用,则为实例的公共IP地址。__meta_lightsail_region
:实例所在的区域。__meta_lightsail_tag_<tagkey>
:实例的每个标签值。
组件健康
discovery.lightsail
只有在给定无效配置时才会报告为不健康。在这些情况下,导出字段保留其最后的健康值。
调试信息
discovery.lightsail
不公开任何组件特定的调试信息。
调试指标
discovery.lightsail
不公开任何组件特定的调试指标。
示例
discovery.lightsail "lightsail" {
region = "us-east-1"
}
prometheus.scrape "demo" {
targets = discovery.lightsail.lightsail.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 远程写入兼容服务器的 URL。USERNAME
: 用于远程写入 API 认证的用户名。PASSWORD
: 用于远程写入 API 认证的密码。
兼容组件
discovery.lightsail
有导出可以被以下组件消费
- 消费 目标 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步的配置才能正确连接。请参阅链接文档以获取更多详细信息。