Chainguard Container for splunk-otel-collector

Splunk OpenTelemetry Collector is a distribution of the OpenTelemetry Collector. It provides a unified way to receive, process, and export metric, trace, and log data for Splunk Observability Cloud

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/splunk-otel-collector:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

splunk-otel-collector is comparable to the splunk-otel-collector (quay.io/signalfx/splunk-otel-collector:latest) image, with the following differences:

• Like all other Chainguard Images, splunk-otel-collector features a stripped down, minimal design
• This base image comes with apk and BusyBox and reports as being a Chainguard image.
• It has few-to-zero CVEs
• It does not run as the root user
• This image as currently built does not support the agent bundle plugins

Getting Started

Splunk OpenTelemetry Collector is a distribution of the OpenTelemetry Collector. It provides a unified way to receive, process, and export metric, trace, and log data for Splunk Observability Cloud. Here is an example setup of the collector to ingest metrics from a Redis server.

Requirements

1. Configuration for the OpenTelemetry Collector deployed with a configMap
2. Configuration for the Redis server deployed with a configMap

The following is an example otel-collector.yaml configuration file:

apiVersion: v1
kind: ConfigMap
metadata:
  name: otel-config
  namespace: splunk
data:
  otel-collector-config.yaml: |
    receivers:
      redis:
        endpoint: "localhost:6379"
        collection_interval: 10s
        password: $REDIS_PASSWORD
        metrics:
          redis.role:
            enabled: true
          redis.cmd.calls:
            enabled: true
    extensions:
      health_check:
        endpoint: 0.0.0.0:13133
      zpages:
        endpoint: 0.0.0.0:55679
    processors:
      batch:
    exporters:
      signalfx:
        access_token: "token"
        realm: "us0"
      debug:
        verbosity: detailed
    service:
      telemetry:
        metrics:
          address: ":8888"
      pipelines:
        metrics/sfx:
          receivers: [redis]
          processors: [batch]
          exporters: [signalfx]
        metrics/logging:
          receivers: [redis]
          processors: [batch]
          exporters: [debug]

More information can be found in the Otel collector examples folder.

To test out this image, deploy an otel-collector pod in a Kubernetes cluster:

apiVersion: v1
kind: Pod
metadata:
  name: redis-otel-pod
  namespace: splunk
spec:
  serviceAccount: default
  containers:
    - name: redis-db
      image: redis:latest
      command: ["redis-server", "/etc/redis/redis.conf"]
      ports:
        - containerPort: 6379
        - containerPort: 6329
      volumeMounts:
        - name: redis-config
          mountPath: /etc/redis/redis.conf
          subPath: redis.conf

    - name: otelcollector
      image: ${local.parsed.registry}/${local.parsed.repo}:${local.parsed.pseudo_tag}
      args:
        - "--config=/etc/otel-collector-config.yaml"
        - "--set=service.telemetry.logs.level=debug"
      env:
        - name: SPLUNK_ACCESS_TOKEN
          value: "token"
        - name: SPLUNK_REALM
          value: "us0"
        - name: REDIS_PASSWORD
          value: "changeme"
      ports:
        - containerPort: 8088
          name: otel-http
        - containerPort: 8888
          name: otel-grpc
      volumeMounts:
        - name: otel-config
          mountPath: /etc/otel-collector-config.yaml
          subPath: otel-collector-config.yaml

  volumes:
    - name: otel-config
      configMap:
        name: otel-config
    - name: redis-config
      configMap:
        name: otel-config

Ensure that the container is up and running and ensure that the metric counts have been ingested by the collector

kubectl -n splunk logs redis-otel-pod -c otelcollector 2>&1 | \
  grep "Metrics" | head -n 1 | jq -R 'split(",") | \
  map(select(contains("\"metrics\":"))) | map(split(": ")[1] | tonumber) | .[0] > 10'

The test above is to validate that metrics, in the case from a redis container are been collected by the otel collector service.

Documentation and Resources

1. https://github.com/signalfx/splunk-otel-collector - Main project repository
2. https://github.com/signalfx/splunk-otel-collector/tree/main/examples - Deployment scenarios
3. https://github.com/signalfx/splunk-otel-collector-chart - Helm chart
4. https://docs.splunk.com/observability/en/gdi/opentelemetry/opentelemetry.html

What are Chainguard Containers?

Chainguard Containers are minimal container images that are secure by default.

In many cases, the Chainguard Containers tagged as :latest contain only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager. Chainguard Containers are built with Wolfi, our Linux undistro designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a -dev variant.

Although the -dev container image variants have similar security features as their more minimal versions, they feature additional software that is typically not necessary in production environments. We recommend using multi-stage builds to leverage the -dev variants, copying application artifacts into a final minimal container that offers a reduced attack surface that won’t allow package installations or logins.

Learn More

To better understand how to work with Chainguard Containers, please visit Chainguard Academy and Chainguard Courses.

In addition to Containers, Chainguard offers VMs and Libraries. Contact Chainguard to access additional products.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.