opensourcemirror
/
nextcloud-news
mirror of https://github.com/nextcloud/news.git
1
0
Fork 0
Code Issues Releases Wiki Activity

added --check-elapsed command line option, to prevent existing scripts from breaking

This commit is contained in:
mortee 2024-02-16 12:42:33 +01:00 committed by Benjamin Brahmer
parent 9ee51e0c5b
commit 540b7db34e
2 changed files with 35 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/troubleshooting.md
View File

@ -73,6 +73,18 @@ Checking update Status
Last Execution was 2023-03-20 12:20:03 UTC
```
The same check that is done in the News admin settings can be done using occ too.
Adding the --check-elapsed option displays the time elapsed since the last execution,
and if it's considered too long ago, a message will be displayed, and the command returns
with exit code 2. This can be used in scripts to send an alert for example.
```bash
sudo -u www-data php ./occ news:updater:job --check-elapsed
Checking update Status
Last Execution was 2023-03-20 12:20:03 UTC
8 hours, 21 minutes, 20 seconds ago
Something is wrong with the news cronjob, execution delay exceeded the configured interval.
```
If you think the job is stuck you can reset it, this may lead to issues if the job is currently running!
```bash

35
lib/Command/Updater/Job.php
View File

@ -57,12 +57,19 @@ class Job extends Command
InputOption::VALUE_NONE,
'If the job should be reset, warning this might lead to issues.'
)
->addOption(
'check-elapsed',
null,
InputOption::VALUE_NONE,
'Check if the last job execution was too long ago. Return exit code 2 if so.'
)
->setDescription('Console API for checking the update job status and to reset it.');
}
protected function execute(InputInterface $input, OutputInterface $output): int
{
$reset = (bool) $input->getOption('reset');
$checkElapsed = (bool) $input->getOption('check-elapsed');
[$major, $minor, $micro] = Util::getVersion();
@ -75,8 +82,10 @@ class Job extends Command
$date->setTimestamp($this->statusService->getUpdateTime());
$now = new DateTime('now');
$elapsedInterval = $now->diff($date);
$output->writeln("Last Execution was ".$date->format('Y-m-d H:i:s e').
$elapsedInterval->format("; %h hours, %i minutes, %s seconds ago"));
$output->writeln("Last Execution was ".$date->format('Y-m-d H:i:s e'));
if ($checkElapsed) {
$output->writeln($elapsedInterval->format('%h hours, %i minutes, %s seconds ago'));
}
if ($reset) {
$output->writeln("Attempting to reset the job.");
@ -85,16 +94,18 @@ class Job extends Command
return 0;
}
$updateInterval = $this->config->getAppValue(
Application::NAME,
'updateInterval',
Application::DEFAULT_SETTINGS['updateInterval']
);
$threshold = ($updateInterval * 2) + 900;
$elapsedSeconds = $now->getTimestamp() - $date->getTimestamp();
if ($elapsedSeconds > $threshold) {
$output->writeln("Something is wrong with the news cronjob, execution delay exceeded the configured interval.");
return 2;
if ($checkElapsed) {
$updateInterval = $this->config->getAppValue(
Application::NAME,
'updateInterval',
Application::DEFAULT_SETTINGS['updateInterval']
);
$threshold = ($updateInterval * 2) + 900;
$elapsedSeconds = $now->getTimestamp() - $date->getTimestamp();
if ($elapsedSeconds > $threshold) {
$output->writeln("Something is wrong with the news cronjob, execution delay exceeded the configured interval.");
return 2;
}
}
return 0;