https://github.com/cbos/opentelemetry-auto-joomla
OpenTelemetry Joomla auto-instrumentation
https://github.com/cbos/opentelemetry-auto-joomla
Last synced: 26 days ago
JSON representation
OpenTelemetry Joomla auto-instrumentation
- Host: GitHub
- URL: https://github.com/cbos/opentelemetry-auto-joomla
- Owner: cbos
- License: apache-2.0
- Created: 2024-10-24T16:42:00.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T21:16:58.000Z (7 months ago)
- Last Synced: 2025-04-28T14:09:40.971Z (26 days ago)
- Language: PHP
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenTelemetry Joomla auto-instrumentation
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](https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/autoload_sdk.php) 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](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
```bash
$ composer require cbos/opentelemetry-auto-joomla
```
## Configuration
The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration):
```shell
OTEL_PHP_DISABLED_INSTRUMENTATIONS=joomla
```