|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +/** |
| 6 | + * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors |
| 7 | + * SPDX-License-Identifier: AGPL-3.0-or-later |
| 8 | + */ |
| 9 | + |
| 10 | +namespace OCA\Files_Sharing\OpenMetrics; |
| 11 | + |
| 12 | +use Generator; |
| 13 | +use OCP\DB\QueryBuilder\IQueryBuilder; |
| 14 | +use OCP\IDBConnection; |
| 15 | +use OCP\OpenMetrics\IMetricFamily; |
| 16 | +use OCP\OpenMetrics\Metric; |
| 17 | +use OCP\OpenMetrics\MetricType; |
| 18 | +use OCP\Share\IShare; |
| 19 | +use Override; |
| 20 | + |
| 21 | +/** |
| 22 | + * Count shares by type |
| 23 | + * @since 33.0.0 |
| 24 | + */ |
| 25 | +class SharesCountMetric implements IMetricFamily { |
| 26 | + public function __construct( |
| 27 | + private IDBConnection $connection, |
| 28 | + ) { |
| 29 | + } |
| 30 | + |
| 31 | + #[Override] |
| 32 | + public function name(): string { |
| 33 | + return 'shares'; |
| 34 | + } |
| 35 | + |
| 36 | + #[Override] |
| 37 | + public function type(): MetricType { |
| 38 | + return MetricType::gauge; |
| 39 | + } |
| 40 | + |
| 41 | + #[Override] |
| 42 | + public function unit(): string { |
| 43 | + return 'shares'; |
| 44 | + } |
| 45 | + |
| 46 | + #[Override] |
| 47 | + public function help(): string { |
| 48 | + return 'Number of shares by type'; |
| 49 | + } |
| 50 | + |
| 51 | + #[Override] |
| 52 | + public function metrics(): Generator { |
| 53 | + $types = [ |
| 54 | + IShare::TYPE_USER => 'user', |
| 55 | + IShare::TYPE_GROUP => 'group', |
| 56 | + IShare::TYPE_LINK => 'link', |
| 57 | + IShare::TYPE_EMAIL => 'email', |
| 58 | + ]; |
| 59 | + $qb = $this->connection->getQueryBuilder(); |
| 60 | + $result = $qb->select($qb->func()->count('*', 'count'), 'share_type') |
| 61 | + ->from('share') |
| 62 | + ->where($qb->expr()->in('share_type', $qb->createNamedParameter(array_keys($types), IQueryBuilder::PARAM_INT_ARRAY))) |
| 63 | + ->groupBy('share_type') |
| 64 | + ->executeQuery(); |
| 65 | + |
| 66 | + if ($result->rowCount() === 0) { |
| 67 | + yield new Metric(0); |
| 68 | + return; |
| 69 | + } |
| 70 | + |
| 71 | + foreach ($result->iterateAssociative() as $row) { |
| 72 | + yield new Metric($row['count'], ['type' => $types[$row['share_type']]]); |
| 73 | + } |
| 74 | + } |
| 75 | +} |
0 commit comments