docker_deployment.md

Docker

Prerequisites

• Docker
• Docker Compose v2.0.0+
• 4 GB of RAM

Clone Repo

• Clone the Webstore Demo repository:

git clone https://github.com/open-telemetry/opentelemetry-demo.git

Open Folder

• Navigate to the cloned folder:

cd opentelemetry-demo/

Run Docker Compose

• Start the demo:

docker compose up --no-build

Note: The --no-build flag is used to fetch released docker images from ghcr instead of building from source. Removing the --no-build command line option will rebuild all images from source. It may take more than 20 minutes to build if the flag is omitted.

Verify the Webstore & the Telemetry

Once the images are built and containers are started you can access:

• Webstore: http://localhost/
• Jaeger: http://localhost:16686/
• Prometheus: http://localhost:9090/
• Grafana: http://localhost:3000/
• Feature Flags UI: http://localhost/feature/
• Load Generator UI: http://localhost:8089/

Bring your own backend

Likely you want to use the Webstore as a demo application for an observability backend you already have (e.g. an existing instance of Jaeger, Zipkin, or one of the vendor of your choice.

OpenTelemetry Collector can be used to export telemetry data to multiple backends. By default, the collector in the demo application will merge the configuration from two files:

• otelcol-config.yml
• otelcol-config-extras.yml

To add your backend, open the file src/otelcollector/otelcol-config-extras.yml with an editor.

• Start by adding a new exporter. For example, if your backend supports OTLP over HTTP, add the following:

exporters:
  otlphttp/example:
    endpoint: <your-endpoint-url>

• Then add a new pipeline with your new exporter:

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [otlphttp/example]

Vendor backends might require you to add additional parameters for authentication, please check their documentation. Some backends require different exporters, you may find them and their documentation available at opentelemetry-collector-contrib/exporter.

After updating the otelcol-config-extras.yml, start the demo by running docker compose up. After a while, you should see the traces flowing into your backend as well.