splunk-otel-collector

module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2020 License: Apache-2.0

README

Splunk distribution of OpenTelemetry Collector

The Splunk distribution of OpenTelemetry Collector provides a binary that can be deployed as a standalone service (also known as a gateway) that can receive, process and export trace and metric data.

The collector is an optional component deployed either:

  • Between the Smart Agent and SaaS ingestion
  • Between a serverless function and SaaS ingestion

🚧 This project is currently in BETA.

Getting Started

This distribution comes with default configurations which require the following environment variables:

  • SPLUNK_REALM (no default): Which realm to send the data to (for example: us0)
  • SPLUNK_ACCESS_TOKEN (no default): Access token to authenticate requests
  • SPLUNK_BALLAST_SIZE_MIB (no default): How much memory to allocate to the ballast. This should be set to 1/3 to 1/2 of configured memory.

In addition, the following environment variables are optional:

  • SPLUNK_CONFIG (default = /etc/otel/collector/splunk-config_linux.yaml): Which configuration to load.
  • SPLUNK_MEMORY_LIMIT_PERCENTAGE (default = 90): Maximum total memory to be allocated by the process heap.
  • SPLUNK_MEMORY_SPIKE_PERCENTAGE (default = 20): Maximum spike between the measurements of memory usage.

When running on a non-linux system, the following environment variables are required:

  • SPLUNK_CONFIG (default = /etc/otel/collector/splunk-config_non_linux.yaml): Configuration to load.
  • SPLUNK_MEMORY_LIMIT_MIB (no default): Maximum total memory to be allocated by the process heap.
  • SPLUNK_MEMORY_SPIKE_MIB (no default): Maximum spike between the measurements of memory usage.

Deploy the collector as outlined in the below. More information about deploying and configuring the collector can be found here

Docker

Deploy from a Docker container (replace 0.1.0 with the latest stable version number if necessary):

$ docker run --rm -e SPLUNK_ACCESS_TOKEN=12345 -e SPLUNK_BALLAST_SIZE_MIB=683 \
    -e SPLUNK_REALM=us0 -p 13133:13133 -p 14250:14250 -p 14268:14268 -p 55678-55680:55678-55680 \
    -p 6060:6060 -p 7276:7276 -p 8888:8888 -p 9411:9411 -p 9943:9943 \
    --name otelcol quay.io/signalfx/splunk-otel-collector:0.1.0
Kubernetes

To deploy in Kubernetes, create a configuration file that defines a ConfigMap, Service, and Deployment for the cluster. For more information about creating a configuration file, see the example signalfx-k8s.yaml file on GitHub.

Standalone
$ make otelcol
$ SPLUNK_REALM=us0 SPLUNK_ACCESS_TOKEN=12345 SPLUNK_BALLAST_SIZE_MIB=683 \
    ./bin/otelcol

Sizing

The OpenTelemetry Collector can be scaled up or out as needed. A single Collector is generally capable of over 10,000 spans per second per CPU core. The recommendation is to use a ratio of 1:2 for CPU:memory and to allocate at least a CPU core per Collector. Multiple Collectors can deployed behind a load balancer. Each Collector runs independently, so sizing increases linearly with the number of Collectors you deploy.

The Collector does not persist data to disk so no disk space is required.

Advanced Configuration

Command Line Arguments

Following the binary command or Docker container command line arguments can be specified. Command line arguments take priority over environment variables.

For example in Docker:

$ docker run --rm -e SPLUNK_ACCESS_TOKEN=12345 -e SPLUNK_BALLAST_SIZE_MIB=683 \
    -e SPLUNK_REALM=us0 -p 13133:13133 -p 14250:14250 -p 14268:14268 -p 55678-55680:55678-55680 \
    -p 6060:6060 -p 7276:7276 -p 8888:8888 -p 9411:9411 -p 9943:9943 \
    -v collector.yaml:/etc/collector.yaml:ro \
    --name otelcol quay.io/signalfx/splunk-otel-collector:0.1.0 \
        --log-level=DEBUG
Custom Configuration

In addition to using the default configuration, a custom configuration can also be provided.

For example in Docker:

$ docker run --rm -e SPLUNK_ACCESS_TOKEN=12345 -e SPLUNK_BALLAST_SIZE_MIB=683 \
    -e SPLUNK_REALM=us0 -e SPLUNK_CONFIG=/etc/collector.yaml -p 13133:13133 -p 14250:14250 \
    -p 14268:14268 -p 55678-55680:55678-55680 -p 6060:6060 -p 7276:7276 -p 8888:8888 \
    -p 9411:9411 -p 9943:9943 -v collector.yaml:/etc/collector.yaml:ro \
    --name otelcol quay.io/signalfx/splunk-otel-collector:0.1.0

Note that if the configuration includes a memorylimiter processor then it must set the value of ballast_size_mib setting of the processor to the env variable SPLUNK_BALLAST_SIZE_MIB. See for example splunk_config.yaml on how to do it.

Troubleshooting

See the Collector troubleshooting documentation.

Directories

Path Synopsis
baseline module
cmd
otelcol command
Program otelcol is the OpenTelemetry Collector that collects stats and traces and exports to a configured backend.
Program otelcol is the OpenTelemetry Collector that collects stats and traces and exports to a configured backend.
examples
internal
tools module
pkg
splunkconf module
splunkta module
tests module
parity module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL