feat: Add support for profiling (#1477)

Co-authored-by: Alex Bouma <[email protected]>

Author: cleptric

phpstan.neon

@@ -12,3 +12,5 @@ parameters:
         - tests/Fixtures
     dynamicConstantNames:
         - Monolog\Logger::API
+    bootstrapFiles:
+        - stubs/autoload.php

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.27.0@faf106e717c37b8c81721845dba9de3d8deed8ff">
+<files psalm-version="4.30.0@d0bc6e25d89f649e4f36a534f330f8bb4643dd69">
   <file src="src/Dsn.php">
     <PossiblyUndefinedArrayOffset occurrences="4">
       <code>$parsedDsn['host']</code>
@@ -59,6 +59,12 @@
       <code>$record['context']</code>
     </PossiblyUndefinedMethod>
   </file>
+  <file src="src/Profiling/Profile.php">
+    <LessSpecificReturnStatement occurrences="1"/>
+    <MoreSpecificReturnType occurrences="1">
+      <code>SentryProfile|null</code>
+    </MoreSpecificReturnType>
+  </file>
   <file src="src/Serializer/RepresentationSerializer.php">
     <InvalidReturnStatement occurrences="1">
       <code>$value</code>

psalm.xml.dist

@@ -64,4 +64,12 @@
             </errorLevel>
         </UndefinedClass>
     </issueHandlers>
+
+    <stubs>
+        <file name="stubs/ExcimerLog.stub" />
+        <file name="stubs/ExcimerLogEntry.stub" />
+        <file name="stubs/ExcimerProfiler.stub" />
+        <file name="stubs/ExcimerTimer.stub" />
+        <file name="stubs/globals.stub" />
+    </stubs>
 </psalm>

src/Context/OsContext.php

@@ -31,16 +31,27 @@ final class OsContext
      */
     private $kernelVersion;
 
+    /**
+     * @var string|null
+     */
+    private $machineType;
+
     /**
      * Constructor.
      *
      * @param string      $name          The name of the operating system
      * @param string|null $version       The version of the operating system
      * @param string|null $build         The internal build revision of the operating system
      * @param string|null $kernelVersion An independent kernel version string
+     * @param string|null $machineType   The machine type
      */
-    public function __construct(string $name, ?string $version = null, ?string $build = null, ?string $kernelVersion = null)
-    {
+    public function __construct(
+        string $name,
+        ?string $version = null,
+        ?string $build = null,
+        ?string $kernelVersion = null,
+        ?string $machineType = null
+    ) {
         if ('' === trim($name)) {
             throw new \InvalidArgumentException('The $name argument cannot be an empty string.');
         }
@@ -49,6 +60,7 @@ public function __construct(string $name, ?string $version = null, ?string $buil
         $this->version = $version;
         $this->build = $build;
         $this->kernelVersion = $kernelVersion;
+        $this->machineType = $machineType;
     }
 
     /**
@@ -126,4 +138,17 @@ public function setKernelVersion(?string $kernelVersion): void
     {
         $this->kernelVersion = $kernelVersion;
     }
+
+    public function getMachineType(): ?string
+    {
+        return $this->machineType;
+    }
+
+    /**
+     * @param string|null $machineType The machine type
+     */
+    public function setMachineType(?string $machineType): void
+    {
+        $this->machineType = $machineType;
+    }
 }

src/Event.php

@@ -6,6 +6,7 @@
 
 use Sentry\Context\OsContext;
 use Sentry\Context\RuntimeContext;
+use Sentry\Profiling\Profile;
 use Sentry\Tracing\Span;
 
 /**
@@ -167,6 +168,11 @@ final class Event
      */
     private $type;
 
+    /**
+     * @var Profile|null The profile data
+     */
+    private $profile;
+
     private function __construct(?EventId $eventId, EventType $eventType)
     {
         $this->id = $eventId ?? EventId::generate();
@@ -747,4 +753,25 @@ public function setSpans(array $spans): void
     {
         $this->spans = $spans;
     }
+
+    public function setProfile(?Profile $profile): void
+    {
+        $this->profile = $profile;
+    }
+
+    public function getProfile(): ?Profile
+    {
+        return $this->profile;
+    }
+
+    public function getTraceId(): ?string
+    {
+        $traceId = $this->getContexts()['trace']['trace_id'];
+
+        if (\is_string($traceId) && !empty($traceId)) {
+            return $traceId;
+        }
+
+        return null;
+    }
 }

src/Integration/EnvironmentIntegration.php

@@ -70,6 +70,10 @@ private function updateServerOsContext(?OsContext $osContext): ?OsContext
             $osContext->setKernelVersion(php_uname('a'));
         }
 
+        if (null === $osContext->getMachineType()) {
+            $osContext->setMachineType(php_uname('m'));
+        }
+
         return $osContext;
     }
 }

src/Options.php

@@ -183,6 +183,21 @@ public function setTracesSampleRate(?float $sampleRate): void
         $this->options = $this->resolver->resolve($options);
     }
 
+    public function getProfilesSampleRate(): ?float
+    {
+        /** @var int|float|null $value */
+        $value = $this->options['profiles_sample_rate'] ?? null;
+
+        return $value ?? null;
+    }
+
+    public function setProfilesSampleRate(?float $sampleRate): void
+    {
+        $options = array_merge($this->options, ['profiles_sample_rate' => $sampleRate]);
+
+        $this->options = $this->resolver->resolve($options);
+    }
+
     /**
      * Gets whether tracing is enabled or not. The feature is enabled when at
      * least one of the `traces_sample_rate` and `traces_sampler` options is
@@ -848,6 +863,7 @@ private function configureOptions(OptionsResolver $resolver): void
             'enable_tracing' => null,
             'traces_sample_rate' => null,
             'traces_sampler' => null,
+            'profiles_sample_rate' => null,
             'attach_stacktrace' => false,
             'context_lines' => 5,
             'enable_compression' => true,
@@ -887,6 +903,7 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedTypes('enable_tracing', ['null', 'bool']);
         $resolver->setAllowedTypes('traces_sample_rate', ['null', 'int', 'float']);
         $resolver->setAllowedTypes('traces_sampler', ['null', 'callable']);
+        $resolver->setAllowedTypes('profiles_sample_rate', ['null', 'int', 'float']);
         $resolver->setAllowedTypes('attach_stacktrace', 'bool');
         $resolver->setAllowedTypes('context_lines', ['null', 'int']);
         $resolver->setAllowedTypes('enable_compression', 'bool');