Documentation Grafana Cloud Instrument and send data Grafana Alloy Reference Components otelcol otelcol.receiver.opencensus

otelcol.receiver.opencensus

otelcol.receiver.opencensus accepts telemetry data via gRPC or HTTP using the OpenCensus format and forwards it to other otelcol.* components.

You can specify multiple otelcol.receiver.opencensus components by giving them different labels.

Usage

alloy Copy

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

Arguments

You can use the following arguments with otelcol.receiver.opencensus:

cors_allowed_origins are the allowed CORS origins for HTTP/JSON requests. An empty list means that CORS isn’t enabled at all. A wildcard (*) can be used to match any origin or one or more characters of an origin.

The “endpoint” parameter is the same for both gRPC and HTTP/JSON, as the protocol is recognized and processed accordingly.

To write traces with HTTP/JSON, POST to [address]/v1/trace. The JSON message format parallels the gRPC protobuf format. For details, refer to its OpenApi specification.

max_recv_msg_size, read_buffer_size and write_buffer_size are formatted in a way so that the units are included in the string, such as “512KiB” or “1024KB”.

Blocks

You can use the following blocks with otelcol.receiver.opencensus:

The > symbol indicates deeper levels of nesting. For example, keepalive > enforcesment_policy refers to an enforcement_policy block defined inside a keepalive block.

output

debug_metrics

keepalive

The keepalive block configures keepalive settings for connections to a gRPC server.

keepalive doesn’t support any arguments and is configured fully through inner blocks.

enforcement_policy

The enforcement_policy block configures the keepalive enforcement policy for gRPC servers. The server closes connections from clients that violate the configured policy.

The following arguments are supported:

server_parameters

The server_parameters block controls keepalive and maximum age settings for gRPC servers.

The following arguments are supported:

tls

The tls block configures TLS settings used for a server. If the tls block isn’t provided, TLS won’t be used for connections to the server.

tpm

The tpm block configures retrieving the TLS key_file from a trusted device.

The following arguments are supported:

Name	Type	Description	Default	Required
auth	string	The authorization value used to authenticate the TPM device.	""	no
enabled	bool	Load the tls.key_file from TPM.	false	no
owner_auth	string	The owner authorization value used to authenticate the TPM device.	""	no
path	string	Path to the TPM device or Unix domain socket.	""	no

The trusted platform module (TPM) configuration can be used for loading TLS key from TPM. Currently only TSS2 format is supported.

The path attribute is not supported on Windows.

Example

alloy Copy

otelcol.example.component "<LABEL>" {
    ...
    tls {
        ...
        key_file = "my-tss2-key.key"
        tpm {
            enabled = true
            path = "/dev/tpmrm0"
        }
    }
}

In the above example, the private key my-tss2-key.key in TSS2 format will be loaded from the TPM device /dev/tmprm0.

Exported fields

otelcol.receiver.opencensus doesn’t export any fields.

Component health

otelcol.receiver.opencensus is only reported as unhealthy if given an invalid configuration.

Debug information

otelcol.receiver.opencensus doesn’t expose any component-specific debug information.

Example

This example forwards received telemetry data through a batch processor before finally sending it to an OTLP-capable endpoint:

alloy Copy

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>")
    }
}

Enable authentication

You can create a otelcol.receiver.opencensus component that requires authentication for requests. This is useful for limiting who can push data to the server.

alloy Copy

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

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

Compatible components

otelcol.receiver.opencensus can accept arguments from the following components:

• Components that export OpenTelemetry otelcol.Consumer