菜单
文档breadcrumb arrow Grafana Alloybreadcrumb arrow 参考breadcrumb arrow 组件breadcrumb arrow otelcolbreadcrumb arrow otelcol.receiver.zipkin
开源

otelcol.receiver.zipkin

otelcol.receiver.zipkin 接受网络上传来的Zipkin格式跟踪信息并将其转发到其他 otelcol.* 组件。

注意otelcol.receiver.zipkin 是 OpenTelemetry Collector zipkin 接收器的包装。如有必要,bug 报告或功能请求将被重定向到上游仓库。

可以通过给它们不同的标签来指定多个 otelcol.receiver.zipkin 组件。

用法

alloy
otelcol.receiver.zipkin "LABEL" {
  output {
    traces = [...]
  }
}

参数

otelcol.receiver.zipkin 支持以下参数

名称类型描述默认值必需
parse_string_tags布尔值解析字符串标记和二进制注释为非字符串类型。false
endpoint字符串要监听流量的 host:port"0.0.0.0:9411"
max_request_body_size字符串服务器允许的最大请求体大小。20MiB
include_metadata布尔值将传入连接的元数据传播到下游消费者。
compression_algorithms字符串列表服务器可以接受的压缩算法列表。["", "gzip", "zstd", "zlib", "snappy", "deflate"]

如果 parse_string_tagstrue,则如果可能,将字符串标记和二进制注释转换为 intboolfloat。无法转换的字符串标记和二进制注释保持不变。

支持以下块在 otelcol.receiver.zipkin 定义内部

层级描述必需
tlstls配置 HTTP 服务器的 TLS。
corscors配置 HTTP 服务器的 CORS。
debug_metricsdebug_metrics配置此组件生成的指标以监视其状态。
outputoutput配置将接收到的跟踪信息发送到何处。yes

符号 > 表示更深的嵌套层级。例如,grpc > tls 指的是在 grpc 块内定义的 tls 块。

tls 块

tls 块配置用于服务器的 TLS 设置。如果未提供 tls 块,则服务器连接不会使用 TLS。

以下参数受支持

名称类型描述默认值必需
ca_file字符串CA 文件的路径。
ca_pem字符串用于验证服务器的 CA PEM 编码文本。
cert_file字符串TLS 证书的路径。
cert_pem字符串用于客户端身份验证的证书 PEM 编码文本。
include_system_ca_certs_pool布尔值是否与证书 authority 一起加载系统证书权威池。false
key_file字符串TLS 证书私钥的路径。
key_pemsecret用于客户端身份验证的密钥 PEM 编码文本。
max_version字符串连接可接受的TLS最大版本。"TLS 1.3"
min_version字符串连接可接受的最低TLS版本。"TLS 1.2"
cipher_suites字符串列表一个可以由TLS传输使用的TLS加密套件的列表。[]
reload_intervalduration在证书重新加载后的持续时间。"0s"
client_ca_file字符串服务器使用的TLS证书的路径,用于验证客户端证书。

如果将reload_interval设置为"0s",则证书从不重新加载。

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

  • ca_pemca_file
  • cert_pemcert_file
  • key_pemkey_file

如果留空cipher_suites,将使用安全默认列表。有关受支持的加密套件列表,请参阅Go 加密套件文档

client_ca_file设置TLSConfig中的ClientCAClientAuthRequireAndVerifyClientCert。有关更多信息,请参阅Go TLS文档

cors block

cors块配置HTTP服务器的CORS设置。

以下参数受支持

名称类型描述默认值必需
allowed_origins字符串列表Origin头部的允许值。
allowed_headers字符串列表CORS请求接受的头部。["X-Requested-With"]
max_agenumber配置Access-Control-Max-Age响应头部。

allowed_headers参数指定CORS请求可以接受的哪些头部。以下头部始终隐式允许。

  • Accept
  • Accept-Language
  • Content-Type
  • Content-Language

如果allowed_headers包含"*",则允许所有头部。

debug_metrics block

debug_metrics块配置组件生成以监控其状态的指标。

以下参数受支持

名称类型描述默认值必需
disable_high_cardinality_metrics布尔值是否禁用某些高基数指标。true
level字符串控制封装收集器发出的指标的详细程度。"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"

output block

output块配置一组组件,以将结果遥测数据转发到。

以下参数受支持

名称类型描述默认值必需
logslist(otelcol.Consumer)要发送日志的消费者列表。[]
metricslist(otelcol.Consumer)要发送指标的消费者列表。[]
traceslist(otelcol.Consumer)要将跟踪发送到的消费者列表。[]

必须指定output块,但所有参数都是可选的。默认情况下,遥测数据将被丢弃。根据需要配置metricslogstraces参数,以将遥测数据发送到其他组件。

导出字段

otelcol.receiver.zipkin不导出任何字段。

组件健康

如果提供无效配置,则otelcol.receiver.zipkin仅报告为不健康。

调试信息

otelcol.receiver.zipkin不公开任何特定于组件的调试信息。

示例

此示例通过批处理器将接收到的跟踪转发表后,最终将其发送到具有OTLP功能的端点。

alloy
otelcol.receiver.zipkin "default" {
  output {
    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.zipkin可以接受来自以下组件的参数

注意

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