发现.lightsail
discovery.lightsail
允许从 Amazon Lightsail 实例检索抓取目标。默认使用私用 IP 地址,但可以通过重新标记更改为公用 IP 地址。
用法
discovery.lightsail "LABEL" {
}
参数
以下参数受支持
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
endpoint | 字符串 | 要使用的自定义端点。 | 否 | |
region | 字符串 | 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 | 否 |
port | 整数 | 用于抓取指标的端口。如果使用公网 IP 地址,则必须在重新标记规则中指定此参数。 | 80 | 否 |
bearer_token_file | 字符串 | 包含用于认证的承载令牌的文件。 | 否 | |
bearer_token | 秘密 | 用于认证的承载令牌。 | 否 | |
enable_http2 | 布尔值 | 是否支持 HTTP2 请求。 | true | 否 |
follow_redirects | 布尔值 | 是否应遵循服务器返回的重定向。 | true | 否 |
proxy_url | 字符串 | 发送请求通过的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除代理。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量中指示的代理 URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在连接请求期间发送到代理的标头。 | 否 |
最多可提供以下之一
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
定义内部受支持
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
基本认证 | 基本认证 | 为访问端点配置基本认证。 | 否 |
授权 | 授权 | 为端点配置通用的授权。 | 否 |
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。 | 否 | |
proxy_url | 字符串 | 发送请求通过的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除代理。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量中指示的代理 URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在连接请求期间发送到代理的标头。 | 否 | |
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_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 | 布尔值 | 禁用服务器证书的验证。 | 否 | |
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)) | 发现的一组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
导出的内容可以被以下组件消费
- 消费目标的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能正确连接。有关更多信息,请参阅链接的文档。