otelcol.receiver.opencensus
otelcol.receiver.opencensus
通过 gRPC 或 HTTP 接受使用 OpenCensus 格式的遥测数据,并将其转发到其他 otelcol.*
组件。
注意:
otelcol.receiver.opencensus
是otelcol-contrib
发行版中对上游 OpenTelemetry Collector 的opencensus
接收器的包装。如需提交错误报告或功能请求,将直接转至上游存储库。
可以通过指定不同的标签来指定多个 otelcol.receiver.opencensus
组件。
使用方法
otelcol.receiver.opencensus "LABEL" {
output {
metrics = [...]
logs = [...]
traces = [...]
}
}
参数
otelcol.receiver.opencensus
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必备 |
---|---|---|---|---|
cors_allowed_origins | list(string) | 允许的跨源资源共享 (CORS) 域列表。 | no | |
endpoint | string | 用于监听流量的 host:port 。 | "0.0.0.0:55678" | no |
transport | string | 用于 gRPC 服务器的传输。 | "tcp" | no |
max_recv_msg_size | string | 服务器可以接受的最大消息大小。 | "4MiB" " | no |
max_concurrent_streams | number | 限制并发流式 RPC 调用的数量。 | no | |
read_buffer_size | string | gRPC 服务器将从客户端读取的读取缓冲区的大小。 | "512KiB" | no |
write_buffer_size | string | gRPC 服务器将用于写入客户端的写入缓冲区的大小。 | no | |
include_metadata | boolean | 将传入连接的元数据传递到下游消费者。 | no |
cors_allowed_origins
是 HTTP/JSON 请求允许的 CORS 域。空列表表示完全未启用 CORS。可以使用通配符 (*) 匹配任何域或域的任意字符。
“endpoint”参数对于 gRPC 和 HTTP/JSON 都是相同的,因为协议会被相应识别和处理。
要使用 HTTP/JSON 写入跟踪,请向 [address]/v1/trace
发送 POST
请求。JSON 消息格式与 gRPC protobuf 格式平行。详细信息,请参阅其 OpenApi 规范。
请注意,max_recv_msg_size
、read_buffer_size
和 write_buffer_size
的格式包含单位,例如“512KiB”或“1024KB”。
支持的块
以下块支持在 otelcol.receiver.opencensus
的定义内部使用
层次结构 | 块 | 描述 | 必备 |
---|---|---|---|
tls | tls | 为gRPC服务器配置TLS。 | no |
keepalive | keepalive | 配置已配置服务器的keepalive设置。 | no |
keepalive > server_parameters | server_parameters | 用于配置keepalive设置的服务器参数。 | no |
keepalive > enforcement_policy | enforcement_policy | keepalive设置的执行策略。 | no |
debug_metrics | debug_metrics | 配置此组件生成的用于监控其状态的指标。 | no |
output | output | 配置接收到的遥测数据发送到何处。 | yes |
“>”符号表示嵌套的更深层级。例如,grpc > tls
指的是在grpc
块内定义的tls
块。
tls块
tls
块配置服务器使用的TLS设置。如果没有提供tls
块,则服务器不会使用TLS进行连接。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必备 |
---|---|---|---|---|
ca_file | string | CA文件路径。 | no | |
ca_pem | string | 用于验证服务器的CA PEM编码文本。 | no | |
cert_file | string | TLS证书路径。 | no | |
cert_pem | string | 用于客户端身份验证的证书PEM编码文本。 | no | |
include_system_ca_certs_pool | boolean | 是否与证书颁发机构一起加载系统证书颁发机构池。 | false | no |
key_file | string | TLS证书密钥路径。 | no | |
key_pem | secret | 用于客户端身份验证的密钥PEM编码文本。 | no | |
max_version | string | 接受连接的最大TLS版本。 | "TLS 1.3" | no |
min_version | string | 接受连接的最小TLS版本。 | "TLS 1.2" | no |
cipher_suites | list(string) | TLS传输可以使用的TLS加密套件列表。 | [] | no |
reload_interval | duration | 在证书刷新后的持续时间。 | "0s" | no |
client_ca_file | string | 服务器用于验证客户端证书的TLS证书路径。 | no |
如果将reload_interval
设置为"0s"
,则证书不会刷新。
以下参数对是互相排斥的,不能同时设置
ca_pem
和ca_file
cert_pem
和cert_file
key_pem
和key_file
如果留空cipher_suites
,则使用安全的默认列表。有关支持的加密套件列表,请参阅Go加密套件文档。
client_ca_file
将TLSConfig
中的ClientCA
和ClientAuth
设置为RequireAndVerifyClientCert
。有关更多信息,请参阅Go TLS文档。
keepalive块
keepalive
块配置对gRPC服务器连接的keepalive设置。
keepalive
不支持任何参数,通过内部块完全配置。
server_parameters块
server_parameters
块控制gRPC服务器的keepalive和最大年龄设置。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必备 |
---|---|---|---|---|
max_connection_idle | duration | 空闲连接的最大年龄。 | "infinity" | no |
max_connection_age | duration | 非空闲连接的最大年龄。 | "infinity" | no |
max_connection_age_grace | duration | 在强制关闭连接之前等待的时间。 | "infinity" | no |
time | duration | 通常ping空闲客户端以检查活动性。 | "2h" | no |
timeout | duration | 在关闭对活动性检查无响应的空闲客户端之前等待的时间。 | "20s" | no |
enforcement_policy块
enforcement_policy
块配置gRPC服务器的keepalive执行策略。服务器将关闭违反配置策略的客户端连接。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必备 |
---|---|---|---|---|
min_time | duration | 客户端发送keepalive ping之前应等待的最短时间。 | "5m" | no |
permit_without_stream | boolean | 允许客户端在没有活动流的情况下发送keepalive ping。 | false | no |
debug_metrics块
debug_metrics
块配置此组件生成的指标以监控其状态。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必备 |
---|---|---|---|---|
disable_high_cardinality_metrics | boolean | 是否禁用某些高基数指标。 | true | no |
level | string | 控制被包装收集器发出的指标的详细程度。 | "detailed" | no |
disable_high_cardinality_metrics
是 Grafana Alloy 对 OpenTelemetry Collector 中的 telemetry.disableHighCardinalityMetrics
功能开关的等效。它删除可能导致高基数指标的属性。例如,删除关于 HTTP 和 gRPC 连接的指标中的 IP 地址和端口号属性。
注意
如果配置了,disable_high_cardinality_metrics
仅适用于otelcol.exporter.*
和otelcol.receiver.*
组件。
level
是 OpenTelemetry Collector 中 telemetry.metrics.level
功能开关的 Alloy 等效。可能的值是 "none"
、"basic"
、"normal"
和 "detailed"
。
输出块
output
块配置一组组件,将结果遥测数据转发到。
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必备 |
---|---|---|---|---|
日志 | list(otelcol.Consumer) | 要发送日志的消费者列表。 | [] | no |
度量 | list(otelcol.Consumer) | 要发送度量值的消费者列表。 | [] | no |
追踪 | list(otelcol.Consumer) | 要发送跟踪的消费者列表。 | [] | no |
您必须指定 output
块,但所有参数都是可选的。默认情况下,遥测数据将被丢弃。相应地配置 metrics
、logs
和 traces
参数,以将遥测数据发送到其他组件。
已导出字段
otelcol.receiver.opencensus
不导出任何字段。
组件健康
otelcol.receiver.opencensus
只有在给出无效配置时才报告为不健康。
调试信息
otelcol.receiver.opencensus
不公开任何特定于组件的调试信息。
示例
此示例在最终将接收到的遥测数据发送到 OTLP 兼容端点之前,通过批量处理器将其转发
otelcol.receiver.opencensus "default" {
cors_allowed_origins = ["https://*.test.com", "https://test.com"]
endpoint = "0.0.0.0:9090"
transport = "tcp"
max_recv_msg_size = "32KB"
max_concurrent_streams = "16"
read_buffer_size = "1024KB"
write_buffer_size = "1024KB"
include_metadata = true
tls {
cert_file = "test.crt"
key_file = "test.key"
}
keepalive {
server_parameters {
max_connection_idle = "11s"
max_connection_age = "12s"
max_connection_age_grace = "13s"
time = "30s"
timeout = "5s"
}
enforcement_policy {
min_time = "10s"
permit_without_stream = true
}
}
output {
metrics = [otelcol.processor.batch.default.input]
logs = [otelcol.processor.batch.default.input]
traces = [otelcol.processor.batch.default.input]
}
}
otelcol.processor.batch "default" {
output {
metrics = [otelcol.exporter.otlp.default.input]
logs = [otelcol.exporter.otlp.default.input]
traces = [otelcol.exporter.otlp.default.input]
}
}
otelcol.exporter.otlp "default" {
client {
endpoint = env("OTLP_ENDPOINT")
}
}
兼容组件
otelcol.receiver.opencensus
可以接受以下组件的参数
注意
连接某些组件可能不合逻辑,或组件可能需要进一步配置才能正确连接。有关更多详细信息,请参阅链接的文档。