Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Laravel Instrumentation #184

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
347a001
Laravel Instrumentation:
ChrisLightfootWild Aug 11, 2023
1221735
Added `mockery/mockery` to allow testing console commands in Laravel …
ChrisLightfootWild Aug 11, 2023
24ae2ea
Added CommandWatcher to Laravel instrumentation.
ChrisLightfootWild Aug 11, 2023
3b24774
Laravel instrumentation: fixed LaravelInstrumentationTest namespace.
ChrisLightfootWild Aug 11, 2023
cb5eea9
Laravel instrumentation: linting.
ChrisLightfootWild Aug 11, 2023
4cc513c
Laravel instrumentation: remove mockery dev dependency.
ChrisLightfootWild Aug 12, 2023
7c02e60
Laravel instrumentation: prevent real Http requests from leaking.
ChrisLightfootWild Aug 12, 2023
f49d613
Laravel instrumentation: first pass at instrumenting Console\Kernel.
ChrisLightfootWild Aug 12, 2023
da40eaf
Laravel instrumentation: linting.
ChrisLightfootWild Aug 13, 2023
e376229
Merge remote-tracking branch 'upstream/main' into laravel/hook/applic…
ChrisLightfootWild Aug 13, 2023
792a80d
Laravel instrumentation: ordered_imports fix.
ChrisLightfootWild Aug 13, 2023
b52e707
Merge remote-tracking branch 'upstream/main' into laravel/hook/applic…
ChrisLightfootWild Aug 23, 2023
1eadc5c
Laravel contrib: added "ext-json" to dependencies.
ChrisLightfootWild Aug 23, 2023
f2b5e31
Laravel instrumentation Console/Http split.
ChrisLightfootWild Aug 28, 2023
4ed45f8
Laravel console instrumentation checks scope before using it in comma…
ChrisLightfootWild Aug 28, 2023
632df00
Laravel linting.
ChrisLightfootWild Aug 28, 2023
d3e55ba
Laravel: removed now redundant WithConsoleEvents trait.
ChrisLightfootWild Aug 28, 2023
973f695
Laravel: removed unused `use ($instrumentation)`.
ChrisLightfootWild Aug 28, 2023
a24857e
Merge remote-tracking branch 'upstream/main' into laravel/hook/applic…
ChrisLightfootWild Aug 29, 2023
bc4c216
Laravel: Moved Watchers into \OpenTelemetry\Contrib\Instrumentation\L…
ChrisLightfootWild Sep 2, 2023
2c18066
Laravel: ConsoleInstrumentation updates.
ChrisLightfootWild Sep 3, 2023
22dd5b0
Laravel: end span post Command::execute hook.
ChrisLightfootWild Sep 19, 2023
a8138ad
Laravel: fixed ConsoleInstrumentationTest.
ChrisLightfootWild Sep 20, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions src/Instrumentation/Laravel/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,22 @@
"open-telemetry/sem-conv": "^1"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3",
"guzzlehttp/guzzle": "*",
"laravel/sail": "*",
"laravel/sanctum": "*",
"laravel/tinker": "*",
"mockery/mockery": "2.0.x-dev",
ChrisLightfootWild marked this conversation as resolved.
Show resolved Hide resolved
"nunomaduro/collision": "*",
"friendsofphp/php-cs-fixer": "^3",
"open-telemetry/sdk": "^1.0",
"phan/phan": "^5.0",
"php-http/mock-client": "*",
"phpstan/phpstan": "^1.1",
"phpstan/phpstan-phpunit": "^1.0",
"psalm/plugin-phpunit": "^0.16",
"open-telemetry/sdk": "^1.0",
"phpunit/phpunit": "^9.5",
"vimeo/psalm": "^4.0",
"psalm/plugin-phpunit": "^0.16",
"spatie/laravel-ignition": "*",
"laravel/sail": "*",
"laravel/tinker": "*",
"guzzlehttp/guzzle": "*"
"vimeo/psalm": "^4.0"
},
"autoload": {
"psr-4": {
Expand All @@ -46,6 +47,7 @@
}
},
"config": {
"sort-packages": true,
brettmc marked this conversation as resolved.
Show resolved Hide resolved
"allow-plugins": {
"php-http/discovery": false
}
Expand Down
32 changes: 32 additions & 0 deletions src/Instrumentation/Laravel/src/CommandWatcher.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

declare(strict_types=1);

namespace OpenTelemetry\Contrib\Instrumentation\Laravel;

use Illuminate\Console\Events\CommandFinished;
use Illuminate\Contracts\Foundation\Application;
use OpenTelemetry\API\Trace\Span;
use OpenTelemetry\Context\Context;

class CommandWatcher extends Watcher
{
/** @psalm-suppress UndefinedInterfaceMethod */
public function register(Application $app): void
{
$app['events']->listen(CommandFinished::class, [$this, 'recordCommandFinished']);
}

public function recordCommandFinished(CommandFinished $command): void
{
$scope = Context::storage()->scope();
if (!$scope) {
return;
}
$span = Span::fromContext($scope->context());
$span->addEvent('command finished', [
'command' => $command->command,
'exit-code' => $command->exitCode,
]);
}
}
23 changes: 10 additions & 13 deletions src/Instrumentation/Laravel/src/LaravelInstrumentation.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

namespace OpenTelemetry\Contrib\Instrumentation\Laravel;

use Illuminate\Foundation\Application;
use Illuminate\Foundation\Http\Kernel;
use Illuminate\Contracts\Foundation\Application;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each Watcher is already typed against \Illuminate\Contracts\Foundation\Application, so this maintains that type for consistency.

use Illuminate\Contracts\Http\Kernel;
use Illuminate\Http\Request;
use OpenTelemetry\API\Globals;
use OpenTelemetry\API\Instrumentation\CachedInstrumentation;
Expand Down Expand Up @@ -93,19 +93,16 @@ public static function register(): void
}
);
hook(
Kernel::class,
Application::class,
'__construct',
pre: static function (Kernel $kernel, array $params, string $class, string $function, ?string $filename, ?int $lineno) use ($instrumentation) {
$app = $params[0];
$app->booted(static function (Application $app) use ($instrumentation) {
self::registerWatchers($app, new ClientRequestWatcher($instrumentation));
self::registerWatchers($app, new ExceptionWatcher());
self::registerWatchers($app, new CacheWatcher());
self::registerWatchers($app, new LogWatcher());
self::registerWatchers($app, new QueryWatcher($instrumentation));
});
post: static function (Application $application, array $params, mixed $returnValue, ?Throwable $exception) use ($instrumentation) {
self::registerWatchers($application, new ClientRequestWatcher($instrumentation));
self::registerWatchers($application, new ExceptionWatcher());
self::registerWatchers($application, new CacheWatcher());
self::registerWatchers($application, new CommandWatcher());
self::registerWatchers($application, new LogWatcher());
self::registerWatchers($application, new QueryWatcher($instrumentation));
},
post: null
);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

declare(strict_types=1);

namespace OpenTelemetry\Tests\Instrumentation\Laravel\tests\Integration;
namespace OpenTelemetry\Tests\Instrumentation\Laravel\Integration;

use ArrayObject;
use Illuminate\Foundation\Http\Kernel;
Expand Down