Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana Agent Grafana Agent Flow Reference Components 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.

NOTE: otelcol.receiver.opencensus is a wrapper over the upstream OpenTelemetry Collector opencensus receiver from the otelcol-contrib distribution. Bug reports or feature requests will be redirected to the upstream repository, if necessary.

Multiple otelcol.receiver.opencensus components can be specified by giving them different labels.

Usage

river Copy

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

Arguments

otelcol.receiver.opencensus supports the following arguments:

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

Blocks

The following blocks are supported inside the definition of otelcol.receiver.opencensus:

The > symbol indicates deeper levels of nesting. For example, grpc > tls refers to a tls block defined inside a grpc block.

grpc block

The grpc block configures the gRPC/HTTP server used by the component. If the grpc block isn’t provided, a server using default parameters is started.

The following arguments are supported:

In order to use plain HTTP/JSON, specify the endpoint attribute. There is no HTTP-specific block. The HTTP/JSON address is the same as gRPC, 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.

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

tls block

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.

The following arguments are supported:

keepalive block

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.

server_parameters block

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

The following arguments are supported:

enforcement_policy block

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

The following arguments are supported:

output block

The output block configures a set of components to forward resulting telemetry data to.

The following arguments are supported:

The output block must be specified, but all of its arguments are optional. By default, telemetry data is dropped. To send telemetry data to other components, configure the metrics, logs, and traces arguments accordingly.

Exported fields

otelcol.receiver.opencensus does not export any fields.

Component health

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

Debug information

otelcol.receiver.opencensus does not 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:

river Copy

Expand code

otelcol.receiver.opencensus "default" {
	cors_allowed_origins = ["https://*.test.com", "https://test.com"]

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