Skip to content

feat(openmetrics): export more resilient if exception happens #60501

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
Altahrim merged 1 commit into from
May 20, 2026
+15 −13
Merged

feat(openmetrics): export more resilient if exception happens #60501

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 15 additions & 13 deletions core/Controller/OpenMetricsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
Expand Down Expand Up @@ -51,13 +52,9 @@ public function export(): Response {
return new Response(Http::STATUS_FORBIDDEN);
}

return new StreamTraversableResponse(
$this->generate(),
Http::STATUS_OK,
[
'Content-Type' => 'application/openmetrics-text; version=1.0.0; charset=utf-8',
]
);
return new StreamTraversableResponse($this->generate(), Http::STATUS_OK, [
'Content-Type' => 'application/openmetrics-text; version=1.0.0; charset=utf-8',
]);
}

private function isRemoteAddressAllowed(): bool {
Expand All @@ -80,7 +77,16 @@ private function isRemoteAddressAllowed(): bool {

private function generate(): \Generator {
foreach ($this->exporterManager->export() as $family) {
yield $this->formatFamily($family);
try {
yield $this->formatFamily($family);
} catch (\Exception $e) {
// Skip family and return a valid result
$this->logger->error('Exception caught when exporting family {family}', [
'app' => 'metrics',
'family' => $family->name(),
'exception' => $e,
]);
}
}

$elapsed = (string)(microtime(true) - $_SERVER['REQUEST_TIME_FLOAT']);
Expand Down Expand Up @@ -131,11 +137,7 @@ private function formatLabels(Metric $metric): string {
}

private function escapeString(string $string): string {
return json_encode(
$string,
JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_THROW_ON_ERROR,
1
);
return json_encode($string, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_THROW_ON_ERROR, 1);
}

private function formatValue(Metric $metric): string {
Expand Down
Loading