plunkettscott/laravel-otel

OpenTelemetry for Laravel

v0.4.2 2024-06-24 14:12 UTC

Requires

• php: ^8.2
• guzzlehttp/promises: ^1.5 || ^2.0
• laravel/framework: ^9.0|^10.0|^11.0
• open-telemetry/api: ^1.0@beta
• open-telemetry/sdk: ^1.0@beta
• php-http/message-factory: ^1.0
• symfony/http-client: ^6.2 || ^7.0

Requires (Dev)

• guzzlehttp/guzzle: ^7.5
• laravel/pint: ^1.6
• orchestra/testbench: ^8.0 || ^9.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-mock: ^2.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0

MIT

• Scott Plunkett

• plunkettscott
• laravel-otel

README

This package provides an OpenTelemetry integration for Laravel applications. It is based on the OpenTelemetry PHP project and provides instrumentation for a number of Laravel components.

Important Note

This package currently relies on a beta release of the OpenTelemetry PHP project.

We will keep the OpenTelemetry PHP dependency up-to-date as new releases are made available. However, we cannot guarantee that this package will work with future versions of OpenTelemetry PHP without breaking changes.

Watchers

This package is currently in development and contains the following Watchers:

• Incoming HTTP Requests
• HTTP Client Requests
• Database Queries
• Redis Commands
• Queued Jobs
• Events
• Event Listeners
• Cache Commands
• View Rendering (Exploring Capabilities)
• Exceptions
• Log Messages
• Scheduled Tasks

Requirements

• PHP 8.2+
• Laravel 10.0+

Installation

You can install the package via composer:

composer require plunkettscott/laravel-otel

Usage

1. Install the package

composer require plunkettscott/laravel-otel

1. Execute the otel:install command

php artisan otel:install

1. Configure the methods in app/Providers/OtelServiceProvider.php to suit your needs

2. Configure the watchers in config/otel.php to suit your needs. See the documentation for more information.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email oss (at) scottplunkett.com instead of using the issue tracker.

Credits

• Scott Plunkett
• All Contributors

License

The MIT License (MIT). Please see License File for more information.