Install and deploy the Collector 🔗

See the available options to install the Splunk Distribution of the OpenTelemetry Collector.

Guided install for the Collector¶

Splunk Observability Cloud offers a guided setup to install the Collector:

Log in to Splunk Observability Cloud.
In the navigation menu, select Data Management to open the Integrate Your Data page.
Select Add Integration to open the Integrate Your Data page.
Select one of the platforms in the Splunk OpenTelemetry Collector section.
Follow the step-by-step process provided in the platform’s guided setup.

Install using packages and deployment tools¶

The Splunk Distribution of OpenTelemetry Collector is supported on Kubernetes, Linux, Windows, and Mac. See Processor architecture for compatible CPU architectures and operating systems.

Deploy one of the following packages to gather data for Infrastructure Monitoring, APM, and Log Observer:

Splunk Distribution of OpenTelemetry Collector for Kubernetes or splunk-otel-collector-chart. See Install on Kubernetes. You can also install the Kubernetes Operator for Auto Instrumentation, as explained in Install the Collector with the Kubernetes Operator for Auto Instrumentation.
Splunk Distribution of OpenTelemetry Collector for Linux or splunk-otel-collector. See Install on Linux (script) or Install on Linux (manual), including instructions to install using the binary file.
Splunk Distribution of OpenTelemetry Collector for Windows or splunk-otel-collector. See Install on Windows (script) or Install on Windows (manual), including instructions for the binary file.

Components of the Collector¶

The Collector uses the components listed in the following table:

Component	Description
Receivers	Get data into the Collector using receivers. Receivers, which can be push or pull based, support one or more data sources. You must configure one or more receivers. By default, no receivers are configured.
Processors	Control the data you send using processors. Processors sit between receivers and exporters, reading and sometimes operating on data as it flows through the pipeline. Processors are optional, but you should include processors in your configuration. The order in which processors are listed in the `processors` section of the configuration is relevant.
Exporters	Send data to one or more destinations using exporters. Exporters, which can be push or pull based, support one or more data sources.

To learn more about Collector components, see Components.

When configured, activate these components using pipelines within the service section of the configuration.

Collector services¶

The service section of the Collector contains two subsections: extensions and pipelines. The extensions section is where you optionally activate any extensions you have configured, and the pipelines section is where you define one or more pipelines, each of which consists of receivers, processors (optional), and exporters. The service section’s two subsections are described in the following table.

Component	Description
Extension	Provide capabilities that can be added to the Collector, but which do not require direct access to telemetry data and are not part of pipelines.
Pipeline	Pipelines can be traces, metrics, or logs. They consist of a set of receivers, processors, and exporters, and define the path of the ingested data element. Each receiver, processor, and exporter must be defined in the configuration outside of the service section to be included in a pipeline.

Here’s an example configuration:

receivers:
  otlp:
    protocols:
      grpc:
      http:

processors:
  batch:

exporters:
  otlp:
    endpoint: otelcol:4317

extensions:
  health_check:
  pprof:
  zpages:

service:
  extensions: [health_check,pprof,zpages]
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp]
    metrics:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp]
    logs:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlp]

Related Topics