nextcloud/lib/private/OpenMetrics/Exporters/Maintenance.php
Benjamin Gaussorgues c57c4843e8
feat(openmetrics): introduce OpenMetrics exporter
Expose a `/metrics` endpoint with some basic metrics

Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
2026-01-07 09:38:13 +01:00

50 lines
935 B
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\OpenMetrics\Exporters;
use Generator;
use OC\SystemConfig;
use OCP\OpenMetrics\IMetricFamily;
use OCP\OpenMetrics\Metric;
use OCP\OpenMetrics\MetricType;
use OCP\Server;
use Override;
/**
* Export maintenance state
*/
class Maintenance implements IMetricFamily {
public function name(): string {
return 'maintenance';
}
#[Override]
public function type(): MetricType {
return MetricType::info;
}
#[Override]
public function unit(): string {
return '';
}
#[Override]
public function help(): string {
return 'Maintenance status of Nextcloud';
}
#[Override]
public function metrics(): Generator {
$systemConfig = Server::get(SystemConfig::class);
yield new Metric(
(bool)$systemConfig->getValue('maintenance', false)
);
}
}