Skip to content

Allow to configuring the date format for console output in watchdog:s… #6253

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

Open
wants to merge 3 commits into
base: 13.x
Choose a base branch
from
Open

Allow to configuring the date format for console output in watchdog:s… #6253

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1141405
Allow to configuring the date format for console output in watchdog:s…
MaximeLemolt Mar 20, 2025
a7fce11
Fix date format option naming in watchdog:show command
MaximeLemolt Apr 23, 2025
9018fc3
Allow to configuring the date format for console output in watchdog:l…
MaximeLemolt Apr 23, 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
25 changes: 16 additions & 9 deletions src/Commands/core/WatchdogCommands.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ final class WatchdogCommands extends DrushCommands
const DELETE = 'watchdog:delete';
const SHOW_ONE = 'watchdog:show-one';

const DEFAULT_DATE_FORMAT = 'd/M H:i';

public function __construct(protected Connection $connection)
{
}
Expand All @@ -47,6 +49,7 @@ public function __construct(protected Connection $connection)
#[CLI\Option(name: 'severity-min', description: 'Restrict to messages of a given severity level and higher.')]
#[CLI\Option(name: 'type', description: 'Restrict to messages of a given type.')]
#[CLI\Option(name: 'extended', description: 'Return extended information about each message.')]
#[CLI\Option(name: 'date-format', description: 'Specify a date format for the date console output.')]
#[CLI\Usage(name: 'drush watchdog:show', description: 'Show a listing of most recent 10 messages.')]
#[CLI\Usage(name: 'drush watchdog:show "cron run successful"', description: 'Show a listing of most recent 10 messages containing the string <info>cron run successful</info>.')]
#[CLI\Usage(name: 'drush watchdog:show --count=46', description: 'Show a listing of most recent 46 messages.')]
Expand All @@ -70,7 +73,7 @@ public function __construct(protected Connection $connection)
#[CLI\DefaultTableFields(fields: ['wid', 'date', 'type', 'severity', 'message'])]
#[CLI\Complete(method_name_or_callable: 'watchdogComplete')]
#[CLI\Bootstrap(level: DrupalBootLevels::FULL)]
public function show($substring = '', $options = ['format' => 'table', 'count' => 10, 'severity' => self::REQ, 'severity-min' => self::REQ, 'type' => self::REQ, 'extended' => false]): ?RowsOfFields
public function show($substring = '', $options = ['format' => 'table', 'count' => 10, 'severity' => self::REQ, 'severity-min' => self::REQ, 'type' => self::REQ, 'extended' => false, 'date-format' => self::DEFAULT_DATE_FORMAT]): ?RowsOfFields
{
$where = $this->where((string)$options['type'], $options['severity'], $substring, 'AND', $options['severity-min']);
$query = $this->connection->select('watchdog', 'w')
Expand All @@ -82,7 +85,7 @@ public function show($substring = '', $options = ['format' => 'table', 'count' =
}
$rsc = $query->execute();
while ($result = $rsc->fetchObject()) {
$row = $this->formatResult($result, $options['extended']);
$row = $this->formatResult($result, $options['extended'], $options['date-format']);
$table[$row->wid] = (array)$row;
}
if (empty($table)) {
Expand All @@ -102,6 +105,7 @@ public function show($substring = '', $options = ['format' => 'table', 'count' =
#[CLI\Option(name: 'severity', description: 'Restrict to messages of a given severity level (numeric or string).')]
#[CLI\Option(name: 'type', description: 'Restrict to messages of a given type.')]
#[CLI\Option(name: 'extended', description: 'Return extended information about each message.')]
#[CLI\Option(name: 'date-format', description: 'Specify a date format for the date console output.')]
#[CLI\Usage(name: 'drush watchdog:list', description: 'Prompt for message type or severity, then run watchdog:show.')]
#[CLI\FieldLabels(labels: [
'wid' => 'ID',
Expand All @@ -118,7 +122,7 @@ public function show($substring = '', $options = ['format' => 'table', 'count' =
#[CLI\DefaultTableFields(fields: ['wid', 'date', 'type', 'severity', 'message'])]
#[CLI\Complete(method_name_or_callable: 'watchdogComplete')]
#[CLI\Bootstrap(level: DrupalBootLevels::FULL)]
public function watchdogList($substring = '', $options = ['format' => 'table', 'count' => 10, 'extended' => false]): ?RowsOfFields
public function watchdogList($substring = '', $options = ['format' => 'table', 'count' => 10, 'extended' => false, 'date-format' => self::DEFAULT_DATE_FORMAT]): ?RowsOfFields
{
$options['severity-min'] = null;
return $this->show($substring, $options);
Expand Down Expand Up @@ -147,8 +151,8 @@ public function tail(OutputInterface $output, $substring = '', $options = ['seve
$where = $this->where($options['type'], $options['severity'], $substring, 'AND', $options['severity-min']);
if (empty($where['where'])) {
$where = [
'where' => 'wid > :wid',
'args' => [],
'where' => 'wid > :wid',
'args' => [],
];
} else {
$where['where'] .= " AND wid > :wid";
Expand Down Expand Up @@ -257,9 +261,10 @@ public function delete($substring = '', $options = ['severity' => self::REQ, 'ty
*/
#[CLI\Command(name: self::SHOW_ONE, aliases: ['wd-one', 'watchdog-show-one'])]
#[CLI\Argument(name: 'id', description: 'Watchdog Id')]
#[CLI\Option(name: 'date-format', description: 'Specify a date format for the date console output.')]
#[CLI\ValidateModulesEnabled(modules: ['dblog'])]
#[CLI\Bootstrap(level: DrupalBootLevels::FULL)]
public function showOne($id, $options = ['format' => 'yaml']): PropertyList
public function showOne($id, $options = ['format' => 'yaml', 'date-format' => self::DEFAULT_DATE_FORMAT]): PropertyList
{
$rsc = $this->connection->select('watchdog', 'w')
->fields('w')
Expand All @@ -270,7 +275,7 @@ public function showOne($id, $options = ['format' => 'yaml']): PropertyList
if (!$result) {
throw new \Exception(dt('Watchdog message #!wid not found.', ['!wid' => $id]));
}
return new PropertyList($this->formatResult($result, true));
return new PropertyList($this->formatResult($result, true, $options['date-format']));
}

/**
Expand Down Expand Up @@ -349,17 +354,19 @@ protected function where(?string $type = null, $severity = null, ?string $filter
* A database result object.
* @param $extended
* Return extended message details.
* @param $date_format
* Specific date format for the date console output.
* @return \stdClass
* The result object with some attributes themed.
*/
protected function formatResult(\stdClass $result, bool $extended = false): \stdClass
protected function formatResult(\stdClass $result, bool $extended = false, string $date_format = self::DEFAULT_DATE_FORMAT): \stdClass
{
// Severity.
$severities = RfcLogLevel::getLevels();
$result->severity = trim(DrupalUtil::drushRender($severities[$result->severity]));

// Date.
$result->date = date('d/M H:i', (int)$result->timestamp);
$result->date = date($date_format, (int)$result->timestamp);
unset($result->timestamp);

// Username.
Expand Down