Open Telemetry Package for Laravel

The LaraOTel OpenTelemetry package for Laravel provides a simple way to incorporate OpenTelemetry in your Laravel application. This package can measure performance across jobs, services, database queries, events, and more.

OpenTelemetry (OTel) is a "vendor-neutral open source observability framework for instrumenting, generating, collecting, and exporting telemetry data such as traces, metrics, and logs."

To start using this package, you'll enable the package's global middleware used to measure requests, and you can configure watchers via the package's configuration file to trace specific parts of your application:

• AuthenticateWatcher to trace authentications.
• CacheWatcher to trace cache operations.
• DatabaseQueryWatcher to trace database queries.
• QueueWatcher to trace job execution.
• RedisWatcher to trace redis operations.
• EventWatcher to trace event opearations.
• HtttpClientWatcher to trace http client requests.
• LogWatcher to trace log operations.

You can also create custom spans to measure the performance of specific parts of your application:

use LaraOTel\OpenTelemetryLaravel\Facades\Measure;

Measure::span('my-web-request')->measure(function() {
    // ...
});

// Or manually start and end a span
Measure::start('my-web-request');

// ...

Measure::end();

// Modify span attributes
Measure::start('my-web-request', function($span) {
    $span->setAttribute('key', 'value');
    // ...
});

// ...
Measure::end();

This package also supports open-source tracing applications (Zipkin and Jaeger) for visualizing traces if you want to try it out locally. You'll need to install and enable the PHP PHP OpenTelemetry extension to use this package.

You can learn more about this package, get full installation instructions, and view the source code on GitHub. You can install this package in your Laravel application with Composer:

composer require laraotel/opentelemetry-laravel:2.0.3