Skip to content
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.

Sign up for GitHub

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

Cron monitoring improvements #677

Merged
merged 2 commits into from
Jun 29, 2023
Merged

Cron monitoring improvements #677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7301039
Allow automatic slug creation for cron monitoring
stayallive Apr 5, 2023
ef78e91
Update code with latest upstream changes
stayallive Jun 23, 2023
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
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"require": {
"php": "^7.2 | ^8.0",
"illuminate/support": "^6.0 | ^7.0 | ^8.0 | ^9.0 | ^10.0",
"sentry/sentry": "^3.19",
"sentry/sentry": "^3.20",
"sentry/sdk": "^3.4",
"symfony/psr-http-message-bridge": "^1.0 | ^2.0",
"nyholm/psr7": "^1.0"
Expand Down
93 changes: 72 additions & 21 deletions src/Sentry/Laravel/Features/ConsoleIntegration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@

namespace Sentry\Laravel\Features;

use Illuminate\Console\Application as ConsoleApplication;
use Illuminate\Console\Scheduling\Event as SchedulingEvent;
use Illuminate\Contracts\Cache\Factory as Cache;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Str;
use RuntimeException;
use Sentry\CheckIn;
use Sentry\CheckInStatus;
use Sentry\Event as SentryEvent;
use Sentry\MonitorConfig;
use Sentry\MonitorSchedule;
use Sentry\SentrySdk;

class ConsoleIntegration extends Feature
Expand All @@ -31,65 +36,94 @@ public function setup(Cache $cache): void
{
$this->cache = $cache;

$startCheckIn = function (string $mutex, string $slug, bool $useCache, int $useCacheTtlInMinutes) {
$this->startCheckIn($mutex, $slug, $useCache, $useCacheTtlInMinutes);
$startCheckIn = function (?string $slug, SchedulingEvent $scheduled, ?int $checkInMargin, ?int $maxRuntime, bool $updateMonitorConfig) {
$this->startCheckIn($slug, $scheduled, $checkInMargin, $maxRuntime, $updateMonitorConfig);
};
$finishCheckIn = function (string $mutex, string $slug, CheckInStatus $status, bool $useCache) {
$this->finishCheckIn($mutex, $slug, $status, $useCache);
$finishCheckIn = function (?string $slug, SchedulingEvent $scheduled, CheckInStatus $status) {
$this->finishCheckIn($slug, $scheduled, $status);
};

SchedulingEvent::macro('sentryMonitor', function (string $monitorSlug) use ($startCheckIn, $finishCheckIn) {
SchedulingEvent::macro('sentryMonitor', function (
?string $monitorSlug = null,
?int $checkInMargin = null,
?int $maxRuntime = null,
bool $updateMonitorConfig = true
) use ($startCheckIn, $finishCheckIn) {
/** @var SchedulingEvent $this */
if ($monitorSlug === null && $this->command === null) {
throw new RuntimeException('The command string is null, please set a slug manually for this scheduled command using the `sentryMonitor(\'your-monitor-slug\')` macro.');
}

return $this
->before(function () use ($startCheckIn, $monitorSlug) {
->before(function () use ($startCheckIn, $monitorSlug, $checkInMargin, $maxRuntime, $updateMonitorConfig) {
/** @var SchedulingEvent $this */
$startCheckIn($this->mutexName(), $monitorSlug, $this->runInBackground, $this->expiresAt);
$startCheckIn($monitorSlug, $this, $checkInMargin, $maxRuntime, $updateMonitorConfig);
})
->onSuccess(function () use ($finishCheckIn, $monitorSlug) {
/** @var SchedulingEvent $this */
$finishCheckIn($this->mutexName(), $monitorSlug, CheckInStatus::ok(), $this->runInBackground);
$finishCheckIn($monitorSlug, $this, CheckInStatus::ok());
})
->onFailure(function () use ($finishCheckIn, $monitorSlug) {
/** @var SchedulingEvent $this */
$finishCheckIn($this->mutexName(), $monitorSlug, CheckInStatus::error(), $this->runInBackground);
$finishCheckIn($monitorSlug, $this, CheckInStatus::error());
});
});
}

public function setupInactive(): void
{
SchedulingEvent::macro('sentryMonitor', function (string $monitorSlug) {
// When there is no Sentry DSN set there is nothing for us to do, but we still want to allow the user to setup the macro
// This is an exact copy of the macro above, but without doing anything so that even when no DSN is configured the user can still use the macro
SchedulingEvent::macro('sentryMonitor', function (
?string $monitorSlug = null,
?int $checkInMargin = null,
?int $maxRuntime = null,
bool $updateMonitorConfig = true
) {
return $this;
});
}

private function startCheckIn(string $mutex, string $slug, bool $useCache, int $useCacheTtlInMinutes): void
private function startCheckIn(?string $slug, SchedulingEvent $scheduled, ?int $checkInMargin, ?int $maxRuntime, bool $updateMonitorConfig): void
{
$checkIn = $this->createCheckIn($slug, CheckInStatus::inProgress());
$checkInSlug = $slug ?? $this->makeSlugForScheduled($scheduled);

$checkIn = $this->createCheckIn($checkInSlug, CheckInStatus::inProgress());

$cacheKey = $this->buildCacheKey($mutex, $slug);
if ($updateMonitorConfig || $slug === null) {
$checkIn->setMonitorConfig(new MonitorConfig(
MonitorSchedule::crontab($scheduled->getExpression()),
$checkInMargin,
$maxRuntime,
$scheduled->timezone
));
}

$cacheKey = $this->buildCacheKey($scheduled->mutexName(), $checkInSlug);

$this->checkInStore[$cacheKey] = $checkIn;

if ($useCache) {
$this->cache->store()->put($cacheKey, $checkIn->getId(), $useCacheTtlInMinutes * 60);
if ($scheduled->runInBackground) {
$this->cache->store()->put($cacheKey, $checkIn->getId(), $scheduled->expiresAt * 60);
}

$this->sendCheckIn($checkIn);
}

private function finishCheckIn(string $mutex, string $slug, CheckInStatus $status, bool $useCache): void
private function finishCheckIn(?string $slug, SchedulingEvent $scheduled, CheckInStatus $status): void
{
$cacheKey = $this->buildCacheKey($mutex, $slug);
$mutex = $scheduled->mutexName();

$checkInSlug = $slug ?? $this->makeSlugForScheduled($scheduled);

$cacheKey = $this->buildCacheKey($mutex, $checkInSlug);

$checkIn = $this->checkInStore[$cacheKey] ?? null;

if ($checkIn === null && $useCache) {
if ($checkIn === null && $scheduled->runInBackground) {
$checkInId = $this->cache->store()->get($cacheKey);

if ($checkInId !== null) {
$checkIn = $this->createCheckIn($slug, $status, $checkInId);
$checkIn = $this->createCheckIn($checkInSlug, $status, $checkInId);
}
}

Expand All @@ -101,7 +135,7 @@ private function finishCheckIn(string $mutex, string $slug, CheckInStatus $statu
// We don't need to keep the checkIn ID stored since we finished executing the command
unset($this->checkInStore[$mutex]);

if ($useCache) {
if ($scheduled->runInBackground) {
$this->cache->store()->forget($cacheKey);
}

Expand Down Expand Up @@ -136,4 +170,21 @@ private function buildCacheKey(string $mutex, string $slug): string
// We use the mutex name as part of the cache key to avoid collisions between the same commands with the same schedule but with different slugs
return 'sentry:checkIn:' . sha1("{$mutex}:{$slug}");
}

private function makeSlugForScheduled(SchedulingEvent $scheduled): string
{
$generatedSlug = Str::slug(
Str::replace(
// `:` is commonly used in the command name, so we replace it with `-` to avoid it being stripped out by the slug function
':',
'-',
trim(
// The command string always starts with the PHP binary, so we remove it since it's not relevant to the slug
Str::after($scheduled->command, ConsoleApplication::phpBinary())
)
)
);

return "scheduled_{$generatedSlug}";
}
}