otelcol.exporter.otlphttp
otelcol.exporter.otlphttp
接受来自其他 otelcol
组件的遥测数据,并使用 OTLP HTTP 协议通过网络写入这些数据。
注意
otelcol.exporter.otlphttp
是对上游 OpenTelemetry Collectorotlphttp
导出器的封装。Bug 报告或功能请求将被重定向到上游仓库(如有必要)。
您可以通过为多个 otelcol.exporter.otlphttp
组件提供不同的标签来指定它们。
用法
otelcol.exporter.otlphttp "LABEL" {
client {
endpoint = "HOST:PORT"
}
}
参数
otelcol.exporter.otlphttp
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
metrics_endpoint | string | 要将指标发送到的端点。 | client.endpoint + "/v1/metrics" | 否 |
logs_endpoint | string | 要将日志发送到的端点。 | client.endpoint + "/v1/logs" | 否 |
traces_endpoint | string | 要将追踪发送到的端点。 | client.endpoint + "/v1/traces" | 否 |
encoding | string | 用于消息的编码。应为 "proto" 或 "json" 。 | "proto" | 否 |
默认值取决于必需的 client
块中设置的 endpoint
字段。如果设置,这些参数将覆盖相应信号的 client.endpoint
字段。
块
在 otelcol.exporter.otlphttp
的定义中支持以下块
层级结构 | 块 | 描述 | 必需 |
---|---|---|---|
client | client | 配置用于发送遥测数据的 HTTP 服务器。 | 是 |
client > tls | tls | 为 HTTP 客户端配置 TLS。 | 否 |
client > cookies | cookies | 存储来自服务器响应的 Cookie,并在后续请求中重用它们。 | 否 |
sending_queue | sending_queue | 配置发送前的数据批处理。 | 否 |
retry_on_failure | retry_on_failure | 配置失败请求的重试机制。 | 否 |
debug_metrics | debug_metrics | 配置此组件生成的用于监控其状态的指标。 | 否 |
>
符号表示更深层次的嵌套。例如,client > tls
指的是在 client
块内定义的 tls
块。
client 块
client
块配置组件使用的 HTTP 客户端。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
endpoint | string | 要将遥测数据发送到的目标 URL。 | 是 | |
proxy_url | string | 用于发送请求的 HTTP 代理。 | ||
read_buffer_size | string | HTTP 客户端用于读取服务器响应的读取缓冲区大小。 | 0 | 否 |
write_buffer_size | string | HTTP 客户端用于写入请求的写入缓冲区大小。 | "512KiB" | 否 |
timeout | duration | 将请求标记为失败之前等待的时间。 | "30s" | 否 |
headers | map(string) | 随请求发送的其他标头。 | {} | 否 |
compression | string | 用于请求的压缩机制。 | "gzip" | 否 |
max_idle_conns | int | 限制客户端可以保持打开的空闲 HTTP 连接数。 | 100 | 否 |
max_idle_conns_per_host | int | 限制主机可以保持打开的空闲 HTTP 连接数。 | 0 | 否 |
max_conns_per_host | int | 限制每个主机的总连接数(拨号、活动和空闲)。 | 0 | 否 |
idle_conn_timeout | duration | 空闲连接自行关闭之前等待的时间。 | "90s" | 否 |
disable_keep_alives | bool | 禁用 HTTP keep-alive。 | false | 否 |
http2_read_idle_timeout | duration | 如果在连接上未收到任何帧,则在此超时后将使用 ping 帧执行运行状况检查。 | 0s | 否 |
http2_ping_timeout | duration | 如果在未收到 Ping 响应的情况下,连接将在此超时后关闭。 | 15s | 否 |
auth | capsule(otelcol.Handler) | 来自 otelcol.auth 组件的处理程序,用于对请求进行身份验证。 | 否 |
设置 headers
时,请注意
- 某些标头(例如
Content-Length
和Connection
)在需要时会自动写入,headers
中的值可能会被忽略。 Host
标头会自动从endpoint
值派生。但是,可以通过在headers
中显式设置Host
标头来覆盖此自动分配。
将 disable_keep_alives
设置为 true
将导致为每个请求建立新的 HTTP 或 HTTPS 连接的巨大开销。在启用此选项之前,请考虑更改空闲连接设置是否可以实现您的目标。
如果 http2_ping_timeout
未设置或设置为 0s
,则默认值为 15s
。
如果 http2_read_idle_timeout
未设置或设置为 0s
,则不会执行运行状况检查。
默认情况下,请求使用 Gzip 压缩。compression
参数控制要使用的压缩机制。支持的字符串为
"gzip"
"zlib"
"deflate"
"snappy"
"zstd"
如果将 compression
设置为 "none"
或空字符串 ""
,则请求不会被压缩。
cookies 块
cookies
块允许 HTTP 客户端存储来自服务器响应的 Cookie,并在后续请求中重用它们。
这在诸如负载均衡器依赖 Cookie 来实现粘性会话并强制执行最大会话期限等情况下可能很有用。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
enabled | bool | 要将遥测数据发送到的目标 URL。 | false | 否 |
tls 块
tls
块配置用于连接到 HTTP 服务器的 TLS 设置。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
ca_file | string | CA 文件的路径。 | 否 | |
ca_pem | string | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
cert_file | string | TLS 证书的路径。 | 否 | |
cert_pem | string | 用于客户端身份验证的证书 PEM 编码文本。 | 否 | |
insecure_skip_verify | boolean | 忽略不安全的服务器 TLS 证书。 | 否 | |
include_system_ca_certs_pool | boolean | 是否加载系统证书颁发机构池以及证书颁发机构。 | false | 否 |
insecure | boolean | 连接到配置的服务器时禁用 TLS。 | 否 | |
key_file | string | TLS 证书密钥的路径。 | 否 | |
key_pem | secret | 用于客户端身份验证的密钥 PEM 编码文本。 | 否 | |
max_version | string | 连接的最大可接受 TLS 版本。 | "TLS 1.3" | 否 |
min_version | string | 连接的最小可接受 TLS 版本。 | "TLS 1.2" | 否 |
cipher_suites | list(string) | TLS 传输可以使用的 TLS 密码套件列表。 | [] | 否 |
reload_interval | duration | 证书重新加载的持续时间。 | "0s" | 否 |
server_name | string | 设置后,验证服务器证书的主机名。 | 否 |
如果服务器不支持 TLS,则必须将 insecure
参数设置为 true
。
要禁用与服务器连接的 tls
,请将 insecure
参数设置为 true
。
如果 reload_interval
设置为 "0s"
,则证书永远不会重新加载。
以下参数对互斥,不能同时设置
ca_pem
和ca_file
cert_pem
和cert_file
key_pem
和key_file
如果 cipher_suites
留空,则使用安全的默认列表。有关支持的密码套件的列表,请参阅 Go TLS 文档。
sending_queue 块
sending_queue
块在数据发送到 HTTP 服务器之前配置批处理的内存缓冲区。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
enabled | boolean | 在将数据发送到客户端之前启用内存缓冲区。 | true | 否 |
num_consumers | number | 并行发送写入队列的批处理的读取器数量。 | 10 | 否 |
queue_size | number | 队列中同时允许的最大未写入批处理数。 | 1000 | 否 |
当 enabled
为 true
时,数据首先写入内存缓冲区,然后再发送到配置的服务器。发送到组件的 input
导出字段的批处理会添加到缓冲区,只要未发送批处理的数量不超过配置的 queue_size
。
queue_size
决定了端点中断的容忍时间。假设每秒 100 个请求,默认队列大小 1000
提供大约 10 秒的中断容忍时间。要计算 queue_size
的正确值,请将每秒的平均传出请求数乘以容忍中断的时间(秒)。非常高的值可能会导致内存不足 (OOM) 终止。
num_consumers
参数控制有多少读取器从缓冲区读取并并行发送数据。较大的 num_consumers
值允许更快地发送数据,但会增加网络流量。
retry_on_failure 块
retry_on_failure
块配置如何重试对 HTTP 服务器的失败请求。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
enabled | boolean | 启用重试失败的请求。 | true | 否 |
initial_interval | duration | 重试失败请求之前等待的初始时间。 | "5s" | 否 |
max_elapsed_time | duration | 丢弃失败批处理之前等待的最长时间。 | "5m" | 否 |
max_interval | duration | 重试之间等待的最长时间。 | "30s" | 否 |
multiplier | number | 用于增加重试前等待时间的系数。 | 1.5 | 否 |
randomization_factor | number | 用于随机化重试前等待时间的系数。 | 0.5 | 否 |
当 enabled
为 true
时,失败的批处理会在给定的间隔后重试。initial_interval
参数指定第一次重试尝试之前等待的时间长度。如果请求继续失败,则重试之前等待的时间将按 multiplier
参数指定的系数增加,该系数必须大于 1.0
。max_interval
参数指定重试之间等待时间长度的上限。
randomization_factor
参数对于在重试 Alloy 实例之间添加抖动很有用。如果 randomization_factor
大于 0
,则重试前的等待时间将乘以范围 [ I - randomization_factor * I, I + randomization_factor * I]
内的随机因子,其中 I
是当前间隔。
如果批处理未成功发送,则在 max_elapsed_time
指定的时间过去后将其丢弃。如果 max_elapsed_time
设置为 "0s"
,则失败的请求将永远重试,直到成功为止。
debug_metrics 块
debug_metrics
块配置此组件生成的用于监控其状态的指标。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
disable_high_cardinality_metrics | boolean | 是否禁用某些高基数指标。 | true | 否 |
level | string | 控制包装的收集器发出的指标的详细程度。 | "detailed" | 否 |
disable_high_cardinality_metrics
是 Grafana Alloy 等效于 OpenTelemetry Collector 中的 telemetry.disableHighCardinalityMetrics
功能门。它删除了可能导致高基数指标的属性。例如,删除了有关 HTTP 和 gRPC 连接的指标中具有 IP 地址和端口号的属性。
注意
如果配置了,
disable_high_cardinality_metrics
仅适用于otelcol.exporter.*
和otelcol.receiver.*
组件。
level
是 Alloy 等效于 OpenTelemetry Collector 中的 telemetry.metrics.level
功能门。可能的值为 "none"
、"basic"
、"normal"
和 "detailed"
。
导出字段
以下字段已导出,可以被其他组件引用
名称 | 类型 | 描述 |
---|---|---|
input | otelcol.Consumer | 其他组件可用于向其发送遥测数据的值。 |
input
接受任何遥测信号(指标、日志或追踪)的 otelcol.Consumer
数据。
组件健康状况
仅当 otelcol.exporter.otlphttp
配置无效时,才报告为不健康。
调试信息
otelcol.exporter.otlphttp
不公开任何组件特定的调试信息。
示例
此示例创建了一个导出器,用于将数据发送到本地运行的无 TLS 的 Grafana Tempo
otelcol.exporter.otlphttp "tempo" {
client {
endpoint = "http://tempo:4317"
tls {
insecure = true
insecure_skip_verify = true
}
}
}
兼容组件
otelcol.exporter.otlphttp
具有可被以下组件使用的导出:
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。