docker-compose: add the opentelemetry output example

Author: olegbespalov

examples/docker-compose/opentelemetry/README.md

@@ -0,0 +1,29 @@
+# OpenTelemetry Output
+
+This example demonstrates how to integrate k6 performance testing with OpenTelemetry. The test metrics are sent to an OpenTelemetry collector (OTEL Collector), which forwards them to Prometheus for storage. These metrics can then be visualized using Grafana dashboards.
+
+## Prerequisites
+
+- Docker
+- Docker Compose
+
+## Run the example
+
+```bash
+docker-compose up -d
+```
+
+## Access the k6 performance test dashboard
+
+Open the k6 performance test dashboard in your browser http://localhost:3000/d/demo-uid/k6-opentelemetry-prometheus
+
+## Run the k6 test
+
+This will run the test for 3 minutes with 10 virtual users and send the metrics to the OTEL Collector.
+
+```bash
+K6_OTEL_GRPC_EXPORTER_ENDPOINT=localhost:4317 \
+K6_OTEL_GRPC_EXPORTER_INSECURE=true \
+K6_OTEL_METRIC_PREFIX=k6_ \
+k6 run --tag testid=1 -o experimental-opentelemetry script.js
+```

examples/docker-compose/opentelemetry/docker-compose.yml

@@ -0,0 +1,50 @@
+version: '3.8'
+
+networks:
+  k6:
+
+services:
+  prometheus:
+    image: prom/prometheus:v3.2.0
+    command:
+      - --web.enable-remote-write-receiver
+      - --enable-feature=native-histograms
+      - --config.file=/etc/prometheus/prometheus.yml
+    networks:
+      - k6
+    ports:
+      - "9090:9090"
+
+  alloy:
+    image: grafana/alloy:v1.6.1
+    networks:
+      - k6
+    volumes:
+      - ./grafana/alloy:/etc/alloy
+    environment:
+      REMOTE_WRITE_HOST: prometheus:9090
+    depends_on:
+      - prometheus
+    command:
+      - run
+      - /etc/alloy/config.alloy
+      - --storage.path=/var/lib/alloy/data
+      - --server.http.listen-addr=0.0.0.0:12345
+      - --stability.level=experimental # Enable all functionality
+    ports:
+      - "12345:12345" # Alloy UI
+      - "4317:4317" # gRPC receiver
+      - "4318:4318" # HTTP receiver
+
+  grafana:
+    image: grafana/grafana:11.5.2
+    networks:
+      - k6
+    ports:
+      - "3000:3000"
+    environment:
+      - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
+      - GF_AUTH_ANONYMOUS_ENABLED=true
+      - GF_AUTH_BASIC_ENABLED=false
+    volumes:
+      - ./grafana:/etc/grafana/provisioning/

examples/docker-compose/opentelemetry/grafana/alloy/config.alloy

@@ -0,0 +1,44 @@
+// expose OTEL receivers
+// https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.otlp/
+otelcol.receiver.otlp "default" {
+	// configures the default gRPC receiver endpoint "0.0.0.0:4317"
+	// https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.otlp/#grpc-block
+	grpc {}
+	
+	// configures the default HTTP receiver endpoint "0.0.0.0:4318"
+	// https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.otlp/#http-block
+	http {}
+
+	output {
+		metrics = [otelcol.processor.batch.default.input]
+	}
+}
+
+otelcol.processor.batch "default" {
+	// https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.batch/
+	output {
+		metrics = [otelcol.exporter.prometheus.default.input]		
+	}
+}
+
+otelcol.exporter.prometheus "default" {
+	add_metric_suffixes = false
+	forward_to          = [prometheus.remote_write.default.receiver]
+}
+
+// Collect metrics from the local running Alloy instance and forward to
+// Prometheus.
+prometheus.exporter.self "alloy" {}
+prometheus.scrape "alloy" {
+	targets    = prometheus.exporter.self.alloy.targets
+	forward_to = [prometheus.remote_write.default.receiver]
+}
+
+prometheus.remote_write "default" {
+	endpoint {
+		url = format(
+			"http://%s/api/v1/write",
+			coalesce(env("REMOTE_WRITE_HOST"), "localhost:9090"),
+		)
+	}
+}

examples/docker-compose/opentelemetry/grafana/dashboards/dashboards.yaml

@@ -0,0 +1,14 @@
+# For configuration options, see
+#   https://grafana.com/docs/grafana/latest/administration/provisioning/#dashboards
+
+apiVersion: 1
+
+providers:
+  # We're defining a directory from which to load file-based dashboards
+  - name: 'prometheus'
+    type: file
+    disableDeletion: false
+    updateIntervalSeconds: 10
+    editable: true
+    options:
+      path: /etc/grafana/provisioning/dashboards