Skip to content

feat: track Eloquent ORM #339

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Apr 7, 2025
Merged

feat: track Eloquent ORM #339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6de0be4
feat: track Eloquent ORM
cedricziel Mar 29, 2025
28d1968
Update src/Instrumentation/Laravel/tests/Integration/LaravelInstrumen…
cedricziel Mar 30, 2025
321140b
fix: move eval to fixture
cedricziel Mar 31, 2025
a793e31
chore: ignore false positive for unused class
cedricziel Mar 31, 2025
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
252 changes: 252 additions & 0 deletions src/Instrumentation/Laravel/src/Hooks/Illuminate/Database/Eloquent/Model.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
<?php

declare(strict_types=1);

namespace OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\Illuminate\Database\Eloquent;

use Illuminate\Database\Eloquent\Model as EloquentModel;
use OpenTelemetry\API\Trace\SpanKind;
use OpenTelemetry\Context\Context;
use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHook;
use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\LaravelHookTrait;
use OpenTelemetry\Contrib\Instrumentation\Laravel\Hooks\PostHookTrait;
use function OpenTelemetry\Instrumentation\hook;
use OpenTelemetry\SemConv\TraceAttributes;
use Throwable;

class Model implements LaravelHook
{
use LaravelHookTrait;
use PostHookTrait;

public function instrument(): void
{
$this->hookFind();
$this->hookPerformInsert();
$this->hookPerformUpdate();
$this->hookDelete();
$this->hookGetModels();
$this->hookDestroy();
$this->hookRefresh();
}

private function hookFind(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
\Illuminate\Database\Eloquent\Builder::class,
'find',
pre: function ($builder, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$model = $builder->getModel();
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::find')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'find');

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function ($builder, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}

private function hookPerformUpdate(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
EloquentModel::class,
'performUpdate',
pre: function (EloquentModel $model, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::update')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'update');

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function (EloquentModel $model, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}

private function hookPerformInsert(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
EloquentModel::class,
'performInsert',
pre: function (EloquentModel $model, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::create')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'create');

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function (EloquentModel $model, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}

private function hookDelete(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
EloquentModel::class,
'delete',
pre: function (EloquentModel $model, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::delete')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'delete');

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function (EloquentModel $model, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}

private function hookGetModels(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
\Illuminate\Database\Eloquent\Builder::class,
'getModels',
pre: function ($builder, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$model = $builder->getModel();
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::get')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'get')
->setAttribute('db.statement', $builder->getQuery()->toSql());

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function ($builder, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}

private function hookDestroy(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
EloquentModel::class,
'destroy',
pre: function ($model, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::destroy')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'destroy');

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function ($model, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}

private function hookRefresh(): void
{
/** @psalm-suppress UnusedFunctionCall */
hook(
EloquentModel::class,
'refresh',
pre: function (EloquentModel $model, array $params, string $class, string $function, ?string $filename, ?int $lineno) {
$builder = $this->instrumentation
->tracer()
->spanBuilder($model::class . '::refresh')
->setSpanKind(SpanKind::KIND_INTERNAL)
->setAttribute(TraceAttributes::CODE_FUNCTION_NAME, $function)
->setAttribute(TraceAttributes::CODE_NAMESPACE, $class)
->setAttribute(TraceAttributes::CODE_FILEPATH, $filename)
->setAttribute(TraceAttributes::CODE_LINE_NUMBER, $lineno)
->setAttribute('laravel.eloquent.model', $model::class)
->setAttribute('laravel.eloquent.table', $model->getTable())
->setAttribute('laravel.eloquent.operation', 'refresh');

$parent = Context::getCurrent();
$span = $builder->startSpan();
Context::storage()->attach($span->storeInContext($parent));

return $params;
},
post: function (EloquentModel $model, array $params, $result, ?Throwable $exception) {
$this->endSpan($exception);
}
);
}
}
1 change: 1 addition & 0 deletions src/Instrumentation/Laravel/src/LaravelInstrumentation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public static function register(): void
Hooks\Illuminate\Queue\SyncQueue::hook($instrumentation);
Hooks\Illuminate\Queue\Queue::hook($instrumentation);
Hooks\Illuminate\Queue\Worker::hook($instrumentation);
Hooks\Illuminate\Database\Eloquent\Model::hook($instrumentation);
}

public static function shouldTraceCli(): bool
Expand Down
Loading
Loading