Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/overtrue/laravel-open-telemetry
This package provides a simple way to add OpenTelemetry to your Laravel application.
https://github.com/overtrue/laravel-open-telemetry
laravel-package opentelemetry opentelemetry-laravel opentelemetry-php opentracing tracing-library
Last synced: about 1 month ago
JSON representation
This package provides a simple way to add OpenTelemetry to your Laravel application.
- Host: GitHub
- URL: https://github.com/overtrue/laravel-open-telemetry
- Owner: overtrue
- License: mit
- Created: 2024-04-17T12:32:13.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-19T08:02:35.000Z (5 months ago)
- Last Synced: 2024-09-27T07:01:06.675Z (about 2 months ago)
- Topics: laravel-package, opentelemetry, opentelemetry-laravel, opentelemetry-php, opentracing, tracing-library
- Language: PHP
- Homepage:
- Size: 146 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Laravel OpenTelemetry
This package provides a simple way to add [OpenTelemetry](https://opentelemetry.io/) to your Laravel application.
[](https://github.com/overtrue/laravel-open-telemetry/actions)
[](https://packagist.org/packages/overtrue/laravel-open-telemetry)
[](https://packagist.org/packages/overtrue/laravel-open-telemetry)
[](https://packagist.org/packages/overtrue/laravel-open-telemetry)
[](https://packagist.org/packages/overtrue/laravel-open-telemetry)
## Installation
You can install the package via composer:
```bash
composer require overtrue/laravel-open-telemetry
```
## Usage
### Configuration
Publish the configuration file:
```bash
php artisan vendor:publish --provider="Overtrue\LaravelOpenTelemetry\OpenTelemetryServiceProvider" --tag="config"
```
### Update the environment variables
> You can refer to [OpenTelemetry SDK Configuration Instructions](https://opentelemetry.io/docs/languages/sdk-configuration/general)
```dotenv
OTEL_ENABLED=true
OTEL_AUTO_TRACE_REQUESTS=true
OTEL_PHP_AUTOLOAD_ENABLED=true
OTEL_PHP_TRACE_CLI_ENABLED=true
OTEL_SERVICE_NAME=my-app
OTEL_TRACES_EXPORTER=otlp
#OTEL_EXPORTER_OTLP_PROTOCOL=grpc
OTEL_EXPORTER_OTLP_ENDPOINT=http://collector:4318
OTEL_PROPAGATORS=baggage,tracecontext
```
and other environment variables, you can find them in the configuration file: `config/otle.php`.
### Register the middleware
you can register the middleware in the `app/Http/Kernel.php`:
```php
protected $middleware = [
\Overtrue\LaravelOpenTelemetry\Middlewares\MeasureRequest::class,
// ...
];
```
or you can set the env variable `OTEL_AUTO_TRACE_REQUESTS` to `true` to enable it automatically.
### Custom span
You can create a custom span by using the `Overtrue\LaravelOpenTelemetry\Facades\Measure` facade:
```php
use Overtrue\LaravelOpenTelemetry\Facades\Measure;
Measure::span('your-span-name')->measure(function() {
// ...
});
```
or manually start and end a span:
```php
Measure::start('your-span-name');
// ...
Measure::end();
```
and you can modify the span attributes by using a closure:
```php
Measure::start('your-span-name', function($span) {
$span->setAttribute('key', 'value');
// ...
});
// ...
Measure::end();
```
of course, you can get the span instance by using the `Measure::span()` method:
```php
$span = Measure::span('your-span-name');
$span->setAttribute('key', 'value');
$scope = $span->activate();
// ...
$span->end();
$scope->detach();
```
## Contributing
You can contribute in one of three ways:
1. File bug reports using the [issue tracker](https://github.com/overtrue/laravel-opentelemetry/issues).
2. Answer questions or fix bugs on the [issue tracker](https://github.com/overtrue/laravel-opentelemetry/issues).
3. Contribute new features or update the wiki.
_The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable._
## :heart: Sponsor me
如果你喜欢我的项目并想支持它，[点击这里 :heart:](https://github.com/sponsors/overtrue)
## Project supported by JetBrains
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[](https://www.jetbrains.com/?from=https://github.com/overtrue)
## License
MIT