discovery.lightsail
discovery.lightsail
允许从 Amazon Lightsail 实例检索抓取目标。默认使用私有 IP 地址,但可以通过重新打标签更改为公共 IP 地址。
用法
discovery.lightsail "<LABEL>" {
}
参数
您可以将以下参数与 discovery.lightsail
一起使用
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
access_key | string | AWS API 密钥 ID。如果留空,则使用环境变量 AWS_ACCESS_KEY_ID 。 | 否 | |
bearer_token_file | string | 包含用于身份验证的 bearer token 的文件。 | 否 | |
bearer_token | secret | 用于身份验证的 Bearer token。 | 否 | |
enable_http2 | bool | 请求是否支持 HTTP2。 | 是 | 否 |
endpoint | string | 要使用的自定义端点。 | 否 | |
follow_redirects | bool | 是否应跟随服务器返回的重定向。 | 是 | 否 |
http_headers | map(list(secret)) | 随每个请求发送的自定义 HTTP 头部。映射键是头部名称。 | 否 | |
no_proxy | string | 以逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
port | int | 抓取指标的端口。如果使用公共 IP 地址,则必须在重新打标签规则中指定此项。 | 80 | 否 |
profile | string | 用于连接到 API 的命名 AWS 配置文件。 | 否 | |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送给代理的头部。 | 否 | |
proxy_from_environment | bool | 使用环境变量指示的代理 URL。 | 否 | 否 |
proxy_url | string | 用于发送请求的 HTTP 代理。 | 否 | |
refresh_interval | string | 重新读取实例列表的刷新间隔。 | 60s | 否 |
region | string | AWS 区域。如果留空,则使用实例元数据中的区域。 | 否 | |
role_arn | string | AWS Role ARN,是使用 AWS API 密钥的替代方案。 | 否 | |
secret_key | string | AWS API 密钥 secret。如果留空,则使用环境变量 AWS_SECRET_ACCESS_KEY 。 | 否 |
最多可提供以下一项
no_proxy
可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy
,则必须配置 proxy_url
。
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
一起使用
块 | 描述 | 必需 |
---|---|---|
authorization | 配置端点的通用授权。 | 否 |
basic_auth | 配置 basic_auth 用于端点身份验证。 | 否 |
oauth2 | 配置 OAuth 2.0 用于端点身份验证。 | 否 |
oauth2 > tls_config | 配置连接到端点的 TLS 设置。 | 否 |
tls_config | 配置连接到端点的 TLS 设置。 | 否 |
> 符号表示更深的嵌套层级。例如,oauth2
> tls_config
指的是在 oauth2
块内定义的 tls_config
块。
authorization
authorization
块配置端点的通用授权。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
credentials_file | string | 包含 secret 值的文件。 | 否 | |
credentials | secret | Secret 值。 | 否 | |
type | string | 授权类型,例如“Bearer”。 | 否 |
credential
和 credentials_file
是互斥的,只能在 authorization
块内提供一个。
basic_auth
basic_auth
块配置端点的基本身份验证。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | string | 包含 basic auth 密码的文件。 | 否 | |
password | secret | Basic auth 密码。 | 否 | |
username | string | Basic auth 用户名。 | 否 |
password
和 password_file
是互斥的,只能在 basic_auth
块内提供一个。
oauth2
oauth2
块配置端点的 OAuth 2.0 身份验证。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | string | OAuth2 客户端 ID。 | 否 | |
client_secret_file | string | 包含 OAuth2 客户端 secret 的文件。 | 否 | |
client_secret | secret | OAuth2 客户端 secret。 | 否 | |
endpoint_params | map(string) | 可选参数,附加到 token URL。 | 否 | |
proxy_url | string | 用于发送请求的 HTTP 代理。 | 否 | |
no_proxy | string | 以逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
proxy_from_environment | bool | 使用环境变量指示的代理 URL。 | 否 | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送给代理的头部。 | 否 | |
scopes | list(string) | 用于身份验证的 scope 列表。 | 否 | |
token_url | string | 获取 token 的 URL。 | 否 |
client_secret
和 client_secret_file
是互斥的,只能在 oauth2
块内提供一个。
oauth2
块也可能包含一个单独的 tls_config
子块。
no_proxy
可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy
,则必须配置 proxy_url
。
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
tls_config
块配置连接到端点的 TLS 设置。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
ca_pem | string | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
ca_file | string | 用于验证服务器的 CA 证书。 | 否 | |
cert_pem | string | 用于客户端身份验证的证书 PEM 编码文本。 | 否 | |
cert_file | string | 用于客户端身份验证的证书文件。 | 否 | |
insecure_skip_verify | bool | 禁用服务器证书验证。 | 否 | |
key_file | string | 用于客户端身份验证的密钥文件。 | 否 | |
key_pem | secret | 用于客户端身份验证的密钥 PEM 编码文本。 | 否 | |
min_version | string | 可接受的最低 TLS 版本。 | 否 | |
server_name | string | 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 bundle 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 remote_write 兼容的服务器 URL。<USERNAME>
:用于 remote_write API 身份验证的用户名。<PASSWORD>
:用于 remote_write API 身份验证的密码。
兼容组件
discovery.lightsail
具有可供以下组件使用的导出内容
- 使用 Target 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能正常工作。有关更多详细信息,请参阅链接的文档。