菜单
正式发布 (GA) 开源

discovery.lightsail

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

用法

alloy
discovery.lightsail "<LABEL>" {
}

参数

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

名称类型描述默认值必需
access_keystringAWS API 密钥 ID。如果留空,则使用环境变量 AWS_ACCESS_KEY_ID
bearer_token_filestring包含用于身份验证的 bearer token 的文件。
bearer_tokensecret用于身份验证的 Bearer token。
enable_http2bool请求是否支持 HTTP2。
endpointstring要使用的自定义端点。
follow_redirectsbool是否应跟随服务器返回的重定向。
http_headersmap(list(secret))随每个请求发送的自定义 HTTP 头部。映射键是头部名称。
no_proxystring以逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。
portint抓取指标的端口。如果使用公共 IP 地址,则必须在重新打标签规则中指定此项。80
profilestring用于连接到 API 的命名 AWS 配置文件。
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送给代理的头部。
proxy_from_environmentbool使用环境变量指示的代理 URL。
proxy_urlstring用于发送请求的 HTTP 代理。
refresh_intervalstring重新读取实例列表的刷新间隔。60s
regionstringAWS 区域。如果留空,则使用实例元数据中的区域。
role_arnstringAWS Role ARN,是使用 AWS API 密钥的替代方案。
secret_keystringAWS 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_urlno_proxy

proxy_connect_header 仅在配置了 proxy_urlproxy_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_filestring包含 secret 值的文件。
credentialssecretSecret 值。
typestring授权类型,例如“Bearer”。

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

basic_auth

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

名称类型描述默认值必需
password_filestring包含 basic auth 密码的文件。
passwordsecretBasic auth 密码。
usernamestringBasic auth 用户名。

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

oauth2

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

名称类型描述默认值必需
client_idstringOAuth2 客户端 ID。
client_secret_filestring包含 OAuth2 客户端 secret 的文件。
client_secretsecretOAuth2 客户端 secret。
endpoint_paramsmap(string)可选参数,附加到 token URL。
proxy_urlstring用于发送请求的 HTTP 代理。
no_proxystring以逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。
proxy_from_environmentbool使用环境变量指示的代理 URL。
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送给代理的头部。
scopeslist(string)用于身份验证的 scope 列表。
token_urlstring获取 token 的 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_connect_header 仅在配置了 proxy_urlproxy_from_environment 时才应配置。

tls_config

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

名称类型描述默认值必需
ca_pemstring用于验证服务器的 CA PEM 编码文本。
ca_filestring用于验证服务器的 CA 证书。
cert_pemstring用于客户端身份验证的证书 PEM 编码文本。
cert_filestring用于客户端身份验证的证书文件。
insecure_skip_verifybool禁用服务器证书验证。
key_filestring用于客户端身份验证的密钥文件。
key_pemsecret用于客户端身份验证的密钥 PEM 编码文本。
min_versionstring可接受的最低 TLS 版本。
server_namestringServerName 扩展,用于指示服务器名称。

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

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

示例

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

注意

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