Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/opentelemetry-php/contrib-auto-wordpress

[READONLY] OpenTelemetry Wordpress auto-instrumentation
https://github.com/opentelemetry-php/contrib-auto-wordpress

Last synced: about 1 month ago
JSON representation

[READONLY] OpenTelemetry Wordpress auto-instrumentation

Host: GitHub
URL: https://github.com/opentelemetry-php/contrib-auto-wordpress
Owner: opentelemetry-php
Created: 2023-02-01T13:48:44.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-06-29T06:24:24.000Z (6 months ago)
Last Synced: 2024-06-29T07:24:13.016Z (6 months ago)
Language: PHP
Size: 20.5 KB
Stars: 8
Watchers: 3
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

[![Releases](https://img.shields.io/badge/releases-purple)](https://github.com/opentelemetry-php/contrib-auto-wordpress/releases)
[![Issues](https://img.shields.io/badge/issues-pink)](https://github.com/open-telemetry/opentelemetry-php/issues)
[![Source](https://img.shields.io/badge/source-contrib-green)](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/Wordpress)
[![Mirror](https://img.shields.io/badge/mirror-opentelemetry--php--contrib-blue)](https://github.com/opentelemetry-php/contrib-auto-wordpress)
[![Latest Version](http://poser.pugx.org/open-telemetry/opentelemetry-auto-wordpress/v/unstable)](https://packagist.org/packages/open-telemetry/opentelemetry-auto-wordpress/)
[![Stable](http://poser.pugx.org/open-telemetry/opentelemetry-auto-wordpress/v/stable)](https://packagist.org/packages/open-telemetry/opentelemetry-auto-wordpress/)

This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib.

# OpenTelemetry Wordpress auto-instrumentation

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)
* WordPress installation
* OpenTelemetry [SDK Autoloading](https://github.com/open-telemetry/opentelemetry-php/blob/main/examples/autoload_sdk.php) configured

## Overview
OpenTelemetry depends on composer, unlike Wordpress. This extension was developed against
[johnpbloch/wordpress-core](https://github.com/johnpbloch/wordpress-core-installer),
but it should also work with other installation methods.

An example in Docker of extending the official Wordpress image to enable
auto-instrumentation: https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/examples/instrumentation/Wordpress

### 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 Wordpress. 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 open-telemetry/opentelemetry-auto-wordpress
```

## Configuration

The extension can be disabled via [runtime configuration](https://opentelemetry.io/docs/instrumentation/php/sdk/#configuration):

```shell
OTEL_PHP_DISABLED_INSTRUMENTATIONS=wordpress
```