The official PHP SDK for Sentry (sentry.io)
The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v3.22.1.
The Sentry SDK team is thrilled to announce the immediate availability of Sentry PHP SDK v4.0.0.
Please refer to the UPGRADE-4.0.md guide for a complete list of breaking changes.
This version exclusively uses the envelope endpoint to send event data to Sentry.
If you are using sentry.io, no action is needed.
If you are using an on-premise/self-hosted installation of Sentry, the minimum requirement is now version >= v20.6.0
.
You need to have ext-curl
installed to use the SDK.
The IgnoreErrorsIntegration
integration was removed. Use the ignore_exceptions
option instead.
Sentry\init([
'ignore_exceptions' => [BadThingsHappenedException::class],
]);
This option performs an is_a
check now, so you can also ignore more generic exceptions.
Add new fluent APIs (#1601)
// Before
$transactionContext = new TransactionContext();
$transactionContext->setName('GET /example');
$transactionContext->setOp('http.server');
// After
$transactionContext = (new TransactionContext())
->setName('GET /example');
->setOp('http.server');
Simplify the breadcrumb API (#1603)
// Before
\Sentry\addBreadcrumb(
new \Sentry\Breadcrumb(
\Sentry\Breadcrumb::LEVEL_INFO,
\Sentry\Breadcrumb::TYPE_DEFAULT,
'auth', // category
'User authenticated', // message (optional)
['user_id' => $userId] // data (optional)
)
);
// After
\Sentry\addBreadcrumb(
category: 'auth',
message: 'User authenticated', // optional
metadata: ['user_id' => $userId], // optional
level: Breadcrumb::LEVEL_INFO, // set by default
type: Breadcrumb::TYPE_DEFAULT, // set by default
);
New logger
option (#1625)
To make it easier to debug the internals of the SDK, the logger
option now accepts a Psr\Log\LoggerInterface
instance.
We do provide two implementations, Sentry\Logger\DebugFileLogger
and Sentry\Logger\DebugStdOutLogger
.
// This logs messages to the provided file path
Sentry\init([
'logger' => new DebugFileLogger(filePath: ROOT . DS . 'sentry.log'),
]);
// This logs messages to stdout
Sentry\init([
'logger' => new DebugStdOutLogger(),
]);
New default cURL HTTP client (#1589)
The SDK now ships with its own HTTP client based on cURL. A few new options were added.
Sentry\init([
'http_proxy_authentication' => 'username:password', // user name and password to use for proxy authentication
'http_ssl_verify_peer' => false, // default true, verify the peer's SSL certificate
'http_compression' => false, // default true, http request body compression
]);
To use a different client, you may use the http_client
option.
use Sentry\Client;
use Sentry\HttpClient\HttpClientInterface;
use Sentry\HttpClient\Request;
use Sentry\HttpClient\Response;
use Sentry\Options;
$httpClient = new class() implements HttpClientInterface {
public function sendRequest(Request $request, Options $options): Response
{
// your custom implementation
return new Response($response->getStatusCode(), $response->getHeaders(), '');
}
};
Sentry\init([
'http_client' => $httpClient,
]);
To use a different transport, you may use the transport
option. A custom transport must implement the TransportInterface
.
If you use the transport
option, the http_client
option has no effect.
php-http/message-factory
was removed.The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v3.21.0.
Add Sentry::captureCheckIn()
(#1573)
Sending check-ins from the SDK is now simplified.
$checkInId = Sentry\captureCheckIn(
slug: 'monitor-slug',
status: CheckInStatus::inProgress()
);
// do something
Sentry\captureCheckIn(
checkInId: $checkInId,
slug: 'monitor-slug',
status: CheckInStatus::ok()
);
You can also pass in a monitorConfig
object as well as the duration
.
Undeprecate the tags
option (#1561)
You can now set tags that are applied to each event when calling Sentry::init()
.
Sentry\init([
'tags' => [
'foo' => 'bar',
],
])
Apply the prefixes
option to profiling frames (#1568)
If you added the prefixes
option when calling Sentry::init()
, this option will now also apply to profile frames.
Sentry\init([
'prefixes' => ['/var/www/html'],
])
The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v3.20.0.
Tracing without Performance (#1516)
You can now set up distributed tracing without the need to use the performance APIs. This allows you to connect your errors that hail from other Sentry instrumented applications to errors in your PHP application.
To continue a trace, fetch the incoming Sentry tracing headers and call \Sentry\continueTrace()
as early as possible in the request cycle.
$sentryTraceHeader = $request->getHeaderLine('sentry-trace');
$baggageHeader = $request->getHeaderLine('baggage');
continueTrace($sentryTraceHeader, $baggageHeader);
To continue a trace outward, you may attach the Sentry tracing headers to any HTTP client request.
You can fetch the required header values by calling \Sentry\getBaggage()
and \Sentry\getTraceparent()
.
Upserting Cron Monitors (#1511)
You can now create and update your Cron Monitors programmatically with code. Read more about this in our docs.
The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v3.19.1.
The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v3.19.0.
guzzlehttp/promises
v2 (#1536)
The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK v3.18.2.