Add OpenTelemetry Bundle, Docker & Nix files

Author: gaelreyrol

.composer/friendsofopentelemetry/opentelemetry-bundle

@@ -0,0 +1 @@
+../../../opentelemetry-bundle

.editorconfig

@@ -17,3 +17,6 @@ max_line_length = 80
 
 [COMMIT_EDITMSG]
 max_line_length = 0
+
+[*.{yaml,yml,nix}]
+indent_size = 2

.env

@@ -29,5 +29,12 @@ DATABASE_URL=sqlite:///%kernel.project_dir%/data/database.sqlite
 ###< doctrine/doctrine-bundle ###
 
 ###> symfony/mailer ###
-# MAILER_DSN=null://null
+MAILER_DSN=smtp://localhost:1025
 ###< symfony/mailer ###
+
+###> symfony/messenger ###
+# Choose one of the transports below
+# MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages
+# MESSENGER_TRANSPORT_DSN=redis://localhost:6379/messages
+MESSENGER_TRANSPORT_DSN=doctrine://default?auto_setup=0
+###< symfony/messenger ###

.env.dev

@@ -1 +1,5 @@
 # Define your env variables for the development environment here
+
+###> symfony/framework-bundle ###
+APP_SECRET=8cb80353a0bf56b5bf86f64f5e3001f6
+###< symfony/framework-bundle ###

.envrc

@@ -0,0 +1,9 @@
+#! /usr/bin/env bash
+
+cachix use nix-shell
+cachix use php-src-nix
+cachix use opentelemetry
+
+use flake
+
+export SASS_PATH=$(which sass)

.github/workflows/lint.yaml

@@ -4,7 +4,7 @@ on:
     pull_request:
     push:
         branches:
-            - main
+            - opentelemetry-bundle
 
 env:
     fail-fast: true
@@ -40,7 +40,7 @@ jobs:
               uses: shivammathur/setup-php@v2
               with:
                   coverage: "none"
-                  extensions: intl
+                  extensions: "intl, mbstring, pdo_sqlite, zip, opentelemetry"
                   php-version: ${{ matrix.php-version }}
                   tools: composer:v2
 
@@ -92,6 +92,7 @@ jobs:
               uses: shivammathur/setup-php@v2
               with:
                   coverage: none
+                  extensions: "intl, mbstring, pdo_sqlite, zip, opentelemetry"
                   php-version: '8.3'
 
             - name: Install dependencies

.github/workflows/tests.yaml

@@ -4,7 +4,7 @@ on:
     pull_request:
     push:
         branches:
-            - main
+            - opentelemetry-bundle
 
 env:
     fail-fast: true
@@ -39,7 +39,7 @@ jobs:
               uses: shivammathur/setup-php@v2
               with:
                   coverage: "none"
-                  extensions: "intl, mbstring, pdo_sqlite, zip"
+                  extensions: "intl, mbstring, pdo_sqlite, zip, opentelemetry"
                   php-version: ${{ matrix.php-version }}
                   tools: composer:v2
 

.gitignore

@@ -3,6 +3,12 @@
 
 .php-version
 
+.direnv
+result
+.idea
+.data
+data/
+
 ###> symfony/framework-bundle ###
 /.env.local
 /.env.local.php

OpenTelemetry.md

@@ -0,0 +1,46 @@
+# OpenTelemetry
+
+This repository is based on Symfony's [demo](https://github.com/symfony/demo) application and integrates [opentelemetry-bundle](https://github.com/FriendsOfOpenTelemetry/opentelemetry-bundle).
+
+To make things works with OpenTelemetry, this branch includes a Docker Composer file to configure and execute a functional OpenTelemetry environnement which includes:
+
+- Tempo, to receive and store OpenTelemetry Traces
+- Prometheus, to receive OpenTelemetry Metrics
+- Loki, to receive OpenTelemetry Logs
+- Grafana, to visualize everything with all data sources configured
+
+Any issues regarding OpenTelemetry integration should be reported on the opentelemetry-bundle repository [issues](https://github.com/FriendsOfOpenTelemetry/opentelemetry-bundle/issues).
+
+## Requirements
+
+- Nix
+- Docker
+
+## Usage
+
+Follow [ReadMe](./README.md#usage) to configure the application first.
+
+Once the application is configured, you need to build a custom OpenTelemetry Collector using Nix:
+
+```bash
+nix build .#otel-collector-image.copyToDockerDaemon
+./result/bin/copy-to-docker-daemon
+```
+
+You should see our **otel-collector:latest** image when list images with Docker.
+
+You can now launch our services with Docker:
+
+```bash
+docker-compose up -d
+```
+
+All services should be up and running. If not inspect logs of exited services.
+
+Now you can browse any application pages and open Grafana (http://localhost:3000).
+
+The default data sources is Tempo, so you should see traces by search any traces.
+
+Here is a little video to show how it should look like:
+
+https://github.com/user-attachments/assets/619b9c9a-88ed-439c-a368-4efa8202a268