feat: Configure Grafana Alloy to receive OpenTelemetry data (#14)

Author: MurzNN

.github/workflows/tests.yml

@@ -2,10 +2,10 @@ name: tests
 on:
   pull_request:
   push:
-    branches: [main]
+    branches: [ main ]
 
   schedule:
-    - cron: '25 08 * * *'
+  - cron: '25 08 * * *'
 
   workflow_dispatch:
     inputs:
@@ -15,78 +15,30 @@ on:
         required: false
         default: false
 
-# This is required for "gautamkrishnar/keepalive-workflow"
-permissions:
-  contents: write
-
-defaults:
-  run:
-    shell: bash
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
-env:
-  NIGHTLY_DDEV_PR_URL: 'https://nightly.link/ddev/ddev/actions/runs/1720215802/ddev-linux-amd64.zip'
-  # Allow ddev get to use a github token to prevent rate limiting by tests
-  DDEV_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  # Allow `--HEAD` flag when running tests against HEAD
-  HOMEBREW_NO_INSTALL_FROM_API: 1
+# This is required for "gautamkrishnar/keepalive-workflow", see "ddev/github-action-add-on-test"
+permissions:
+  actions: write
 
 jobs:
   tests:
-    defaults:
-      run:
-        shell: bash
-
     strategy:
       matrix:
         ddev_version: [stable, HEAD]
-      #        ddev_version: [stable, edge, HEAD, PR]
       fail-fast: false
+      # Disable parallel execution because of the issues with mounted volumes.
+      max-parallel: 1
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Homebrew
-        id: set-up-homebrew
-        uses: Homebrew/actions/setup-homebrew@master
-      - name: Environment setup
-        run: |
-          brew install bats-core mkcert
-          mkcert -install
-
-      - name: Use ddev stable
-        if: matrix.ddev_version == 'stable'
-        run: brew install ddev/ddev/ddev
-
-      - name: Use ddev edge
-        if: matrix.ddev_version == 'edge'
-        run: brew install ddev/ddev-edge/ddev
-
-      - name: Use ddev HEAD
-        if: matrix.ddev_version == 'HEAD'
-        run: brew install --HEAD ddev/ddev/ddev
-
-      - name: Use ddev PR
-        if: matrix.ddev_version == 'PR'
-        run: |
-          curl -sSL -o ddev_linux.zip ${NIGHTLY_DDEV_PR_URL}
-          unzip ddev_linux.zip
-          mv ddev /usr/local/bin/ddev && chmod +x /usr/local/bin/ddev
-
-      - name: Download docker images
-        run: mkdir junk && pushd junk && ddev config --auto && ddev debug download-images >/dev/null
-
-      - name: tmate debugging session
-        uses: mxschmitt/action-tmate@v3
+      - uses: ddev/github-action-add-on-test@v2
         with:
-          limit-access-to-actor: true
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-        if: github.event.inputs.debug_enabled == 'true'
-
-      - name: tests
-        run: bats tests
-
-      # keepalive-workflow adds a dummy commit if there's no other action here, keeps
-      # GitHub from turning off tests after 60 days
-      - uses: gautamkrishnar/keepalive-workflow@v1
-        if: matrix.ddev_version == 'stable'
+          ddev_version: ${{ matrix.ddev_version }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+          debug_enabled: ${{ github.event.inputs.debug_enabled }}
+          addon_repository: ${{ env.GITHUB_REPOSITORY }}
+          addon_ref: ${{ env.GITHUB_REF }}

README.md

@@ -28,27 +28,10 @@ It contains several components from Grafana stack:
 - **[Tempo](https://grafana.com/traces/)**: an open source, easy-to-use, and
   high-scale distributed tracing backend.
 
-Be aware that this addon uses a lot of port mapping, so port numbers may overlap
-with another running ddev project or local apps, that can lead to startup
-errors, and even hidden errors with "503: No ddev back-end site available" if
-the same port is configured with HTTP on one project and HTTPS on another, here
-is the issue about this: https://github.com/ddev/ddev/issues/4794
-
-To resolve such issues try to find the conflicting port and comment it or change
-the port number to a free one.
-
 ## Installation
 
 1. In the DDEV project directory:
 
-  For DDEV v1.23.5 or above run
-
-  ```sh
-  ddev add-on get MurzNN/ddev-grafana
-  ```
-
-  For earlier versions of DDEV run
-
   ```sh
   ddev get MurzNN/ddev-grafana
   ```
@@ -62,28 +45,12 @@ the port number to a free one.
 3. Open the Grafana web interface via the url:
    https://your-project-name.ddev.site:3000/
 
-## Customizations
-
-If you need to run several projects with Tempo OpenTelemetry collectors, with
-default settings it will fail, because several projects can't use the same port
-number on the host network. To fix this you should disable mapping ports to the
-host network on the second project via renaming the file
-`docker-compose.grafana.host-ports.yaml` to
-`docker-compose.grafana.host-ports.yaml.disabled`, or change port numbers to
-unique ones, and restart the projects.
-
-
-If you want to disable binding Grafana services to the localhost, rename the
-files:
-- `docker-compose.grafana.localhost.yaml` to
-  `docker-compose.grafana.namedhosts.yaml.disabled`
-- `docker-compose.grafana.namedhosts.yaml.disabled` to
-  `docker-compose.grafana.namedhosts.yaml`
-
-
-If you need to expose non-HTTP ports (gRPC, etc), you can uncomment them in the
-`docker-compose.grafana.localhost.yaml` file.
+4. Configure the OpenTelemetry endpoint in your application
+   to the `http://opentelemetry-grafana:4318`.
 
+   By default, the add-on configures the `OTEL_EXPORTER_OTLP_ENDPOINT`
+   environment variable with this endpoint, you can disable this in the file
+   `.ddev/config.grafana.logs.yaml`.
 
 ** Contributed and maintained by [@MurzNN](https://github.com/MurzNN).
 

config.grafana.logs.yaml

@@ -2,6 +2,9 @@ webimage_extra_packages:
   - syslog-ng
 
 web_extra_daemons:
-  - name: "syslog-ng"
-    command: "/usr/bin/sudo /usr/sbin/syslog-ng -F --no-caps"
+  - name: 'syslog-ng'
+    command: '/usr/bin/sudo /usr/sbin/syslog-ng -F --no-caps'
     directory: /var/www/html
+
+web_environment:
+  - OTEL_EXPORTER_OTLP_ENDPOINT=http://opentelemetry-grafana:4318

docker-compose.grafana.alloy.yaml

@@ -0,0 +1,37 @@
+services:
+  grafana-alloy:
+    container_name: 'ddev-${DDEV_SITENAME}-grafana-alloy'
+    image: grafana/alloy:latest
+    user: '${UID:-}:${GID:-}'
+    entrypoint:
+      - /bin/alloy
+      - run
+      - --server.http.listen-addr=0.0.0.0:12345
+      - --storage.path=/var/lib/alloy/data
+      - --stability.level=experimental
+      - /etc/alloy/config.alloy
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: ${DDEV_APPROOT}
+    volumes:
+      - type: bind
+        source: ./grafana/alloy/config.alloy
+        target: /etc/alloy/config.alloy
+      # - grafana-alloy-data:/var/lib/alloy/data
+      # Configuration to write logs to the file is in a separate file:
+      # config.grafana.logs.yaml
+      - web-logs-data:/var/log
+    networks:
+      default:
+        aliases:
+          - opentelemetry-grafana
+
+    environment:
+      - VIRTUAL_HOST=$DDEV_HOSTNAME
+      - HTTP_EXPOSE=12345:12345,4317:4317,4318:4318,9411:9411,14268:14268
+      - HTTPS_EXPOSE=12345:12345,4317:4317,4318:4318,9411:9411,14268:14268
+volumes:
+  # grafana-alloy-data:
+  #   name: 'ddev-${DDEV_SITENAME}_grafana-alloy-data'
+  web-logs-data:
+    name: 'ddev-${DDEV_SITENAME}_web-logs'

docker-compose.grafana.logs.yaml renamed to docker-compose.grafana.loki.yaml

@@ -6,15 +6,15 @@ services:
       # because supervisord requires write permission for the current user.
       - web-logs-data:/var/log
 
-  loki:
+  grafana-loki:
     image: grafana/loki:latest
-    user: "${UID:-}:${GID:-}"
-    container_name: "ddev-${DDEV_SITENAME}-loki"
+    user: '${UID:-}:${GID:-}'
+    container_name: 'ddev-${DDEV_SITENAME}-grafana-loki'
     volumes:
       - type: bind
         source: ./grafana/loki/loki.yaml
         target: /etc/loki/local-config.yaml
-      - loki-data:/loki
+      - grafana-loki-data:/data
     labels:
       com.ddev.site-name: ${DDEV_SITENAME}
       com.ddev.approot: ${DDEV_APPROOT}
@@ -23,20 +23,6 @@ services:
       - HTTP_EXPOSE=3100:3100
       - HTTPS_EXPOSE=3100:3100
 
-  agent:
-    container_name: "ddev-${DDEV_SITENAME}-agent"
-    image: grafana/agent:latest
-    user: "${UID:-}:${GID:-}"
-    volumes:
-      - type: bind
-        source: ./grafana/agent/agent.yaml
-        target: /etc/agent/agent.yaml
-      - web-logs-data:/var/log
-    # Additional configuration is in the separate file:
-    # config.grafana.logs.yaml
-
 volumes:
-  web-logs-data:
-    name: "ddev-${DDEV_SITENAME}_web-logs"
-  loki-data:
-    name: "ddev-${DDEV_SITENAME}_loki"
+  grafana-loki-data:
+    name: 'ddev-${DDEV_SITENAME}_grafana-loki-data'

docker-compose.grafana.metrics.yaml

@@ -0,0 +1,24 @@
+services:
+  grafana-mimir:
+    container_name: 'ddev-${DDEV_SITENAME}-grafana-mimir'
+    image: grafana/mimir:latest
+    user: '${UID:-}:${GID:-}'
+    entrypoint:
+      - /bin/mimir
+      - -config.file=/etc/mimir-config/mimir.yaml
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: ${DDEV_APPROOT}
+    volumes:
+      - type: bind
+        source: ./grafana/mimir/mimir.yaml
+        target: /etc/mimir-config/mimir.yaml
+      - grafana-mimir-data:/data
+
+    environment:
+      - VIRTUAL_HOST=$DDEV_HOSTNAME
+      - HTTP_EXPOSE=9009:9009
+      - HTTPS_EXPOSE=9009:9009
+volumes:
+  grafana-mimir-data:
+    name: 'ddev-${DDEV_SITENAME}_grafana-mimir-data'

docker-compose.grafana.mimir.yaml

@@ -1,23 +1,21 @@
 services:
-  tempo:
-    container_name: "ddev-${DDEV_SITENAME}-tempo"
+  grafana-tempo:
+    container_name: 'ddev-${DDEV_SITENAME}-grafana-tempo'
     image: grafana/tempo:latest
-    user: "${UID:-}:${GID:-}"
+    user: '${UID:-}:${GID:-}'
     command:
-      - "-config.file=/etc/tempo.yaml"
+      - '-config.file=/etc/tempo.yaml'
     volumes:
       - type: bind
         source: ./grafana/tempo/tempo.yaml
         target: /etc/tempo.yaml
-      - tempo-data:/data
+      - grafana-tempo-data:/data
     labels:
       com.ddev.site-name: ${DDEV_SITENAME}
       com.ddev.approot: ${DDEV_APPROOT}
     environment:
       - VIRTUAL_HOST=$DDEV_HOSTNAME
-      - HTTP_EXPOSE=4318:4318,9411:9411,14268:14268
-      - HTTPS_EXPOSE=4318:4318,9411:9411,14268:14268
 
 volumes:
-  tempo-data:
-    name: "ddev-${DDEV_SITENAME}_tempo"
+  grafana-tempo-data:
+    name: 'ddev-${DDEV_SITENAME}_grafana-tempo-data'