Skip to content

Add package info to SDK payload #1823

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions src/Event.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
* count: int,
* tags: array<string>,
* }
* @phpstan-type SdkPackageEntry array{
* name: string,
* version: string,
* }
*/
final class Event
{
Expand Down Expand Up @@ -174,6 +178,16 @@ final class Event
*/
private $sdkVersion = Client::SDK_VERSION;

/**
* @var SdkPackageEntry[] The Sentry SDK packages
*/
private $sdkPackages = [
[
'name' => 'composer:sentry/sentry',
'version' => Client::SDK_VERSION,
],
];

/**
* @var EventType The type of the Event
*/
Expand Down Expand Up @@ -276,6 +290,40 @@ public function setSdkVersion(string $sdkVersion): self
return $this;
}

/**
* Append a package to the list of SDK packages.
*
* @param SdkPackageEntry $package The package to append
*
* @return $this
*
* @internal
*/
public function appendSdkPackage(array $package): self
{
$this->sdkPackages[] = $package;

return $this;
}

/**
* Gets the SDK playload that will be sent to Sentry.
*
* @see https://develop.sentry.dev/sdk/data-model/event-payloads/sdk/
*
* @return array{name: string, version: string, packages: SdkPackageEntry[]}
*
* @internal
*/
public function getSdkPayload(): array
{
return [
'name' => $this->sdkIdentifier,
'version' => $this->sdkVersion,
'packages' => $this->sdkPackages,
];
}

/**
* Gets the timestamp of when this event was generated.
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Serializer/EnvelopItems/EventItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,7 @@ public static function toEnvelopeItem(Event $event): string
$payload = [
'timestamp' => $event->getTimestamp(),
'platform' => 'php',
'sdk' => [
'name' => $event->getSdkIdentifier(),
'version' => $event->getSdkVersion(),
],
'sdk' => $event->getSdkPayload(),
];

if ($event->getStartTimestamp() !== null) {
Expand Down
5 changes: 1 addition & 4 deletions src/Serializer/EnvelopItems/TransactionItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,7 @@ public static function toEnvelopeItem(Event $event): string
$payload = [
'timestamp' => $event->getTimestamp(),
'platform' => 'php',
'sdk' => [
'name' => $event->getSdkIdentifier(),
'version' => $event->getSdkVersion(),
],
'sdk' => $event->getSdkPayload(),
];

if ($event->getStartTimestamp() !== null) {
Expand Down
5 changes: 1 addition & 4 deletions src/Serializer/PayloadSerializer.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,7 @@ public function serialize(Event $event): string
'event_id' => (string) $event->getId(),
'sent_at' => gmdate('Y-m-d\TH:i:s\Z'),
'dsn' => (string) $this->options->getDsn(),
'sdk' => [
'name' => $event->getSdkIdentifier(),
'version' => $event->getSdkVersion(),
],
'sdk' => $event->getSdkPayload(),
];

$dynamicSamplingContext = $event->getSdkMetadata('dynamic_sampling_context');
Expand Down
Loading