菜单
开源

发现.lightsail

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

用法

alloy
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_headermap(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_urlno_proxy

应仅配置 proxy_connect_header,如果已配置 proxy_urlproxy_from_environment

以下块在 discovery.lightsail 定义内部受支持

层次结构描述必需
基本认证基本认证为访问端点配置基本认证。
授权授权为端点配置通用的授权。
OAuth2OAuth2为访问端点配置OAuth2。
oauth2 > tls_configtls_config配置连接到端点的TLS设置。
tls_configtls_config配置连接到端点的TLS设置。

>符号表示更深层的嵌套级别。例如,oauth2 > tls_config 指的是一个定义在 oauth2 块内部的 tls_config 块。

基本认证块

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

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

授权块

名称类型描述默认值必需
credentials_file字符串包含秘密值的文件。
credentials秘密秘密值。
type字符串授权类型,例如,“Bearer”。

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

oauth2 块

名称类型描述默认值必需
client_id字符串OAuth2客户端ID。
client_secret_file字符串包含OAuth2客户端秘密的文件。
client_secret秘密OAuth2客户端秘密。
endpoint_paramsmap(string)可选参数,可以附加到令牌URL。
proxy_url字符串发送请求通过的 HTTP 代理。
no_proxy字符串逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除代理。
proxy_from_environment布尔值使用环境变量中指示的代理 URL。false
proxy_connect_headermap(list(secret))指定在连接请求期间发送到代理的标头。
scopeslist(string)用于认证的权限列表。
token_url字符串从其中获取令牌的URL。

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

应仅配置 proxy_connect_header,如果已配置 proxy_urlproxy_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_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远程写入兼容服务器的URL。
  • USERNAME:用于远程写入API认证的用户名。
  • PASSWORD:用于远程写入API认证的密码。

兼容组件

discovery.lightsail导出的内容可以被以下组件消费

注意

连接某些组件可能不合理,或者组件可能需要进一步配置才能正确连接。有关更多信息,请参阅链接的文档。