cbos/opentelemetry-auto-joomla

OpenTelemetry auto-instrumentation for Joomla

dev-main 2024-10-29 21:16 UTC

Requires

• php: ^8.0
• ext-opentelemetry: *
• nyholm/psr7: ^1
• nyholm/psr7-server: ^1
• open-telemetry/api: ^1.0
• open-telemetry/sem-conv: ^1.24

Apache-2.0

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

README

This plugin is inspired by https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/Wordpress and focussed on Joomla

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

Requirements

• OpenTelemetry extension
• OpenTelemetry SDK + exporter (required to actually export traces)
• Joomla installation
• OpenTelemetry SDK Autoloading configured

Overview

OpenTelemetry depends on composer. This extension was developed against Joomla docker

An example in Docker of extending the official Joomla image to enable auto-instrumentation: example

apache

Configure (eg via .htaccess) a PHP prepend file to initialize composer:

php_value auto_prepend_file /var/www/vendor/autoload.php

This will install the composer autoloader before running Joomla. As part of composer autoloading, scripts are executed for installed modules, importantly:

• OpenTelemetry SDK Autoloader
• this library's _register.php file

Installation via composer

$ composer require cbos/opentelemetry-auto-joomla

Configuration

The extension can be disabled via runtime configuration:

OTEL_PHP_DISABLED_INSTRUMENTATIONS=joomla