Skip to content

Add a 'stdlog' log type. #54146

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
jum wants to merge 2 commits into
base: master
Choose a base branch
from
+78 −1
Open

Add a 'stdlog' log type. #54146

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
04e7cab
Add a 'stdlog' log type.
jum Jul 29, 2025
60fe227
Add traceparent support.
jum Dec 29, 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
3 changes: 2 additions & 1 deletion lib/private/Log/LogFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?php

/**
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
Expand All @@ -26,6 +25,7 @@ public function __construct(
public function get(string $type):IWriter {
return match (strtolower($type)) {
'errorlog' => new Errorlog($this->systemConfig),
'stdlog' => new Stdlog($this->systemConfig),
'syslog' => $this->c->resolve(Syslog::class),
'systemd' => $this->c->resolve(Systemdlog::class),
'file' => $this->buildLogFile(),
Expand All @@ -36,6 +36,7 @@ public function get(string $type):IWriter {
protected function createNewLogger(string $type, string $tag, string $path): IWriter {
return match (strtolower($type)) {
'errorlog' => new Errorlog($this->systemConfig, $tag),
'stdlog' => new Stdlog($this->systemConfig, $tag),
'syslog' => new Syslog($this->systemConfig, $tag),
'systemd' => new Systemdlog($this->systemConfig, $tag),
default => $this->buildLogFile($path),
Expand Down
76 changes: 76 additions & 0 deletions lib/private/Log/Stdlog.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php

declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Log;

use OC\SystemConfig;
use OCP\Log\IWriter;

class Stdlog extends LogDetails implements IWriter {
public function __construct(
SystemConfig $config,
protected string $tag = 'nextcloud',
) {
parent::__construct($config);
}

/**
* Write a message in the log
*
* @param string|array $message
*/
public function write(string $app, $message, int $level): void {
$detailsJson = $this->logDetailsAsJSON($app, $message, $level);
$details = json_decode($detailsJson, true);

if (json_last_error() !== JSON_ERROR_NONE || !is_array($details)) {
return;
}

$logEntry = array_merge([
'tag' => $this->tag,
'app' => $app,
'level' => $level,
], $details);
$traceparent = $_SERVER['HTTP_TRACEPARENT'];
if (preg_match('/^00-([0-9a-f]{32})-([0-9a-f]{16})-([0-9a-f]{2})$/', $traceparent, $matches)) {
$gcp = getenv('GOOGLE_CLOUD_PROJECT');
if (!empty($gcp)) {
$logEntry['logging.googleapis.com/trace'] = 'projects/' . $gcp . '/traces/' . $matches[1];
$logEntry['logging.googleapis.com/spanId'] = $matches[2];
} else {
$logEntry['traceId'] = $matches[1];
$logEntry['spanId'] = $matches[2];
}
}
// Check if 'message' field exists and is a string
if (isset($logEntry['message']) && is_string($logEntry['message'])) {
$msg = $logEntry['message'];

if (strlen($msg) > 0 && $msg[0] === '{') {
// Try decoding JSON
$decoded = json_decode($msg, true);

if (json_last_error() === JSON_ERROR_NONE && is_array($decoded)) {
// Remove original 'message' field
unset($logEntry['message']);

// Flatten decoded JSON into top-level logEntry
// This will overwrite existing keys if there are
// conflicts
$logEntry = array_merge($logEntry, $decoded);
}
}
}

$json = json_encode($logEntry, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);

if ($json !== false) {
file_put_contents('php://stderr', $json . PHP_EOL);
}
}
}