文档 Grafana Alloy 参考 组件 otelcol otelcol.receiver.opencensus

otelcol.receiver.opencensus

otelcol.receiver.opencensus 接收通过 gRPC 或 HTTP 使用 OpenCensus 格式的遥测数据，并将其转发到其他 otelcol.* 组件。

注意：otelcol.receiver.opencensus 是对来自 otelcol-contrib 发行版的上游 OpenTelemetry Collector opencensus 接收器的封装。错误报告或功能请求将在必要时重定向到上游仓库。

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

用法

alloy 复制

otelcol.receiver.opencensus "LABEL" {
  output {
    metrics = [...]
    logs    = [...]
    traces  = [...]
  }
}

参数

otelcol.receiver.opencensus 支持以下参数

cors_allowed_origins 是允许的 HTTP/JSON 请求的 CORS 源。空列表表示完全禁用 CORS。通配符 (*) 可用于匹配任何源或源的一个或多个字符。

“endpoint” 参数对于 gRPC 和 HTTP/JSON 都是相同的，因为协议会被识别并进行相应的处理。

要使用 HTTP/JSON 写入链路追踪，请 POST 到 [address]/v1/trace。JSON 消息格式与 gRPC protobuf 格式并行。有关详细信息，请参阅其 OpenApi 规范。

请注意，max_recv_msg_size、read_buffer_size 和 write_buffer_size 的格式中包含了单位，例如 “512KiB” 或 “1024KB”。

块

otelcol.receiver.opencensus 的定义内部支持以下块

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

tls 块

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

支持以下参数

如果 reload_interval 设置为 "0s"，则证书永远不会重新加载。

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

• ca_pem 和 ca_file
• cert_pem 和 cert_file
• key_pem 和 key_file

如果 cipher_suites 留空，则使用安全的默认列表。有关支持的密码套件列表，请参阅 Go Cipher Suites 文档。

client_ca_file 将 ClientCA 和 ClientAuth 设置为 TLSConfig 中的 RequireAndVerifyClientCert。有关更多信息，请参阅 Go TLS 文档。

keepalive 块

keepalive 块配置与 gRPC 服务器连接的 Keepalive 设置。

keepalive 不支持任何参数，并且完全通过内部块进行配置。

server_parameters 块

server_parameters 块控制 gRPC 服务器的 Keepalive 和最大生存期设置。

支持以下参数

enforcement_policy 块

enforcement_policy 块配置 gRPC 服务器的 Keepalive 强制策略。服务器将关闭来自违反配置策略的客户端的连接。

支持以下参数

debug_metrics 块

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

支持以下参数

disable_high_cardinality_metrics 是 Grafana Alloy 等效于 OpenTelemetry Collector 中的 telemetry.disableHighCardinalityMetrics 功能门。它会删除可能导致高基数指标的属性。例如，删除了关于 HTTP 和 gRPC 连接的指标中包含 IP 地址和端口号的属性。

level 是 Alloy 等效于 OpenTelemetry Collector 中的 telemetry.metrics.level 功能门。可能的值为 "none"、"basic"、"normal" 和 "detailed"。

output 块

output 块配置一组组件，用于将生成的遥测数据转发到这些组件。

支持以下参数

您必须指定 output 块，但其所有参数都是可选的。默认情况下，遥测数据将被丢弃。相应地配置 metrics、logs 和 traces 参数，以将遥测数据发送到其他组件。

导出的字段

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

组件健康状况

仅当 otelcol.receiver.opencensus 被赋予无效配置时，才会被报告为不健康。

调试信息

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

示例

此示例通过批处理器转发接收到的遥测数据，然后最终将其发送到支持 OTLP 的端点

alloy 复制

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 = sys.env("OTLP_ENDPOINT")
    }
}

启用身份验证

您可以创建一个 otelcol.receiver.opencensus 组件，该组件要求对请求进行身份验证。这对于限制谁可以将数据推送到服务器非常有用。

alloy 复制

otelcol.receiver.opencensus "default" {
  auth = otelcol.auth.basic.creds.handler
}

otelcol.auth.basic "creds" {
    username = sys.env("USERNAME")
    password = sys.env("PASSWORD")
}

兼容组件

otelcol.receiver.opencensus 可以接受来自以下组件的参数

• 导出 OpenTelemetry otelcol.Consumer 的组件