opentelemetry-collector

Chainguard Container for opentelemetry-collector

Minimal image with opentelemetry-collector

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/opentelemetry-collector:latest

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

Using this image

Chainguard cgr.dev/chainguard/opentelemetry-collector is a drop in replacement for the upstream image, tested using the community helm chart.

helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
helm install my-opentelemetry-collector open-telemetry/opentelemetry-collector \
   --set mode=<daemonset|deployment|statefulset> \
   --set image.repository=cgr.dev/chainguard/opentelemetry-collector \
   --set image.tag=latest

To use custom configuration it is easier to use a values.yaml file:

mode: daemonset
configMap:
  create: false
image:
  tag: latest
  repository: cgr.dev/chainguard/opentelemetry-collector
command:
  extraArgs:
    - "--config=/conf/custom-config.yaml"
extraVolumeMounts:
  - name: "custom-vm"
    mountPath: "/conf"
extraVolumes:
  - name: "custom-vm"
    configMap:
      name: "custom"

helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts
helm install open-telemetry opentelemetry/opentelemetry-collector --namespace open-telemetry-custom-config -f values.yaml

OpenTelemetry Collector Builder

Chainguard also provides the opentelemetry-collector-builder image, which contains the ocb (OpenTelemetry Collector Builder) tool. This tool allows you to build custom OpenTelemetry Collector distributions with only the components you need.

Pulling the Builder Image

docker pull cgr.dev/ORGANIZATION/opentelemetry-collector-builder:latest

Usage

The builder requires a configuration file that specifies which components to include in your custom collector. Create a builder-config.yaml file:

dist:
  name: my-custom-collector
  description: My Custom OpenTelemetry Collector
  output_path: /tmp/dist
  version: 1.0.0

receivers:
  - gomod: go.opentelemetry.io/collector/receiver/otlpreceiver v0.144.0

exporters:
  - gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.144.0
  - gomod: go.opentelemetry.io/collector/exporter/otlpexporter v0.144.0

processors:
  - gomod: go.opentelemetry.io/collector/processor/batchprocessor v0.144.0

extensions:
  - gomod: go.opentelemetry.io/collector/extension/zpagesextension v0.144.0

Then run the builder with Go mounted from your host:

docker run --rm \
  -v $(pwd)/builder-config.yaml:/home/ocb/builder-config.yaml:ro \
  -v $(pwd)/dist:/tmp/dist \
  -v $(go env GOROOT):$(go env GOROOT):ro \
  -v $(pwd)/go-cache:/home/ocb/go \
  -e "PATH=$(go env GOROOT)/bin:/usr/local/bin:/usr/bin:/bin" \
  -e "GOROOT=$(go env GOROOT)" \
  -e "GOPATH=/home/ocb/go" \
  -e "GOCACHE=/home/ocb/go/cache" \
  cgr.dev/ORGANIZATION/opentelemetry-collector-builder:latest \
  --config=/home/ocb/builder-config.yaml

Configuration Options

The builder configuration supports the following sections:

Distribution settings (dist):

• name: Binary name for the output executable
• description: Description of the distribution
• output_path: Directory where the binary will be written
• version: Version string for the custom collector
• module: Go module name (optional)
• go: Path to Go binary (optional)
• debug_compilation: Set to true to retain debug symbols

Component types:

• receivers: List of receiver components
• exporters: List of exporter components
• processors: List of processor components
• extensions: List of extension components

Each component requires a gomod field specifying the Go module and version.

Builder Workflow

The builder performs three steps:

1. Generate: Creates Go source code for the custom collector
2. Get modules: Generates go.mod based on specified imports
3. Compilation: Builds the executable binary

You can skip individual steps using flags like --skip-compilation or --skip-generate if you only need partial output.

Checking the Version

docker run --rm cgr.dev/ORGANIZATION/opentelemetry-collector-builder:latest version

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system 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 development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

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.