Merge pull request #59720 from nextcloud/feature/59718/appinfo-metrics

feat(openmetrics): expose app information per-app

Author: CarlSchwan

lib/composer/composer/autoload_classmap.php

@@ -1950,8 +1950,7 @@
     'OC\\OpenMetrics\\ExporterManager' => $baseDir . '/lib/private/OpenMetrics/ExporterManager.php',
     'OC\\OpenMetrics\\Exporters\\ActiveSessions' => $baseDir . '/lib/private/OpenMetrics/Exporters/ActiveSessions.php',
     'OC\\OpenMetrics\\Exporters\\ActiveUsers' => $baseDir . '/lib/private/OpenMetrics/Exporters/ActiveUsers.php',
-    'OC\\OpenMetrics\\Exporters\\AppsCount' => $baseDir . '/lib/private/OpenMetrics/Exporters/AppsCount.php',
-    'OC\\OpenMetrics\\Exporters\\AppsInfo' => $baseDir . '/lib/private/OpenMetrics/Exporters/AppsInfo.php',
+    'OC\\OpenMetrics\\Exporters\\AppEnabled' => $baseDir . '/lib/private/OpenMetrics/Exporters/AppEnabled.php',
     'OC\\OpenMetrics\\Exporters\\Cached' => $baseDir . '/lib/private/OpenMetrics/Exporters/Cached.php',
     'OC\\OpenMetrics\\Exporters\\FilesByType' => $baseDir . '/lib/private/OpenMetrics/Exporters/FilesByType.php',
     'OC\\OpenMetrics\\Exporters\\InstanceInfo' => $baseDir . '/lib/private/OpenMetrics/Exporters/InstanceInfo.php',

lib/composer/composer/autoload_static.php

@@ -1991,8 +1991,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\OpenMetrics\\ExporterManager' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/ExporterManager.php',
         'OC\\OpenMetrics\\Exporters\\ActiveSessions' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/ActiveSessions.php',
         'OC\\OpenMetrics\\Exporters\\ActiveUsers' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/ActiveUsers.php',
-        'OC\\OpenMetrics\\Exporters\\AppsCount' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/AppsCount.php',
-        'OC\\OpenMetrics\\Exporters\\AppsInfo' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/AppsInfo.php',
+        'OC\\OpenMetrics\\Exporters\\AppEnabled' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/AppEnabled.php',
         'OC\\OpenMetrics\\Exporters\\Cached' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/Cached.php',
         'OC\\OpenMetrics\\Exporters\\FilesByType' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/FilesByType.php',
         'OC\\OpenMetrics\\Exporters\\InstanceInfo' => __DIR__ . '/../../..' . '/lib/private/OpenMetrics/Exporters/InstanceInfo.php',

lib/private/OpenMetrics/ExporterManager.php

@@ -12,8 +12,7 @@
 use Generator;
 use OC\OpenMetrics\Exporters\ActiveSessions;
 use OC\OpenMetrics\Exporters\ActiveUsers;
-use OC\OpenMetrics\Exporters\AppsCount;
-use OC\OpenMetrics\Exporters\AppsInfo;
+use OC\OpenMetrics\Exporters\AppEnabled;
 use OC\OpenMetrics\Exporters\FilesByType;
 use OC\OpenMetrics\Exporters\InstanceInfo;
 use OC\OpenMetrics\Exporters\LogLevel;
@@ -44,8 +43,7 @@ public function export(): Generator {
 		$exporters = [
 			// Basic exporters
 			InstanceInfo::class,
-			AppsInfo::class,
-			AppsCount::class,
+			AppEnabled::class,
 			Maintenance::class,
 			LogLevel::class,
 

…ivate/OpenMetrics/Exporters/AppsInfo.php …ate/OpenMetrics/Exporters/AppEnabled.phplib/private/OpenMetrics/Exporters/AppsInfo.php renamed to lib/private/OpenMetrics/Exporters/AppEnabled.php lib/private/OpenMetrics/Exporters/AppsInfo.php renamed to lib/private/OpenMetrics/Exporters/AppEnabled.php

@@ -17,22 +17,22 @@
 use Override;
 
 /**
- * Export information about enabled applications
+ * Export information about installed applications
  */
-class AppsInfo implements IMetricFamily {
+class AppEnabled implements IMetricFamily {
 	public function __construct(
 		private IAppManager $appManager,
 	) {
 	}
 
 	#[Override]
 	public function name(): string {
-		return 'apps_info';
+		return 'app_enabled';
 	}
 
 	#[Override]
 	public function type(): MetricType {
-		return MetricType::info;
+		return MetricType::gauge;
 	}
 
 	#[Override]
@@ -42,15 +42,15 @@ public function unit(): string {
 
 	#[Override]
 	public function help(): string {
-		return 'Enabled applications in Nextcloud';
+		return 'Information about the installed Nextcloud applications';
 	}
 
 	#[Override]
 	public function metrics(): Generator {
 		$apps = [];
-		foreach ($this->appManager->getAppInstalledVersions(true) as $appId => $version) {
-			$apps[str_replace('-', '_', $appId)] = $version;
+		$enabledApps = $this->appManager->getEnabledApps();
+		foreach ($this->appManager->getAppInstalledVersions(false) as $appId => $version) {
+			yield new Metric(in_array($appId, $enabledApps, true) ? 1 : 0, ['app_id' => $appId, 'version' => $version]);
 		}
-		yield new Metric(1, $apps, time());
 	}
 }

lib/private/OpenMetrics/Exporters/AppsCount.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace Test\OpenMetrics\Exporters;
+
+use OC\OpenMetrics\Exporters\AppEnabled;
+use OCP\App\IAppManager;
+use OCP\OpenMetrics\IMetricFamily;
+use OCP\OpenMetrics\Metric;
+
+class AppEnabledTest extends ExporterTestCase {
+	private IAppManager $appManager;
+	private array $appList = [
+		'appA' => '0.1.2',
+		'appB' => '1.2.3 beta 4',
+		'appC' => '6.2.1',
+		'appD' => '3.141.5',
+	];
+	private array $installedAppsList = [
+		'appA', 'appB', 'appD'
+	];
+
+	protected function getExporter():IMetricFamily {
+		$this->appManager = $this->createMock(IAppManager::class);
+		$this->appManager->method('getAppInstalledVersions')
+			->with(false)
+			->willReturn($this->appList);
+		$this->appManager->method('getEnabledApps')
+			->willReturn($this->installedAppsList);
+
+		return new AppEnabled($this->appManager);
+	}
+
+	public function testMetrics(): void {
+		$this->assertCount(4, $this->metrics);
+		foreach ($this->appList as $appId => $appVersion) {
+			$metricForApp = array_find($this->metrics, function (Metric $metric) use ($appId) {
+				return $metric->label('app_id') === $appId;
+			});
+
+			$expectedMetricValue = in_array($appId, $this->installedAppsList) ? 1 : 0;
+			$this->assertEquals($expectedMetricValue, $metricForApp->value);
+			$this->assertSame(['app_id' => $appId, 'version' => $appVersion], $metricForApp->labels);
+		}
+	}
+}