Skip to content

manage logs for processed and failed messages #30

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

Merged
arhimede merged 2 commits into from
Jul 22, 2025
Merged

manage logs for processed and failed messages #30

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
a8870e4
manage logs for processed and failed messages
SergiuBota1 Jul 22, 2025
0c876f6
fail-safe key explanation in config
SergiuBota1 Jul 22, 2025
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
12 changes: 8 additions & 4 deletions config/autoload/cli.global.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
declare(strict_types=1);

use Dot\Cli\FileLockerInterface;
use Queue\Swoole\Command\GetFailedMessagesCommand;
use Queue\Swoole\Command\GetProcessedMessagesCommand;
use Queue\Swoole\Command\StartCommand;
use Queue\Swoole\Command\StopCommand;
use Symfony\Component\Messenger\Command\ConsumeMessagesCommand;
Expand All @@ -13,10 +15,12 @@
'version' => '1.0.0',
'name' => 'DotKernel CLI',
'commands' => [
"swoole:start" => StartCommand::class,
"swoole:stop" => StopCommand::class,
"messenger:start" => ConsumeMessagesCommand::class,
"messenger:debug" => DebugCommand::class,
"swoole:start" => StartCommand::class,
"swoole:stop" => StopCommand::class,
"messenger:start" => ConsumeMessagesCommand::class,
"messenger:debug" => DebugCommand::class,
"messenger:processed" => GetProcessedMessagesCommand::class,
"messenger:failed" => GetFailedMessagesCommand::class,
],
],
FileLockerInterface::class => [
Expand Down
6 changes: 6 additions & 0 deletions config/autoload/local.php.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,10 @@ return [
'eof' => "\n",
],
],
//delay time until the message is added back to the queue if an error occurs during processing
'fail-safe' => [
Copy link
Member

@arhimede arhimede Jul 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add some comment what is this

Copy link
Member

@arhimede arhimede Jul 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what are those ? seconds or miliseconds ?

Copy link
Member Author

@SergiuBota1 SergiuBota1 Jul 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Milliseconds

'first_retry' => 3600000, // 1h
'second_retry' => 43200000, // 12h
'third_retry' => 86400000, // 24h
],
];
43 changes: 42 additions & 1 deletion src/App/Message/ExampleMessageHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,62 @@

use Dot\DependencyInjection\Attribute\Inject;
use Dot\Log\Logger;
use Symfony\Component\Messenger\Exception\ExceptionInterface;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Messenger\Stamp\DelayStamp;

class ExampleMessageHandler
{
#[Inject(
MessageBusInterface::class,
'dot-log.queue-log',
'config',
)]
public function __construct(
protected MessageBusInterface $bus,
protected Logger $logger,
protected array $config,
) {
}

public function __invoke(ExampleMessage $message): void
{
$this->logger->info("message: " . $message->getPayload()['foo']);
try {
// Throwing an exception to satisfy PHPStan (replace with own code)
throw new \Exception("Failed to execute");
} catch (\Throwable $exception) {
$payload = $message->getPayload();
$this->logger->error($payload['foo'] . ' failed with message: '
. $exception->getMessage() . ' after ' . ($payload['retry'] ?? 0) . ' retries');
$this->retry($payload);
}
}

/**
* @throws ExceptionInterface
*/
public function retry(array $payload): void
{
if (! isset($payload['retry'])) {
$this->bus->dispatch(new ExampleMessage(["foo" => $payload['foo'], 'retry' => 1]), [
new DelayStamp($this->config['fail-safe']['first_retry']),
]);
} else {
$retry = $payload['retry'];
switch ($retry) {
case 1:
$delay = $this->config['fail-safe']['second_retry'];
$this->bus->dispatch(new ExampleMessage(["foo" => $payload['foo'], 'retry' => ++$retry]), [
new DelayStamp($delay),
]);
break;
case 2:
$delay = $this->config['fail-safe']['third_retry'];
$this->bus->dispatch(new ExampleMessage(["foo" => $payload['foo'], 'retry' => ++$retry]), [
new DelayStamp($delay),
]);
break;
}
}
}
}
95 changes: 95 additions & 0 deletions src/Swoole/Command/GetFailedMessagesCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?php

declare(strict_types=1);

namespace Queue\Swoole\Command;

use Dot\DependencyInjection\Attribute\Inject;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

use function date;
use function file;
use function is_numeric;
use function json_decode;
use function preg_match;
use function strtolower;
use function strtotime;

use const FILE_IGNORE_NEW_LINES;
use const FILE_SKIP_EMPTY_LINES;

#[AsCommand(
name: 'failed',
description: 'Get processing failure messages.',
)]
class GetFailedMessagesCommand extends Command
{
protected static string $defaultName = 'failed';

#[Inject()]
public function __construct()
{
parent::__construct(self::$defaultName);
}

protected function configure(): void
{
$this->setDescription('Get processing failure messages.')
->addOption('start', null, InputOption::VALUE_OPTIONAL, 'Start timestamp (Y-m-d H:i:s)')
->addOption('end', null, InputOption::VALUE_OPTIONAL, 'End timestamp (Y-m-d H:i:s)')
->addOption('limit', null, InputOption::VALUE_OPTIONAL, 'Limit in days');
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
$start = $input->getOption('start');
$end = $input->getOption('end');
$limit = $input->getOption('limit');

if (! $end) {
$end = date('Y-m-d H:i:s');
} elseif (! preg_match('/\d{2}:\d{2}:\d{2}/', $end)) {
$end .= ' 23:59:59';
}

if ($limit && is_numeric($limit) && ! $start) {
$start = date('Y-m-d H:i:s', strtotime("-{$limit} days", strtotime($end)));
} elseif ($start && ! preg_match('/\d{2}:\d{2}:\d{2}/', $start)) {
$start .= ' 00:00:00';
}

$startTimestamp = $start ? strtotime($start) : null;
$endTimestamp = $end ? strtotime($end) : null;

$logPath = 'log/queue-log.log';
$lines = file($logPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($lines as $line) {
$entry = json_decode($line, true);

if (! $entry || ! isset($entry['levelName'], $entry['timestamp'])) {
continue;
}

if (strtolower($entry['levelName']) !== 'error') {
continue;
}

$logTimestamp = strtotime($entry['timestamp']);
if (
($startTimestamp && $logTimestamp < $startTimestamp) ||
($endTimestamp && $logTimestamp > $endTimestamp)
) {
continue;
}

$output->writeln($line);
}

return Command::SUCCESS;
}
}
95 changes: 95 additions & 0 deletions src/Swoole/Command/GetProcessedMessagesCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?php

declare(strict_types=1);

namespace Queue\Swoole\Command;

use Dot\DependencyInjection\Attribute\Inject;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

use function date;
use function file;
use function is_numeric;
use function json_decode;
use function preg_match;
use function strtolower;
use function strtotime;

use const FILE_IGNORE_NEW_LINES;
use const FILE_SKIP_EMPTY_LINES;

#[AsCommand(
name: 'processed',
description: 'Get successfully processed messages',
)]
class GetProcessedMessagesCommand extends Command
{
protected static string $defaultName = 'processed';

#[Inject()]
public function __construct()
{
parent::__construct(self::$defaultName);
}

protected function configure(): void
{
$this->setDescription('Get successfully processed messages')
->addOption('start', null, InputOption::VALUE_OPTIONAL, 'Start timestamp (Y-m-d H:i:s)')
->addOption('end', null, InputOption::VALUE_OPTIONAL, 'End timestamp (Y-m-d H:i:s)')
->addOption('limit', null, InputOption::VALUE_OPTIONAL, 'Limit in days');
}

protected function execute(InputInterface $input, OutputInterface $output): int
{
$start = $input->getOption('start');
$end = $input->getOption('end');
$limit = $input->getOption('limit');

if (! $end) {
$end = date('Y-m-d H:i:s');
} elseif (! preg_match('/\d{2}:\d{2}:\d{2}/', $end)) {
$end .= ' 23:59:59';
}

if ($limit && is_numeric($limit) && ! $start) {
$start = date('Y-m-d H:i:s', strtotime("-{$limit} days", strtotime($end)));
} elseif ($start && ! preg_match('/\d{2}:\d{2}:\d{2}/', $start)) {
$start .= ' 00:00:00';
}

$startTimestamp = $start ? strtotime($start) : null;
$endTimestamp = $end ? strtotime($end) : null;

$logPath = 'log/queue-log.log';
$lines = file($logPath, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($lines as $line) {
$entry = json_decode($line, true);

if (! $entry || ! isset($entry['levelName'], $entry['timestamp'])) {
continue;
}

if (strtolower($entry['levelName']) !== 'info') {
continue;
}

$logTimestamp = strtotime($entry['timestamp']);
if (
($startTimestamp && $logTimestamp < $startTimestamp) ||
($endTimestamp && $logTimestamp > $endTimestamp)
) {
continue;
}

$output->writeln($line);
}

return Command::SUCCESS;
}
}
13 changes: 9 additions & 4 deletions src/Swoole/ConfigProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@

namespace Queue\Swoole;

use Dot\DependencyInjection\Factory\AttributedServiceFactory;
use Queue\Swoole\Command\Factory\StartCommandFactory;
use Queue\Swoole\Command\Factory\StopCommandFactory;
use Queue\Swoole\Command\GetFailedMessagesCommand;
use Queue\Swoole\Command\GetProcessedMessagesCommand;
use Queue\Swoole\Command\StartCommand;
use Queue\Swoole\Command\StopCommand;
use Queue\Swoole\Delegators\TCPServerDelegator;
Expand All @@ -27,10 +30,12 @@ public function getDependencies(): array
TCPSwooleServer::class => [TCPServerDelegator::class],
],
"factories" => [
TCPSwooleServer::class => ServerFactory::class,
PidManager::class => PidManagerFactory::class,
StartCommand::class => StartCommandFactory::class,
StopCommand::class => StopCommandFactory::class,
TCPSwooleServer::class => ServerFactory::class,
PidManager::class => PidManagerFactory::class,
StartCommand::class => StartCommandFactory::class,
StopCommand::class => StopCommandFactory::class,
GetProcessedMessagesCommand::class => AttributedServiceFactory::class,
GetFailedMessagesCommand::class => AttributedServiceFactory::class,
],
"aliases" => [],
];
Expand Down
Loading