`otelcol.receiver.googlecloudpubsub`

Community: This component is developed, maintained, and supported by the Alloy user community. Grafana doesn’t offer commercial support for this component. To enable and use community components, you must set the --feature.community-components.enabled flag to true.
Refer to Community components for more information.

otelcol.receiver.googlecloudpubsub receives OpenTelemetry signals from a Google Cloud Pub/Sub subscription and forwards them to other otelcol.* components for processing or export.

Note
otelcol.receiver.googlecloudpubsub is a wrapper over the upstream OpenTelemetry Collector googlecloudpubsub receiver. Bug reports or feature requests will be redirected to the upstream repository, if necessary.

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

Usage

otelcol.receiver.googlecloudpubsub "<LABEL>" {
  subscription = "projects/<PROJECT-ID>/subscriptions/<SUBSCRIPTION-NAME>"

  output {
    logs = [...]
    metrics = [...]
    trace = [...]
  }
}

Arguments

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

Name	Type	Description	Default	Required
`subscription`	`string`	The subscription name to receive OTLP data from. The subscription name should be a fully qualified resource name, for example: `projects/otel-project/subscriptions/otlp`.	`""`	yes
`compression`	`string`	The compression used on data received from the subscription. Only `gzip` is supported. This is only used when no content-encoding attribute is present.	`""`	no
`encoding`	`string`	The encoding used to receive data from the subscription. This can either be `otlp_proto_trace`, `otlp_proto_metric`, `otlp_proto_log` or an encoding extension. This is only used when no media type attribute is present.	`""`	no
`endpoint`	`string`	Override the default Pub/Sub endpoint. This is useful when connecting to the Pub/Sub emulator instance or switching between global and regional service endpoints.	`""`	no
`ignore_encoding_error`	`bool`	Ignore errors when the configured encoder fails to decode Pub/Sub messages. Ignoring the error causes the receiver to drop the message.	false	no
`insecure`	`bool`	Allows performing insecure SSL connections and transfers. This is useful when connecting to a local emulator instance. Only has effect if you set `endpoint`.	false	no
`project`	`string`	The Google Cloud Project project identifier.	`""`	no
`timeout`	`Duration`	Timeout for calls to the Pub/Sub API.	`"12s"`	no
`universe_domain`	`string`	Universe domain for the Pub/Sub service. Set to support Sovereign Cloud regions.	`"googleapis.com"`	no

Blocks

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

Block	Description	Required
`output`	Configures where to send received telemetry data.	yes
`debug_metrics`	Configures the metrics that this component generates to monitor its state.	no
`flow_control`	Tunes Pub/Sub acknowledgement batching and outstanding-message limits.	no

`output`

Required

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

The following arguments are supported:

Name	Type	Description	Default	Required
`logs`	`list(otelcol.Consumer)`	List of consumers to send logs to.	`[]`	no
`metrics`	`list(otelcol.Consumer)`	List of consumers to send metrics to.	`[]`	no
`traces`	`list(otelcol.Consumer)`	List of consumers to send traces to.	`[]`	no

You must specify the output block, but all its arguments are optional. By default, telemetry data is dropped. Configure the metrics, logs, and traces arguments accordingly to send telemetry data to other components.

`debug_metrics`

The debug_metrics block configures the metrics that this component generates to monitor its state.

The following arguments are supported:

Name	Type	Description	Default	Required
`disable_high_cardinality_metrics`	`boolean`	Whether to disable certain high cardinality metrics.	`true`	no

disable_high_cardinality_metrics is the Alloy equivalent to the telemetry.disableHighCardinalityMetrics feature gate in the OpenTelemetry Collector. It removes attributes that could cause high cardinality metrics. For example, attributes with IP addresses and port numbers in metrics about HTTP and gRPC connections are removed.

Note
If configured, disable_high_cardinality_metrics only applies to otelcol.exporter.* and otelcol.receiver.* components.

`flow_control`

The flow_control block tunes how the receiver acknowledges Pub/Sub messages and bounds outstanding work.

The following arguments are supported:

Name	Type	Description	Default	Required
`trigger_ack_batch_duration`	`duration`	Maximum time to wait before sending acknowledgements.	`"10s"`	no
`stream_ack_deadline`	`duration`	Acknowledgement deadline to use for the Pub/Sub stream.	`"60s"`	no
`max_outstanding_messages`	`int`	Maximum number of outstanding messages. `0` uses the client default.	`0`	no
`max_outstanding_bytes`	`int`	Maximum number of outstanding bytes. `0` uses the client default.	`0`	no

Exported fields

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

otelcol.receiver.googlecloudpubsub

Usage

Arguments

Blocks

output

debug_metrics

flow_control

Exported fields

Component health

`otelcol.receiver.googlecloudpubsub`

`output`

`debug_metrics`

`flow_control`