菜单
通用可用性 (GA)

discovery.lightsail

discovery.lightsail 允许从 Amazon Lightsail 实例检索抓取目标。默认使用私有 IP 地址,但可以使用重新标记更改为公共 IP 地址。

用法

alloy
discovery.lightsail "<LABEL>" {
}

参数

您可以将以下参数与 discovery.lightsail 一起使用

名称类型描述默认值必需
access_key字符串AWS API 密钥 ID。如果为空,则使用环境变量 AWS_ACCESS_KEY_ID
bearer_token_file字符串包含用于身份验证的 Bearer 令牌的文件。
bearer_tokensecret用于身份验证的 Bearer 令牌。
enable_http2bool是否支持为请求使用 HTTP2。true
endpoint字符串要使用的自定义端点。
follow_redirectsbool是否应跟随服务器返回的重定向。true
no_proxy字符串逗号分隔的 IP 地址、CIDR 表示法和域名列表,以排除在代理之外。
portint从中抓取指标的端口。如果使用公共 IP 地址,则必须在重新标记规则中指定此端口。80
profile字符串用于连接到 API 的命名 AWS 配置文件。
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送到代理的标头。
proxy_from_environmentbool使用环境变量指示的代理 URL。false
proxy_url字符串用于发送请求的 HTTP 代理。
refresh_interval字符串重新读取实例列表的刷新间隔。60秒
region字符串AWS 区域。如果为空,则使用实例元数据中的区域。
role_arn字符串AWS 角色 ARN,是使用 AWS API 密钥的替代方法。
secret_key字符串AWS API 密钥密钥。如果为空,则使用环境变量 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_urlno_proxy

只有在配置了 proxy_urlproxy_from_environment 时,才应配置 proxy_connect_header

您可以将以下块与 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字符串包含密钥值的文件。
credentialssecret密钥值。
type字符串授权类型,例如“Bearer”。

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

basic_auth

basic_auth 块配置对端点的基本身份验证。

名称类型描述默认值必需
password_file字符串包含基本身份验证密码的文件。
passwordsecret基本身份验证密码。
username字符串基本身份验证用户名。

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

oauth2

oauth 块配置对端点的 OAuth 2.0 身份验证。

名称类型描述默认值必需
client_id字符串OAuth2 客户端 ID。
client_secret_file字符串包含 OAuth2 客户端密钥的文件。
client_secretsecretOAuth2 客户端密钥。
endpoint_paramsmap(string)要附加到令牌 URL 的可选参数。
proxy_url字符串用于发送请求的 HTTP 代理。
no_proxy字符串逗号分隔的 IP 地址、CIDR 表示法和域名列表,以排除在代理之外。
proxy_from_environmentbool使用环境变量指示的代理 URL。false
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送到代理的标头。
scopeslist(string)要进行身份验证的作用域列表。
token_url字符串从中获取令牌的 URL。

client_secretclient_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_urlno_proxy

只有在配置了 proxy_urlproxy_from_environment 时,才应配置 proxy_connect_header

tls_config

tls_config 块配置用于连接到端点的 TLS 设置。

名称类型描述默认值必需
ca_pem字符串用于验证服务器的 CA PEM 编码文本。
ca_file字符串用于验证服务器的 CA 证书。
cert_pem字符串用于客户端身份验证的证书 PEM 编码文本。
cert_file字符串用于客户端身份验证的证书文件。
insecure_skip_verifybool禁用服务器证书的验证。
key_file字符串用于客户端身份验证的密钥文件。
key_pemsecret用于客户端身份验证的密钥 PEM 编码文本。
min_version字符串最低可接受的 TLS 版本。
server_name字符串ServerName 扩展,用于指示服务器的名称。

以下参数对是互斥的,不能同时设置

  • 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))发现的 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 不公开任何组件特定的调试指标。

示例

alloy
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 具有可供以下组件使用的导出

注意

连接某些组件可能不明智,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。