Add Sentry logs

phpstan-baseline.neon

@@ -53,12 +53,7 @@ parameters:
 		-
 			message: "#^Parameter \\#2 \\.\\.\\.\\$values of function sprintf expects bool\\|float\\|int\\|string\\|null, mixed given\\.$#"
 			count: 1
-			path: src/Logger/DebugFileLogger.php
-
-		-
-			message: "#^Parameter \\#2 \\.\\.\\.\\$values of function sprintf expects bool\\|float\\|int\\|string\\|null, mixed given\\.$#"
-			count: 1
-			path: src/Logger/DebugStdOutLogger.php
+			path: src/Logger/DebugLogger.php
 
 		-
 			message: "#^Parameter \\#1 \\$level of method Monolog\\\\Handler\\\\AbstractHandler\\:\\:__construct\\(\\) expects 100\\|200\\|250\\|300\\|400\\|500\\|550\\|600\\|'ALERT'\\|'alert'\\|'CRITICAL'\\|'critical'\\|'DEBUG'\\|'debug'\\|'EMERGENCY'\\|'emergency'\\|'ERROR'\\|'error'\\|'INFO'\\|'info'\\|'NOTICE'\\|'notice'\\|'WARNING'\\|'warning'\\|Monolog\\\\Level, int\\|Monolog\\\\Level\\|string given\\.$#"
@@ -80,6 +75,11 @@ parameters:
 			count: 1
 			path: src/Options.php
 
+		-
+			message: "#^Method Sentry\\\\Options\\:\\:getBeforeSendLogCallback\\(\\) should return callable\\(Sentry\\\\Logs\\\\Log\\)\\: \\(Sentry\\\\Logs\\\\Log\\|null\\) but returns mixed\\.$#"
+			count: 1
+			path: src/Options.php
+
 		-
 			message: "#^Method Sentry\\\\Options\\:\\:getBeforeSendMetricsCallback\\(\\) should return callable\\(Sentry\\\\Event, Sentry\\\\EventHint\\|null\\)\\: \\(Sentry\\\\Event\\|null\\) but returns mixed\\.$#"
 			count: 1
@@ -105,6 +105,11 @@ parameters:
 			count: 1
 			path: src/Options.php
 
+		-
+			message: "#^Method Sentry\\\\Options\\:\\:getEnableLogs\\(\\) should return bool but returns mixed\\.$#"
+			count: 1
+			path: src/Options.php
+
 		-
 			message: "#^Method Sentry\\\\Options\\:\\:getEnableTracing\\(\\) should return bool\\|null but returns mixed\\.$#"
 			count: 1

src/Attributes/Attribute.php

@@ -0,0 +1,126 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Attributes;
+
+/**
+ * @phpstan-type AttributeType 'string'|'boolean'|'integer'|'double'
+ * @phpstan-type AttributeValue string|bool|int|float
+ * @phpstan-type AttributeSerialized array{
+ *     type: AttributeType,
+ *     value: AttributeValue
+ * }
+ */
+class Attribute implements \JsonSerializable
+{
+    /**
+     * @var AttributeType
+     */
+    private $type;
+
+    /**
+     * @var AttributeValue
+     */
+    private $value;
+
+    /**
+     * @param AttributeValue $value
+     * @param AttributeType  $type
+     */
+    public function __construct($value, string $type)
+    {
+        $this->value = $value;
+        $this->type = $type;
+    }
+
+    /**
+     * @return AttributeType
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * @return AttributeValue
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /**
+     * @param mixed $value
+     *
+     * @throws \InvalidArgumentException thrown when the value cannot be serialized as an attribute
+     */
+    public static function fromValue($value): self
+    {
+        $attribute = self::tryFromValue($value);
+
+        if ($attribute === null) {
+            throw new \InvalidArgumentException(\sprintf('Invalid attribute value, %s cannot be serialized', \gettype($value)));
+        }
+
+        return $attribute;
+    }
+
+    /**
+     * @param mixed $value
+     */
+    public static function tryFromValue($value): ?self
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (\is_bool($value)) {
+            return new self($value, 'boolean');
+        }
+
+        if (\is_int($value)) {
+            return new self($value, 'integer');
+        }
+
+        if (\is_float($value)) {
+            return new self($value, 'double');
+        }
+
+        if (\is_string($value) || (\is_object($value) && method_exists($value, '__toString'))) {
+            $stringValue = (string) $value;
+
+            if (empty($stringValue)) {
+                return null;
+            }
+
+            return new self($stringValue, 'string');
+        }
+
+        return null;
+    }
+
+    /**
+     * @return AttributeSerialized
+     */
+    public function toArray(): array
+    {
+        return [
+            'type' => $this->type,
+            'value' => $this->value,
+        ];
+    }
+
+    /**
+     * @return AttributeSerialized
+     */
+    public function jsonSerialize(): array
+    {
+        return $this->toArray();
+    }
+
+    public function __toString(): string
+    {
+        return "{$this->value} ({$this->type})";
+    }
+}

src/Attributes/AttributeBag.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Attributes;
+
+/**
+ * @phpstan-import-type AttributeValue from Attribute
+ * @phpstan-import-type AttributeSerialized from Attribute
+ */
+class AttributeBag implements \JsonSerializable
+{
+    /**
+     * @var array<string, Attribute>
+     */
+    private $attributes = [];
+
+    /**
+     * @param mixed $value
+     */
+    public function set(string $key, $value): self
+    {
+        $attribute = $value instanceof Attribute
+            ? $value
+            : Attribute::tryFromValue($value);
+
+        if ($attribute !== null) {
+            $this->attributes[$key] = $attribute;
+        }
+
+        return $this;
+    }
+
+    public function get(string $key): ?Attribute
+    {
+        return $this->attributes[$key] ?? null;
+    }
+
+    /**
+     * @return array<string, Attribute>
+     */
+    public function all(): array
+    {
+        return $this->attributes;
+    }
+
+    /**
+     * @return array<string, AttributeSerialized>
+     */
+    public function toArray(): array
+    {
+        return array_map(static function (Attribute $attribute) {
+            return $attribute->jsonSerialize();
+        }, $this->attributes);
+    }
+
+    /**
+     * @return array<string, AttributeSerialized>
+     */
+    public function jsonSerialize(): array
+    {
+        return $this->toArray();
+    }
+
+    /**
+     * @return array<string, AttributeValue>
+     */
+    public function toSimpleArray(): array
+    {
+        return array_map(static function (Attribute $attribute) {
+            return $attribute->getValue();
+        }, $this->attributes);
+    }
+}

src/Client.php

@@ -255,6 +255,16 @@ public function getTransport(): TransportInterface
         return $this->transport;
     }
 
+    public function getSdkIdentifier(): string
+    {
+        return $this->sdkIdentifier;
+    }
+
+    public function getSdkVersion(): string
+    {
+        return $this->sdkVersion;
+    }
+
     /**
      * Assembles an event and prepares it to be sent of to Sentry.
      *
@@ -280,6 +290,7 @@ private function prepareEvent(Event $event, ?EventHint $hint = null, ?Scope $sco
 
         $event->setSdkIdentifier($this->sdkIdentifier);
         $event->setSdkVersion($this->sdkVersion);
+
         $event->setTags(array_merge($this->options->getTags(), $event->getTags()));
 
         if ($event->getServerName() === null) {

src/Event.php

@@ -6,6 +6,7 @@
 
 use Sentry\Context\OsContext;
 use Sentry\Context\RuntimeContext;
+use Sentry\Logs\Log;
 use Sentry\Profiling\Profile;
 use Sentry\Tracing\Span;
 
@@ -65,6 +66,11 @@ final class Event
      */
     private $checkIn;
 
+    /**
+     * @var Log[]
+     */
+    private $logs = [];
+
     /**
      * @var string|null The name of the server (e.g. the host name)
      */
@@ -230,6 +236,11 @@ public static function createCheckIn(?EventId $eventId = null): self
         return new self($eventId, EventType::checkIn());
     }
 
+    public static function createLogs(?EventId $eventId = null): self
+    {
+        return new self($eventId, EventType::logs());
+    }
+
     /**
      * @deprecated Metrics are no longer supported. Metrics API is a no-op and will be removed in 5.x.
      */
@@ -416,6 +427,24 @@ public function setCheckIn(?CheckIn $checkIn): self
         return $this;
     }
 
+    /**
+     * @return Log[]
+     */
+    public function getLogs(): array
+    {
+        return $this->logs;
+    }
+
+    /**
+     * @param Log[] $logs
+     */
+    public function setLogs(array $logs): self
+    {
+        $this->logs = $logs;
+
+        return $this;
+    }
+
     /**
      * @deprecated Metrics are no longer supported. Metrics API is a no-op and will be removed in 5.x.
      */

src/EventType.php

@@ -42,6 +42,11 @@ public static function checkIn(): self
         return self::getInstance('check_in');
     }
 
+    public static function logs(): self
+    {
+        return self::getInstance('log');
+    }
+
     /**
      * @deprecated Metrics are no longer supported. Metrics API is a no-op and will be removed in 5.x.
      */
@@ -61,6 +66,7 @@ public static function cases(): array
             self::event(),
             self::transaction(),
             self::checkIn(),
+            self::logs(),
             self::metrics(),
         ];
     }

src/Logger/DebugFileLogger.php

@@ -4,9 +4,7 @@
 
 namespace Sentry\Logger;
 
-use Psr\Log\AbstractLogger;
-
-class DebugFileLogger extends AbstractLogger
+class DebugFileLogger extends DebugLogger
 {
     /**
      * @var string
@@ -18,13 +16,8 @@ public function __construct(string $filePath)
         $this->filePath = $filePath;
     }
 
-    /**
-     * @param mixed              $level
-     * @param string|\Stringable $message
-     * @param mixed[]            $context
-     */
-    public function log($level, $message, array $context = []): void
+    public function write(string $message): void
     {
-        file_put_contents($this->filePath, \sprintf("sentry/sentry: [%s] %s\n", $level, (string) $message), \FILE_APPEND);
+        file_put_contents($this->filePath, $message, \FILE_APPEND);
     }
 }

src/Logger/DebugLogger.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\Logger;
+
+use Psr\Log\AbstractLogger;
+
+abstract class DebugLogger extends AbstractLogger
+{
+    /**
+     * @param mixed              $level
+     * @param string|\Stringable $message
+     * @param mixed[]            $context
+     */
+    public function log($level, $message, array $context = []): void
+    {
+        $formattedMessageAndContext = implode(' ', array_filter([(string) $message, json_encode($context)]));
+
+        $this->write(
+            \sprintf("sentry/sentry: [%s] %s\n", $level, $formattedMessageAndContext)
+        );
+    }
+
+    abstract public function write(string $message): void;
+}