Documentationbreadcrumb arrow breadcrumb arrow Grafana Alloybreadcrumb arrow Referencebreadcrumb arrow Command-line interfacebreadcrumb arrow otel
Experimental Open source

otel

EXPERIMENTAL: This is an experimental feature. Experimental features are subject to frequent breaking changes, and may be removed with no equivalent replacement.

The otel command runs Alloy with the OTel Engine. This command accepts OpenTelemetry Collector YAML configuration files.

The OTel Engine includes receivers, processors, exporters, extensions, and connectors from the OpenTelemetry Collector core and contrib repositories. This includes components for OTLP, Prometheus, Kafka, Zipkin, and other popular integrations.

As with the run command, this runs in the foreground until an interrupt is received.

Usage

shell 
alloy otel --config=<CONFIG_FILE> [<FLAGS> ...]

Replace the following:

  • <CONFIG_FILE>: Path to an OpenTelemetry Collector configuration file.
  • <FLAGS>: One or more flags that configure the OpenTelemetry Collector. These flags are the same as upstream. Run alloy otel --help to show the complete list of supported flags.

Configuration

The otel command accepts standard OpenTelemetry Collector YAML configuration files. The configuration file defines receivers, processors, exporters, and other components that make up your telemetry pipeline.

Run the Default Engine in parallel

The OTel Engine includes the option to run pipelines with the Default Engine alongside the OTel Engine using the built-in Alloy Engine extension.

This runs a Default Engine pipeline in parallel to the OTel Engine pipeline. The two pipelines can’t natively interact.

Examples

Refer to Get started for examples that show you how to run the OTel Engine and Alloy Engine extension.