Skip to content

docs(php): Document the profiler factory option #19890

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

Draft
binaryfire wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs(php): Document the profiler factory option #19890

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions docs/platforms/php/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,3 +423,28 @@ Leave this enabled if you want to reduce connection setup overhead for frequent
A number between `0` and `1`, controlling the percentage chance a given profile will be sent to Sentry. (`0` represents 0% while `1` represents 100%.) Setting this to a non null value will enable profiling.

</SdkOption>

<SdkOption name="profiler_factory" type='function (\Sentry\Options $options): \Sentry\Profiling\ProfilerInterface' defaultValue="null">

Switches out the profiler the SDK creates for each transaction selected for profiling. Use it when concurrent requests share one PHP process and each profile should only contain its own request's samples.

The callback receives the client's `\Sentry\Options` and must return a new `\Sentry\Profiling\ProfilerInterface` instance each time it's called.

```php
\Sentry\init([
'dsn' => '___PUBLIC_DSN___',
'traces_sample_rate' => 1.0,
'profiles_sample_rate' => 0.1,
'profiler_factory' => static function (\Sentry\Options $options): \Sentry\Profiling\ProfilerInterface {
return new \App\Monitoring\RequestProfiler($options);
},
]);
```

The SDK calls `start()` when profiling begins and `stop()` when the transaction finishes, then reads `getProfile()`, which returns a `\Sentry\Profiling\Profile` or `null` if no profile is available.

Set the profile's Unix start timestamp with `setStartTimeStamp()` and its collected samples with `setExcimerLog()`. Sample timestamps are offsets in seconds from that start time.

When this option is `null`, the SDK uses its default Excimer profiler.

</SdkOption>
Loading