Reporter

docker-compose.yml

@@ -0,0 +1,16 @@
+services:
+  prometheus:
+    restart: always
+    image: bitnami/prometheus:latest
+    links:
+      - pushgateway
+    volumes:
+      - ./prom.yml:/opt/bitnami/prometheus/conf/prometheus.yml
+    ports:
+      - 9092:9090
+
+  pushgateway:
+    restart: always
+    image: bitnami/pushgateway:latest
+    ports:
+      - 9091:9091

prom.yml

@@ -0,0 +1,11 @@
+global:
+  scrape_interval: 5s
+  scrape_timeout: 2s
+  evaluation_interval: 15s
+
+scrape_configs:
+  - job_name: pushgateway
+    honor_labels: true
+    static_configs:
+      - targets:
+          - 'pushgateway:9091'

src/Application/Linter/Linter.php

@@ -19,9 +19,9 @@
 use ArtARTs36\MergeRequestLinter\Domain\Rule\Rule;
 use ArtARTs36\MergeRequestLinter\Domain\Rule\Rules;
 use ArtARTs36\MergeRequestLinter\Shared\DataStructure\Arrayee;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\IncCounter;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricSubject;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Collector\Counter;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Collector\MetricSubject;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Registry\CollectorRegisterer;
 use ArtARTs36\MergeRequestLinter\Shared\Time\Timer;
 use Psr\EventDispatcher\EventDispatcherInterface;
 
@@ -31,15 +31,15 @@ public function __construct(
         private Rules                    $rules,
         private LinterOptions            $options,
         private EventDispatcherInterface $events,
-        private MetricManager            $metrics,
+        private CollectorRegisterer      $metrics,
     ) {
     }
 
     public function run(MergeRequest $request): LintResult
     {
         $timer = Timer::start();
 
-        $this->addMetricUsedRules();
+        $this->addMetricUsedRules($request);
 
         $this->events->dispatch(new LintStartedEvent($request));
 
@@ -93,15 +93,17 @@ public function run(MergeRequest $request): LintResult
         return $result;
     }
 
-    private function addMetricUsedRules(): void
+    private function addMetricUsedRules(MergeRequest $request): void
     {
-        $this->metrics->add(
-            new MetricSubject(
-                'linter_used_rules',
-                '[Linter] Used rules',
-            ),
-            IncCounter::create($this->rules),
-        );
+        $this
+            ->metrics
+            ->register(new Counter(
+                new MetricSubject('linter', 'used_rules', 'Used rules'),
+                [
+                    'request' => (string) $request->uri,
+                ],
+                $this->rules->count(),
+            ));
     }
 
     /**

src/Application/Linter/LinterFactory.php

@@ -4,14 +4,14 @@
 
 use ArtARTs36\MergeRequestLinter\Domain\Configuration\Config;
 use ArtARTs36\MergeRequestLinter\Domain\Linter\Linter;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Registry\CollectorRegistry;
 use Psr\EventDispatcher\EventDispatcherInterface;
 
 class LinterFactory
 {
     public function __construct(
         private readonly EventDispatcherInterface $events,
-        private readonly MetricManager            $metrics,
+        private readonly CollectorRegistry        $metrics,
     ) {
     }
 

src/Application/Linter/RunnerFactory.php

@@ -22,7 +22,7 @@
 use ArtARTs36\MergeRequestLinter\Infrastructure\RequestFetcher\CiRequestFetcher;
 use ArtARTs36\MergeRequestLinter\Shared\DataStructure\ArrayMap;
 use ArtARTs36\MergeRequestLinter\Shared\DataStructure\Map;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Registry\CollectorRegistry;
 use ArtARTs36\MergeRequestLinter\Shared\Time\Clock;
 
 class RunnerFactory implements LinterRunnerFactory
@@ -31,13 +31,13 @@ class RunnerFactory implements LinterRunnerFactory
      * @param Map<string, class-string<CiSystem>> $ciSystems
      */
     public function __construct(
-        protected Environment   $environment,
-        protected Map           $ciSystems,
-        protected ContextLogger $logger,
-        protected MetricManager $metrics,
-        protected ClientFactory $clientFactory,
-        protected Clock    $clock,
-        protected MapContainer $container = new MapContainer(),
+        protected Environment       $environment,
+        protected Map               $ciSystems,
+        protected ContextLogger     $logger,
+        protected CollectorRegistry $metrics,
+        protected ClientFactory     $clientFactory,
+        protected Clock             $clock,
+        protected MapContainer      $container = new MapContainer(),
     ) {
     }
 

src/Application/Rule/Metrics/RuleLintStateMetricHandler.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Application\Rule\Metrics;
+
+use ArtARTs36\MergeRequestLinter\Domain\Linter\RuleWasFailedEvent;
+use ArtARTs36\MergeRequestLinter\Domain\Linter\RuleWasSuccessfulEvent;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Collector\CounterVector;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Collector\MetricSubject;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Registry\CollectorRegisterer;
+
+class RuleLintStateMetricHandler
+{
+    public function __construct(
+        private readonly CounterVector $counter,
+    ) {
+    }
+
+    public static function make(CollectorRegisterer $registerer): self
+    {
+        $counter = new CounterVector(new MetricSubject(
+            'linter',
+            'rule_lint_state',
+            'Rule lint state',
+        ));
+
+        $registerer->register($counter);
+
+        return new self($counter);
+    }
+
+    public function handle(RuleWasSuccessfulEvent|RuleWasFailedEvent $event): void
+    {
+        if ($event instanceof RuleWasSuccessfulEvent) {
+            $this
+                ->counter
+                ->add([
+                    'rule' => $event->ruleName,
+                    'state' => 'true',
+                ])
+                ->inc();
+
+            return;
+        }
+
+        $this
+            ->counter
+            ->add([
+                'rule' => $event->ruleName,
+                'state' => 'fail',
+            ])
+            ->inc();
+    }
+}

src/Application/Rule/Rules/ConditionRule.php

@@ -5,23 +5,27 @@
 use ArtARTs36\MergeRequestLinter\Domain\Condition\ConditionOperator;
 use ArtARTs36\MergeRequestLinter\Domain\Request\MergeRequest;
 use ArtARTs36\MergeRequestLinter\Domain\Rule\Rule;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\Counter;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\NullCounter;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Collector\CounterVector;
 
 class ConditionRule extends OneRuleDecoratorRule
 {
     public function __construct(
         Rule $rule,
         private readonly ConditionOperator $operator,
-        private readonly Counter $skippedRules = new NullCounter(),
+        private readonly CounterVector $skippedRules,
     ) {
         parent::__construct($rule);
     }
 
     public function lint(MergeRequest $request): array
     {
         if (! $this->operator->check($request)) {
-            $this->skippedRules->inc();
+            $this
+                ->skippedRules
+                ->add([
+                    'rule' => $this->getName(),
+                ])
+                ->inc();
 
             return [];
         }

src/Domain/Configuration/Config.php

@@ -17,12 +17,14 @@
     public const SUBJECT_NOTIFICATIONS = 4;
     public const SUBJECT_LINTER = 5;
     public const SUBJECT_COMMENTS = 6;
+    public const SUBJECT_METRICS = 7;
     public const SUBJECT_ALL = self::SUBJECT_RULES |
         self::SUBJECT_CI_SETTINGS |
         self::SUBJECT_HTTP_CLIENT |
         self::SUBJECT_NOTIFICATIONS |
         self::SUBJECT_LINTER |
-        self::SUBJECT_COMMENTS;
+        self::SUBJECT_COMMENTS |
+        self::SUBJECT_METRICS;
 
     /**
      * @param Map<CiName, CiSettings> $settings
@@ -34,6 +36,7 @@ public function __construct(
         public NotificationsConfig $notifications,
         public LinterConfig        $linter,
         public CommentsConfig      $comments,
+        public MetricsConfig       $metrics,
     ) {
     }
 }

src/Domain/Configuration/MetricsConfig.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Domain\Configuration;
+
+/**
+ * @codeCoverageIgnore
+ */
+readonly class MetricsConfig
+{
+    public function __construct(
+        public MetricsStorageConfig $storage,
+    ) {
+    }
+}

src/Domain/Configuration/MetricsStorageConfig.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Domain\Configuration;
+
+readonly class MetricsStorageConfig
+{
+    public const NAME_PROMETHEUS_PUSH_GATEWAY = 'prometheusPushGateway';
+    public const NAME_NULL = 'null';
+
+    public const NAMES = [
+        self::NAME_PROMETHEUS_PUSH_GATEWAY,
+        self::NAME_NULL,
+    ];
+
+    /**
+     * @param value-of<self::NAMES> $name
+     */
+    public function __construct(
+        public string $name,
+        public string $address,
+    ) {
+    }
+}

src/Infrastructure/Configuration/Loader/ArrayConfigLoaderFactory.php

@@ -35,9 +35,9 @@
 use ArtARTs36\MergeRequestLinter\Infrastructure\Rule\Factories\RuleFactory;
 use ArtARTs36\MergeRequestLinter\Infrastructure\Rule\Resolver;
 use ArtARTs36\MergeRequestLinter\Infrastructure\Text\Decoder\DecoderFactory;
-use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
-use ArtARTs36\MergeRequestLinter\Shared\Reflection\ParameterMapBuilder;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Registry\CollectorRegistry;
 use ArtARTs36\MergeRequestLinter\Shared\Reflection\Instantiator\Finder;
+use ArtARTs36\MergeRequestLinter\Shared\Reflection\ParameterMapBuilder;
 use ArtARTs36\MergeRequestLinter\Shared\Reflection\TypeResolver\ResolverFactory;
 
 class ArrayConfigLoaderFactory
@@ -48,12 +48,12 @@ class ArrayConfigLoaderFactory
     ];
 
     public function __construct(
-        private readonly FileSystem      $fileSystem,
-        private readonly Environment     $environment,
-        private readonly MetricManager   $metrics,
-        private readonly ResolverFactory $argumentResolverFactory,
-        private readonly MapContainer    $container,
-        private readonly DecoderFactory  $decoderFactory = new DecoderFactory(),
+        private readonly FileSystem        $fileSystem,
+        private readonly Environment       $environment,
+        private readonly CollectorRegistry $metrics,
+        private readonly ResolverFactory   $argumentResolverFactory,
+        private readonly MapContainer      $container,
+        private readonly DecoderFactory    $decoderFactory = new DecoderFactory(),
     ) {
     }
 

src/Infrastructure/Configuration/Loader/Mapper/ArrayConfigHydrator.php

@@ -8,6 +8,8 @@
 use ArtARTs36\MergeRequestLinter\Domain\Configuration\Config;
 use ArtARTs36\MergeRequestLinter\Domain\Configuration\HttpClientConfig;
 use ArtARTs36\MergeRequestLinter\Domain\Configuration\LinterConfig;
+use ArtARTs36\MergeRequestLinter\Domain\Configuration\MetricsConfig;
+use ArtARTs36\MergeRequestLinter\Domain\Configuration\MetricsStorageConfig;
 use ArtARTs36\MergeRequestLinter\Domain\Configuration\NotificationsConfig;
 use ArtARTs36\MergeRequestLinter\Domain\Linter\LinterOptions;
 use ArtARTs36\MergeRequestLinter\Domain\Rule\Rules;
@@ -82,6 +84,7 @@ public function hydrate(array $data, int $subjects = Config::SUBJECT_ALL): Confi
             $notifications,
             $this->createLinterConfig($data['linter'] ?? []),
             $this->createCommentsConfig($data['comments'] ?? []),
+            $this->createMetricsConfig($data),
         );
     }
 
@@ -155,4 +158,58 @@ private function createCommentsConfig(array $config): CommentsConfig
             $messages,
         );
     }
+
+    /**
+     * @param array<string, mixed> $config
+     */
+    private function createMetricsConfig(array $config): MetricsConfig
+    {
+        if (! array_key_exists('metrics', $config)) {
+            return new MetricsConfig(new MetricsStorageConfig('null', 'null'));
+        }
+
+        if (! is_array($config['metrics'])) {
+            throw ConfigInvalidException::invalidType('metrics', 'array', gettype($config['metrics']));
+        }
+
+        if (! array_key_exists('storage', $config['metrics'])) {
+            throw ConfigInvalidException::keyNotSet('metrics.storage');
+        }
+
+        if (! is_array($config['metrics']['storage'])) {
+            throw ConfigInvalidException::invalidType(
+                'metrics.storage',
+                'array',
+                gettype($config['metrics']['storage']),
+            );
+        }
+
+        if (count($config['metrics']['storage']) === 0) {
+            throw new ConfigInvalidException('Config[metrics.storage] must be not empty');
+        }
+
+        $storageName = array_key_first($config['metrics']['storage']);
+
+        if (! in_array($storageName, MetricsStorageConfig::NAMES, true)) {
+            throw new ConfigInvalidException(sprintf(
+                'Config[metrics.storage] name must be of [%s]',
+                implode(', ', MetricsStorageConfig::NAMES),
+            ));
+        }
+
+        $storage = $config['metrics']['storage'][$storageName];
+
+        if (empty($storage['address'])) {
+            throw new ConfigInvalidException('Config[metrics.storage.address] must be not empty');
+        }
+
+        if (! is_string($storage['address'])) {
+            throw new ConfigInvalidException('Config[metrics.storage.address] must be string');
+        }
+
+        return new MetricsConfig(new MetricsStorageConfig(
+            $storageName,
+            $storage['address'],
+        ));
+    }
 }