sentry-php/src/Profiling/Profile.php at source-frame-cache · getsentry/sentry-php · GitHub

History

402 lines (337 loc) · 11.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

<?php

declare(strict_types=1);

namespace Sentry\Profiling;

use Psr\Log\LoggerInterface;

use Psr\Log\NullLogger;

use Sentry\Context\OsContext;

use Sentry\Context\RuntimeContext;

use Sentry\Event;

use Sentry\EventId;

use Sentry\Options;

use Sentry\Util\PrefixStripper;

use Sentry\Util\SentryUid;

/**

* Type definition of the Sentry profile format.

* All fields are none otpional.

* @see https://develop.sentry.dev/sdk/sample-format/

* @phpstan-type SentryProfileFrame array{

* abs_path: string,

* filename: string,

* function: string,

* module: string|null,

* lineno: int|null,

* }

* @phpstan-type SentryProfile array{

* device: array{

* architecture: string,

* },

* event_id: string,

* os: array{

* name: string,

* version: string,

* build_number: string,

* },

* platform: 'php',

* release: string,

* environment: string,

* runtime: array{

* name: string,

* version: string,

* },

* timestamp: string,

* transaction: array{

* id: string,

* name: string,

* trace_id: string,

* active_thread_id: string,

* },

* version: string,

* profile: array{

* frames: array<int, SentryProfileFrame>,

* samples: array<int, array{

* elapsed_since_start_ns: int,

* stack_id: int,

* thread_id: string,

* }>,

* stacks: array<int, array<int, int>>,

* },

* }

* @phpstan-type ExcimerLogStackEntryTrace array{

* file: string,

* line: int,

* class?: string,

* function?: string,

* closure_line?: int,

* }

* @phpstan-type ExcimerLogStackEntry array{

* trace: array<int, ExcimerLogStackEntryTrace>,

* timestamp: float

* }

* @internal

final class Profile

{

use PrefixStripper;

/**

* @var string The version of the profile format

private const VERSION = '1';

/**

* @var string The thread ID

private const THREAD_ID = '0';

/**

* @var int The minimum number of samples required for a profile

private const MIN_SAMPLE_COUNT = 2;

/**

* @var int The maximum duration of a profile in seconds

private const MAX_PROFILE_DURATION = 30;

/**

* @var float The start time of the profile as a Unix timestamp with microseconds

private $startTimeStamp;

/**

* @var \ExcimerLog|array<int, ExcimerLogStackEntry> The data of the profile

private $excimerLog;

/**

* @var EventId|null The event ID of the profile

private $eventId;

/**

* @var Options|null

private $options;

/**

* @var LoggerInterface

private $logger;

public function __construct(?Options $options = null)

{

$this->options = $options;

$this->logger = $options !== null ? $options->getLoggerOrNullLogger() : new NullLogger();

}

public function setStartTimeStamp(float $startTimeStamp): void

{

$this->startTimeStamp = $startTimeStamp;

}

/**

* @param \ExcimerLog|array<int, ExcimerLogStackEntry> $excimerLog

public function setExcimerLog($excimerLog): void

{

$this->excimerLog = $excimerLog;

}

public function setEventId(EventId $eventId): void

{

$this->eventId = $eventId;

}

/**

* @return SentryProfile|null

public function getFormattedData(Event $event): ?array

{

if (!$this->validateExcimerLog()) {

$this->logger->warning('The profile does not contain enough samples, the profile will be discarded.');

return null;

}

$osContext = $event->getOsContext();

if (!$this->validateOsContext($osContext)) {

$this->logger->warning('The OS context is not missing or invalid, the profile will be discarded.');

return null;

}

$runtimeContext = $event->getRuntimeContext();

if (!$this->validateRuntimeContext($runtimeContext)) {

$this->logger->warning('The runtime context is not missing or invalid, the profile will be discarded.');

return null;

}

if (!$this->validateEvent($event)) {

$this->logger->warning('The event is missing a transaction and/or trace ID, the profile will be discarded.');

return null;

}

$frames = [];

$frameHashMap = [];

$stacks = [];

$stackHashMap = [];

$registerStack = static function (array $stack) use (&$stacks, &$stackHashMap): int {

$stackHash = md5(serialize($stack));

if (\array_key_exists($stackHash, $stackHashMap) === false) {

$stackHashMap[$stackHash] = \count($stacks);

$stacks[] = $stack;

}

return $stackHashMap[$stackHash];

};

$samples = [];

$duration = 0;

$loggedStacks = $this->prepareStacks();

foreach ($loggedStacks as $stack) {

$stackFrames = [];

foreach ($stack['trace'] as $frame) {

$absolutePath = $frame['file'];

$lineno = $frame['line'];

$frameKey = "{$absolutePath}:{$lineno}";

$frameIndex = $frameHashMap[$frameKey] ?? null;

if ($frameIndex === null) {

$file = $this->stripPrefixFromFilePath($this->options, $absolutePath);

$module = null;

if (isset($frame['class'], $frame['function'])) {

// Class::method

$function = $frame['class'] . '::' . $frame['function'];

$module = $frame['class'];

} elseif (isset($frame['function'])) {

// {closure}

$function = $frame['function'];

} else {

// /index.php

$function = $file;

}

$frameHashMap[$frameKey] = $frameIndex = \count($frames);

$frames[] = [

'filename' => $file,

'abs_path' => $absolutePath,

'module' => $module,

'function' => $function,

'lineno' => $lineno,

];

}

$stackFrames[] = $frameIndex;

}

$stackId = $registerStack($stackFrames);

$duration = $stack['timestamp'];

$samples[] = [

'stack_id' => $stackId,

'thread_id' => self::THREAD_ID,

'elapsed_since_start_ns' => (int) round($duration * 1e+9),

];

}

if (!$this->validateMaxDuration((float) $duration)) {

$this->logger->warning(\sprintf('The profile is %ss which is longer than the allowed %ss, the profile will be discarded.', (float) $duration, self::MAX_PROFILE_DURATION));

return null;

}

$startTime = \DateTime::createFromFormat('U.u', number_format($this->startTimeStamp, 4, '.', ''), new \DateTimeZone('UTC'));

if ($startTime === false) {

$this->logger->warning(\sprintf('The start time (%s) of the profile is not valid, the profile will be discarded.', $this->startTimeStamp));

return null;

}

return [

'device' => [

'architecture' => $osContext->getMachineType(),

'event_id' => $this->eventId ? (string) $this->eventId : SentryUid::generate(),

'os' => [

'name' => $osContext->getName(),

'version' => $osContext->getVersion(),

'build_number' => $osContext->getBuild() ?? '',

'platform' => 'php',

'release' => $event->getRelease() ?? '',

'environment' => $event->getEnvironment() ?? Event::DEFAULT_ENVIRONMENT,

'runtime' => [

'name' => $runtimeContext->getName(),

'sapi' => $runtimeContext->getSAPI(),

'version' => $runtimeContext->getVersion(),

'timestamp' => $startTime->format(\DATE_RFC3339_EXTENDED),

'transaction' => [

'id' => (string) $event->getId(),

'name' => $event->getTransaction(),

'trace_id' => $event->getTraceId(),

'active_thread_id' => self::THREAD_ID,

'version' => self::VERSION,

'profile' => [

'frames' => $frames,

'samples' => $samples,

'stacks' => $stacks,

];

}

/**

* This method is mainly used to be able to mock the ExcimerLog class in the tests.

* @return array<int, ExcimerLogStackEntry>

private function prepareStacks(): array

{

$stacks = [];

foreach ($this->excimerLog as $stack) {

if ($stack instanceof \ExcimerLogEntry) {

$stacks[] = [

'trace' => $stack->getTrace(),

'timestamp' => $stack->getTimestamp(),

];

} else {

/** @var ExcimerLogStackEntry $stack */

$stacks[] = $stack;

}

return $stacks;

}

private function validateExcimerLog(): bool

{

if (\is_array($this->excimerLog)) {

$sampleCount = \count($this->excimerLog);

} else {

$sampleCount = $this->excimerLog->count();

}

return $sampleCount >= self::MIN_SAMPLE_COUNT;

}

private function validateMaxDuration(float $duration): bool

{

if ($duration > self::MAX_PROFILE_DURATION) {

return false;

}

return true;

}

/**

* @phpstan-assert-if-true OsContext $osContext

* @phpstan-assert-if-true !null $osContext->getVersion()

* @phpstan-assert-if-true !null $osContext->getMachineType()

private function validateOsContext(?OsContext $osContext): bool

{

if ($osContext === null) {

return false;

}

if ($osContext->getVersion() === null) {

return false;

}

if ($osContext->getMachineType() === null) {

return false;

}

return true;

}

/**

* @phpstan-assert-if-true RuntimeContext $runtimeContext

* @phpstan-assert-if-true !null $runtimeContext->getVersion()

private function validateRuntimeContext(?RuntimeContext $runtimeContext): bool

{

if ($runtimeContext === null) {

return false;

}

if ($runtimeContext->getVersion() === null) {

return false;

}

return true;

}

/**

* @phpstan-assert-if-true !null $event->getTransaction()

* @phpstan-assert-if-true !null $event->getTraceId()

private function validateEvent(Event $event): bool

{

if ($event->getTransaction() === null) {

return false;

}

if ($event->getTraceId() === null) {

return false;

}

return true;

}

sentry-php/src/Profiling/Profile.php at source-frame-cache · getsentry/sentry-php · GitHub

Uh oh!

Uh oh!

sentry-php/src/Profiling/Profile.php at source-frame-cache · getsentry/sentry-php · GitHub

Uh oh!

Uh oh!

Expand file tree

Breadcrumbs

Profile.php

Latest commit

History

Breadcrumbs

Profile.php

File metadata and controls