Steps to Add Zipkin Trace Points in WordPress Code (docker container)
March 12th, 2025 8:02 AM Mr. Q Categories: Tools
To integrate Zipkin trace points into a WordPress site running in Docker, you’ll need to instrument the WordPress application code to create traces and send them to the Zipkin server. Here’s how you can approach this:
- Set up a Zipkin-compatible tracing library: You’ll need a PHP tracing library that integrates with Zipkin. One such library is OpenTelemetry (via the PHP SDK), which supports tracing and can send the data to Zipkin.
- Install the Zipkin Tracing Library: You need to install a PHP Zipkin client. OpenTelemetry is a great option because it provides an open standard and integrates well with Zipkin. You can use
open-telemetry/opentelemetry-phpto send traces to Zipkin. Install the OpenTelemetry SDK for PHP inside the WordPress container using Composer.- Install Composer (if not already installed in your Docker container):
Copy001curl -sS https://getcomposer.org/installer | php
002mv composer.phar /usr/local/bin/composer
- Install the OpenTelemetry PHP SDK: Inside your WordPress Docker container, run:
Copy001composer require open-telemetry/opentelemetry
- Set up OpenTelemetry to send traces to Zipkin: You need to configure the OpenTelemetry tracer to send data to the Zipkin server.
- Create a
zipkin.phpfile (or similar) in your WordPress codebase to configure OpenTelemetry.Use theZipkinExporterto send traces to Zipkin.
zipkin.php: - Create a
Copy001<?php
002// Include the OpenTelemetry autoloader
003require_once 'vendor/autoload.php';
004use OpenTelemetry\Sdk\Trace\TracerProvider;
005use OpenTelemetry\Sdk\Trace\Export\BatchSpanProcessor;
006use OpenTelemetry\Sdk\Trace\Export\ZipkinExporter;
007use OpenTelemetry\Trace\Tracer;
008// Setup Zipkin Exporter
009$zipkinExporter = new ZipkinExporter('http://zipkin.local:9411/api/v2/spans');
010// Create the Trace Provider with the Zipkin exporter
011$traceProvider = new TracerProvider( new BatchSpanProcessor($zipkinExporter) );
012// Set the tracer provider for the global context
013\OpenTelemetry\Context\Context::setTracerProvider($traceProvider);
- This script sets up the Zipkin exporter to send trace data to the Zipkin server running at
http://zipkin..local:9411 - Instrument Code to Generate Traces: In your WordPress code, you’ll want to create spans around specific actions or requests where you want to track performance and trace data. For example, to trace a WordPress page load, you can wrap the page load process in a span. Example
index.phpor any WordPress action file:
Copy001<?php
002// Include Zipkin setup
003require_once 'zipkin.php';
004
005// Create a span for the current page load
006$tracer = \OpenTelemetry\Context\Context::getTracerProvider()->getTracer('wordpress-tracer');
007$span = $tracer->startAndEndSpan('page-load', function() use ($tracer) {
008// Simulate page load process or log specific activities
009// Your WordPress code goes here...
010
011// You can add tags to your span to track specific values
012$tracer->setAttribute('custom.page', 'home');
013
014// Simulate some workload
015sleep(1); // Simulate some processing delay
016});
- You can also wrap specific actions in WordPress that you’re interested in tracing, such as plugin activations, database queries, API calls, etc. For example:
- Database queries: Wrap your
wpdbqueries in a span. - API calls: Wrap external HTTP requests made by WordPress in a span.
- Plugin actions: Track specific plugin logic using spans.
- Database queries: Wrap your
- Run and Monitor in Zipkin: After adding the tracing code, you can view the traces in Zipkin UI by accessing the Zipkin dashboard at
http://zipkin.. You should be able to see traces for WordPress actions like page loads, database queries, and plugin calls if they are wrapped in spans.local/zipkin/
Docker Setup Considerations
Since you’re using Docker, ensure the following:
- Network Configuration: Make sure your WordPress Docker container can communicate with the Zipkin container. If both are in the same Docker network, they should be able to reach each other. If necessary, ensure that Zipkin’s port (9411) is exposed properly. Example
docker-compose.ymlsnippet for the network setup:
Copy001version: '3'
002services: zipkin:
003image: openzipkin/zipkin
004networks:
005 - wordpress_network ports: - "9411:9411" wordpress:
006image: wordpress networks:
007 - wordpress_network
008 environment: - WORDPRESS_DB_HOST=your_db_host
009 - WORDPRESS_DB_NAME=your_db_name
010 - WORDPRESS_DB_USER=your_db_user
011 - WORDPRESS_DB_PASSWORD=your_db_password networks:
012 wordpress_network:
013driver:
014bridge
- Environment Variables: Ensure the Zipkin endpoint (
http://zipkin:9411/api/v2/spans) is correctly set as an environment variable or configuration parameter in your WordPress container. - Logging and Debugging: You can increase the verbosity of the OpenTelemetry logging to help debug issues if traces are not appearing in Zipkin. Add logging to OpenTelemetry:
Copy001use OpenTelemetry\Sdk\Trace\Export\SimpleSpanProcessor;
002use OpenTelemetry\Sdk\Trace\Export\LoggerExporter;
003
004$loggerExporter = new LoggerExporter();
005$traceProvider->addSpanProcessor(new SimpleSpanProcessor($loggerExporter));
Conclusion
To add trace points to your WordPress site running in Docker with Zipkin:
- Install OpenTelemetry or another PHP tracing library that supports Zipkin.
- Set up the Zipkin exporter and configure it to send data to your Zipkin instance.
- Wrap your WordPress application code in spans to generate trace data for the actions you want to track.
- Monitor the traces in the Zipkin dashboard.
With this setup, you should start seeing traces from your WordPress application in the Zipkin UI, allowing you to analyze and debug performance issues.