SolarWinds OpenTelemetry Collector

SolarWinds OpenTelemetry Collector is a distribution of OpenTelemetry Collector with components bundled from opentelemetry-collector and opentelemetry-collector-contrib. It also contains specific SolarWinds components for easier usage and enhanced telemetry collection.

Installation

Docker

Get the image from DockerHub.

docker pull solarwinds/solarwinds-otel-collector:latest

To run the image utilize following command:

docker run -v ./your_config_file.yaml:/opt/default-config.yaml solarwinds-otel-collector:latest

See complete docker documentation.

Binary

Build the binary in cmd/solarwinds-otel-collector with go build .

After successful build, solarwinds-otel-collector should be present in cmd/solarwinds-otel-collector.

Run solarwinds-otel-collector --config=config.yaml.

Getting Started

Configuration for SolarWinds OTel Collector has to contain SolarWinds Extension and Solarwinds Exporter.

Example with docker

1. Generate your ingestion token in SWO. See API Tokens.
2. Create a config.yaml file that contains configuration for the SolarWinds OTel Collector. Insert the ingestion token and choose a correct data center (na-01, na-02, eu-01). Specify the collector name.

service:
  extensions: [solarwinds]
  pipelines:
    metrics:
      receivers: [redis]
      exporters: [solarwinds]
receivers:
  redis:
    endpoint: "<redis-url>:6379"
    collection_interval: 10s
    password: ${env:REDIS_PASSWORD}
extensions:
  solarwinds:
    token: "<ingestion-token>"
    data_center: "na-01"
    collector_name: "<collector-name>"

exporters:
  solarwinds:

3. Pull the SolarWinds OTel Collector from DockerHub.

docker pull solarwinds/solarwinds-otel-collector:latest

4. Start the container with your config.yaml.

docker run  -v ./config.yaml:/opt/default-config.yaml solarwinds/solarwinds-otel-collector:latest

Components

The SolarWinds OpenTelemetry collector contains following components:

• receivers
  • full set of opentelemetry-collector receivers
  • full set of opentelemetry-collector-contrib receivers
• processors
  • full set of opentelemetry-collector processors
  • full set of opentelemetry-collector-contrib processors
• exporters
  • solarwindsexporter
  • otlpexporter
  • fileexporter
  • debugexporter
  • nopexporter
• extensions
  • solarwindsextension
  • full set of opentelemetry-collector extensions
  • full set of opentelemetry-collector-contrib extensions
• connectors
  • full set of opentelemetry-collector connectors
  • full set of opentelemetry-collector-contrib connectors

Contributing

See CONTRIBUTING.md.