Skip to content

The only tool you need to know what is happening and how to fix it.

4.1 KB
Raw Blame

devtesting-symfony

Symfony test application for Traceway via OpenTelemetry auto-instrumentation. Mirrors the Go devtesting reference app to validate that OTLP trace and metric ingestion works correctly.

Setup (macOS)

1. Install PHP 8.2+

brew install php

2. Install the OpenTelemetry PHP extension

pecl install opentelemetry

Verify it's enabled:

php -m | grep opentelemetry

If not listed, add to your php.ini (php --ini to find it):

extension=opentelemetry

3. Install Composer (if not installed)

brew install composer

4. Install dependencies

cd testing/devtesting-symfony
composer install

5. Configure

Edit .env and set your project token:

OTEL_EXPORTER_OTLP_HEADERS=Authorization=Bearer YOUR_PROJECT_TOKEN

6. Run

Start the web server:

php -S localhost:8080 public/index.php

In a separate terminal, start the Messenger worker to process background jobs:

php bin/console messenger:consume async -vv

Endpoints

Test Controller

Method Path Description
GET /test-ok Returns 200 { status: "ok" }
GET /test-not-found Returns 404
GET /test-param/{param} Returns the route parameter
GET /test-exception Throws RuntimeException (auto-captured)
GET /test-spans Manual child spans (db.query, cache.set, http.external_api)
GET /test-metrics Manual metrics (gauge + histogram)
GET /test-message Span events (10 messages + 1 exception)
GET /test-json Span with JSON attribute
GET /test-self-report-attributes Exception with custom attributes
GET /test-cerror-simple Simple exception
GET /test-cerror-wrapped Nested exceptions (previous chain)
GET /test-cerror-custom Custom exception class
GET /test-cerror-nested Error from nested function calls
POST /test-recording/{param} JSON body parsing, throws if name != "good"

Task Controller (Symfony Messenger)

Method Path Message Handler Task Name
GET /test-task DataProcessorMessage traceway data processor — child span, 10 events, exception (mirrors Go reference)
GET /test-task-simple EmailSendMessage email.send — minimal task with attributes
GET /test-task-db UserDataSyncMessage user.data.sync — task with auto-instrumented PDO query
GET /test-task-error PaymentProcessorMessage payment.processor — child spans with exception + STATUS_ERROR

These endpoints dispatch real Symfony Messenger jobs to the async transport (Doctrine/SQLite). A separate messenger:consume worker picks them up and processes them in the background. Each handler creates a detached root span (setParent(false)) with KIND_CONSUMER, so they appear on the Tasks page in Traceway (not Endpoints).

Users Controller (CRUD)

Method Path Description
GET /users List all users
GET /users/{id} Get user by ID
POST /users Create user ({ first_name, last_name, email })
PUT /users/{id} Update user
DELETE /users/{id} Delete user

Uses SQLite file-based DB (var/devtesting.db), auto-created on first request. The opentelemetry-auto-pdo package auto-instruments all DB queries as spans.

Testing

# Basic endpoints
curl http://localhost:8080/test-ok
curl http://localhost:8080/test-exception
curl http://localhost:8080/test-spans
curl http://localhost:8080/test-metrics

# Dispatch background jobs (requires messenger:consume worker running)
curl http://localhost:8080/test-task
curl http://localhost:8080/test-task-simple
curl http://localhost:8080/test-task-db
curl http://localhost:8080/test-task-error

# User CRUD
curl -X POST http://localhost:8080/users \
  -H 'Content-Type: application/json' \
  -d '{"first_name":"John","last_name":"Doe","email":"[email protected]"}'

curl http://localhost:8080/users

Check the Traceway dashboard for endpoints, exceptions, spans, and metrics.