seanhood / laravel-opentelemetry
Laravel middleware to send events to OpenTelemetry
Installs: 1 009
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 3
Forks: 8
Open Issues: 1
Requires
- open-telemetry/opentelemetry: dev-main
Requires (Dev)
- orchestra/testbench: ^4.0
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2023-05-11 14:44:14 UTC
README
Note: OpenTelemetry is currently alpha/pre-release. This helper library is pre-pre-alpha.
Laravel OpenTelemetry helps integrate OpenTelemetry Traces into your Laravel application.
Requirements
- Laravel 5+
- OpenTelemetry Collector w/ ZipKin
Features
- Request attributes: Path, URL, Method, Secure, Client IP, UserAgent, Status
Installation
composer require seanhood/laravel-opentelemetry
Add the Middleware to your application
// app/Http/Kernel.php protected $middleware = [ ... \SeanHood\LaravelOpenTelemetry\Middleware\Trace::class ];
Config
Publish config to config/laravel_opentelemetry.php
php artisan vendor:publish --provider="SeanHood\LaravelOpenTelemetry\LaravelOpenTelemetryServiceProvider"
The basic options are:
-
'enable' => true
: Whether to enable LaravelOpenTelemetry -
'zipkin_endpoint' => 'http://localhost:9411/api/v2/spans'
: Zipkin Endpoint to send spans to. -
'service_name' => 'laravel-otel'
: The name of your application as you'd like to identify it in your traces.