Adding OpenTelemetry and provide traces by FredPraca · Pull Request #4598 · LycheeOrg/Lychee

FredPraca · 2026-08-08T23:24:55Z

This PR provides OpenTelemetry functionalities to Lychee.
It allows to send logs, metrics and traces to any OpenTelemetry collector.

It has been tested with Loki, Tempo and Mimir for logs, traces and metrics respectively.

The best way to test it is to use Grafana Alloy as a collector and then dispatch to other tools such as the ones mentioned before.

It requires to install the opentelemetry extension as described here.

The following environment variables may be set:

OTEL_PHP_AUTOLOAD_ENABLED=true
OTEL_TRACES_EXPORTER=otlp
OTEL_METRICS_EXPORTER=none
OTEL_LOGS_EXPORTER=console
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318/
OTEL_SERVICE_NAME=lychee
OTEL_PHP_DISABLED_INSTRUMENTATIONS=pdo

Please note that exporters may be set to console or otlp. When using otlp, you may provide the OTEL_EXPORTER_OTLP_ENDPOINT variable to point to an OTLP collector. Here http://localhost:4318/ corresponds to a local setup for Tempo.

Moreover, OTEL_PHP_DISABLED_INSTRUMENTATIONS allows to disable some instrumentation. Here, I disabled pdo to avoid having all SQL operations in my traces. Currently, only laravel, guzzle and pdo are configured.

coderabbitai · 2026-08-08T23:25:03Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 16a236de-2ad6-4c5c-948e-47d5cb319cff

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

socket-security · 2026-08-08T23:29:44Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	composer/open-telemetry/opentelemetry-auto-guzzle@1.4.0.0
	composer/open-telemetry/opentelemetry-auto-laravel@1.8.0.0
	composer/open-telemetry/opentelemetry-auto-pdo@0.5.0.0
	composer/open-telemetry/sdk@1.15.0.0
	composer/open-telemetry/exporter-otlp@1.4.0.0

View full report

ildyria · 2026-08-11T09:03:37Z

@FredPraca I am not able to push changes to enable the CICD missing extension. Would you mind ticking the box or modify the php-test and php-dist yaml files :)

FredPraca · 2026-08-11T21:42:32Z

@FredPraca I am not able to push changes to enable the CICD missing extension. Would you mind ticking the box or modify the php-test and php-dist yaml files :)

The Allow edits by maintainers is checked so I don't know why you're unable to change it.
I didn't have time to dig into the tests and dist things. I'll take a look at it.

The main problem is that opentelemetry extensions is not a standard one. The process is described here but I don't know if I can do something like this Github actions.
Moreover, I don't know how to test without committing and pushing to GH.

FredPraca · 2026-08-11T21:51:26Z

I'm also trying to include a package providing metrics about PHP runtime, especially RAM but I face a problem with initialization order.

ildyria · 2026-08-12T11:15:23Z

-		}
+		$trace = app(TraceService::class);
+
+		return $trace->traceMethod('photo.load_file_metadata', function () use ($state, $next) {


I think here it might be cleaner to rename
handle(InitDTO $state, \Closure $next): InitDTO
into
_handle(InitDTO $state, \Closure $next): InitDTO

and then have

public function handle(InitDTO $state, \Closure $next): InitDTO { $trace = app(TraceService::class); return $trace->traceMethod('photo.load_file_metadata', fn () => $this->_handle($state, $next)); }

or indeed, rename into execute() instead of _handle :)

In fact, I started with it for telemetry tests and switched to Standalone pipes which were more promising in terms of trace and memory investigations.
If the part on Standalone pipes was considered well done by the main maintainer of Lychee, I was considering using the same pattern as for standalone pipes :)

We could also generalize this "pattern" to other types of pipes.
The drawback is that it will generate a lot of traces 😄

ildyria · 2026-08-12T11:18:02Z

+		return $trace->traceMethod($this->getSpanName(), function () use ($state, $next) {
+			return $this->execute($state, $next);
+		});


Suggested change

return $trace->traceMethod($this->getSpanName(), function () use ($state, $next) {

return $this->execute($state, $next);

});

return $trace->traceMethod($this->getSpanName(), fn () => $this->execute($state, $next));

You can use the arrow functions instead to avoid the use (...)

Ahaha, I am not really a PHP dev as you may have seen :)

ildyria · 2026-08-12T11:19:40Z

 		// Skip if the caller explicitly provided a title at upload time (FR-041-06).
 		// User-supplied titles take precedence and must not be overwritten by renamer rules.
 		if ($state->title !== null) {
+			Log::info('Photo has a title, we don\'t rename it, skipping');


I don't think this is necessary :)

Maybe at debug level or even trace ?

Ahaha, there is no trace :)
Notice maybe ?

ildyria · 2026-08-12T11:19:51Z


 		// Skip if not enabled.
 		if (!$state->shall_rename_photo_title) {
+			Log::info('renaming not necessary, skipping');


Same as before

ildyria · 2026-08-12T11:21:21Z

-	public function handle(StandaloneDTO $state, \Closure $next): StandaloneDTO
+	protected function execute(StandaloneDTO $state, \Closure $next): StandaloneDTO
 	{
+		Log::info('Computing original checksum');


Instead of info maybe we want to keep those at debug level?

As it is standard flow, yes, debug is enough

ildyria · 2026-08-12T11:23:17Z

 	{
-		$meta = $request->meta();
-		$file = new UploadedFile($request->uploaded_file_chunk());
+		// Reset max memory usage before measuring


Should this be in a middleware instead?

See here some ideas I had:
#4577

I'll read it as I'm not aware of all Laravel possibilities and especially with the middleware and so on stuff.

Besides this, I was not super happy with this way of tracing memory usage.
So we might maybe leave the trace without performing these memory features and keep tracing telemetry for what it is, following calls durations.

Your way of profiling might be a better way that we may merge with telemetry afterwards.

What do you think ?

ildyria · 2026-08-12T11:25:06Z

-		$final->delete();
-		$processable_file->close();
-		// End of work-around
+		return $this->trace->traceMethod('photo.process', function () use ($verify,


It is important to note that here you are measuring either of two cases:
if the processing is done sync, you will have the full processing memory, but if it is dispatch to a queue you won't see the computation anymore.

Yes, I figured it out and maybe we will use traces to provide time consumption instead of memory consumption.
That's the reason why I would like to import the php metrics module and experiment around it.

codecov · 2026-08-12T12:23:01Z

Codecov Report

❌ Patch coverage is 93.65672% with 17 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.00%. Comparing base (0d856a2) to head (282c473).
⚠️ Report is 3 commits behind head on master.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

FredPraca added 2 commits August 9, 2026 00:33

feat(otel): add OpenTelemetry modules

0fd2591

feat(tracing): add tracing to standalone steps

c500382

FredPraca added 4 commits August 12, 2026 00:04

feat(tests): add opentelemetry to tests

ba025f6

feat(dist): add opentelemetry to distribution

b6e5004

feat(cicd): add opentelemetry to CICD action

46811f9

fix(install): explicitly install extension

47907fc

FredPraca force-pushed the feat/telemetry branch from f9637f6 to 47907fc Compare August 11, 2026 22:42

ildyria added 2 commits August 12, 2026 13:05

use extension installer

f7421f1

remove step validate opentelemetry installed step

282c473

ildyria reviewed Aug 12, 2026

View reviewed changes

Uh oh!

Uh oh!

Conversation

FredPraca commented Aug 8, 2026

Uh oh!

coderabbitai Bot commented Aug 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

socket-security Bot commented Aug 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ildyria commented Aug 11, 2026

Uh oh!

FredPraca commented Aug 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FredPraca commented Aug 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FredPraca Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FredPraca Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Aug 12, 2026

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai Bot commented Aug 8, 2026 •

edited

Loading

socket-security Bot commented Aug 8, 2026 •

edited

Loading

FredPraca commented Aug 11, 2026 •

edited

Loading

FredPraca Aug 13, 2026 •

edited

Loading

FredPraca Aug 13, 2026 •

edited

Loading