cmelius/opentelemetry-auto-twig

OpenTelemetry Twig Instrumentation

v1.0.0 2025-12-02 12:27 UTC

Requires

• php: ^8.0
• open-telemetry/api: ^1.6
• twig/twig: ^2.0 || ^3.0

Apache-2.0

• twig
• instrumentation
• tracing
• opentelemetry
• open-telemetry
• otel

README

In my company we needed a twig instrumentation to see what was consuming time. It's a CraftCMS website running on PHP 8.4.

This may not be perfect but it did show us time consumed by twig templates.

OpenTelemetry Twig auto-Instrumentation

This package provides automatic instrumentation for Twig templates.

Please read https://opentelemetry.io/docs/instrumentation/php/automatic/ for instructions on how to install and configure the extension and SDK.

Installation

1. Install the OpenTelemetry PHP Extension: This package relies on the opentelemetry PHP extension for automatic hooking.

2. Install the Composer package:

    composer require cmelius/opentelemetry-twig-instrumentation

3. Enable Twig-Instrumentation:

   putenv('OTEL_PHP_INSTRUMENTATION_TWIG_ENABLED=true');
   

Usage

This package provides fully automatic instrumentation. Once installed, it will automatically trace all Twig template rendering. No further configuration is required.

The instrumentation will create spans with the name twig.render.<type>, where <type> is the type of template being rendered (e.g., template, block). The spans will include the following attributes:

• twig.template: The name of the template file.
• twig.name: The name of the specific template or block being rendered.