发现Eureka
discovery.eureka
发现Eureka注册表中的实例并将其作为目标暴露。
用法
discovery.eureka "LABEL" {
server = SERVER
}
参数
以下参数是被支持的
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
server | 字符串 | Eureka服务器URL。 | 是 | |
refresh_interval | 持续时间 | 刷新目标列表的间隔。 | 30秒 | 否 |
bearer_token_file | 字符串 | 包含用于认证的令牌的文件。 | 否 | |
bearer_token | 秘密 | 用于认证的令牌。 | 否 | |
enable_http2 | 布尔 | 是否支持HTTP2用于请求。 | 真 | 否 |
follow_redirects | 布尔 | 是否应跟踪服务器返回的重定向。 | 真 | 否 |
proxy_url | 字符串 | 用于发送请求的HTTP代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的IP地址、CIDR表示法域名,要从代理中排除。 | 否 | |
proxy_from_environment | 布尔 | 使用环境变量指示的代理URL。 | false | 否 |
proxy_connect_header | list(map(list(secret))) | 指定在连接请求期间向代理发送的标头。 | 否 |
以下最多可以提供一个
no_proxy
可以包含IP、CIDR表示法域名。IP和域名可以包含端口号。《code>proxy_url如果no_proxy
配置,则必须配置。
proxy_from_environment
使用环境变量HTTP_PROXY、HTTPS_PROXY和NO_PROXY或它们的_lowercase_版本。除非NO_PROXY排除,否则请求将使用与环境变量匹配的代理。如果配置了proxy_from_environment
,则不得配置《code>proxy_url和《code>no_proxy。
proxy_connect_header
应仅当配置了《code>proxy_url或《code>proxy_from_environment时配置。
块
在《code>discovery.eureka定义内部支持以下块
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
basic_auth | basic_auth | 配置端点的basic_auth。 | 否 |
authorization | authorization | 配置端点的通用授权。 | 否 |
oauth2 | oauth2 | 配置端点的OAuth2。 | 否 |
oauth2 > tls_config | tls_config | 配置连接到端点的TLS设置。 | 否 |
tls_config | tls_config | 配置连接到端点的TLS设置。 | 否 |
符号 >
表示更深层次的嵌套级别。例如,oauth2 > tls_config
指的是一个定义在 oauth2
块内部的 tls_config
块。
basic_auth 块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | 字符串 | 包含基本认证密码的文件。 | 否 | |
password | 秘密 | 基本认证密码。 | 否 | |
username | 字符串 | 基本认证用户名。 | 否 |
password
和 password_file
是互斥的,在 basic_auth
块内部只能提供其中之一。
authorization 块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
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 | list(map(list(secret))) | 指定在连接请求期间向代理发送的标头。 | 否 | |
scopes | list(string) | 用于认证的作用域列表。 | 否 | |
token_url | 字符串 | 用于获取令牌的 URL。 | 否 |
client_secret
和 client_secret_file
是互斥的,在 oauth2
块内部只能提供其中之一。
oauth2
块还可以包含一个独立的 tls_config
子块。
no_proxy
可以包含IP、CIDR表示法域名。IP和域名可以包含端口号。《code>proxy_url如果no_proxy
配置,则必须配置。
proxy_from_environment
使用环境变量HTTP_PROXY、HTTPS_PROXY和NO_PROXY或它们的_lowercase_版本。除非NO_PROXY排除,否则请求将使用与环境变量匹配的代理。如果配置了proxy_from_environment
,则不得配置《code>proxy_url和《code>no_proxy。
proxy_connect_header
应仅当配置了《code>proxy_url或《code>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)) | 从 Eureka API 发现的目标集。 |
每个目标包含以下标签
__meta_eureka_app_name
__meta_eureka_app_instance_hostname
__meta_eureka_app_instance_homepage_url
__meta_eureka_app_instance_statuspage_url
__meta_eureka_app_instance_healthcheck_url
__meta_eureka_app_instance_ip_addr
__meta_eureka_app_instance_vip_address
__meta_eureka_app_instance_secure_vip_address
__meta_eureka_app_instance_status
__meta_eureka_app_instance_port
__meta_eureka_app_instance_port_enabled
__meta_eureka_app_instance_secure_port
__meta_eureka_app_instance_secure_port_enabled
__meta_eureka_app_instance_datacenterinfo_name
__meta_eureka_app_instance_datacenterinfo_metadata_
__meta_eureka_app_instance_country_id
__meta_eureka_app_instance_id
__meta_eureka_app_instance_metadata_
组件健康
discovery.eureka
只有在配置无效时才报告为不健康。在这种情况下,导出字段保持其最后健康的值。
调试信息
discovery.eureka
不公开任何组件特定的调试信息。
调试指标
discovery.eureka
不公开任何组件特定的调试指标。
示例
discovery.eureka "example" {
server = "https://eureka.example.com/eureka/v1"
}
prometheus.scrape "demo" {
targets = discovery.eureka.example.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.eureka
有以下组件可以消耗的导出内容
- 消耗 目标 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能正确建立连接。有关更多详情,请参阅相关文档。