add prometheus 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/Report/Reporter/PrometheusPushGatewayReporter.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Application\Report\Reporter;
+
+use ArtARTs36\MergeRequestLinter\Domain\Linter\LintResult;
+use ArtARTs36\MergeRequestLinter\Domain\Request\MergeRequest;
+use ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway\Metric;
+use ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway\PushGateway;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
+
+class PrometheusPushGatewayReporter implements Reporter
+{
+    public function __construct(
+        private readonly MetricManager $metrics,
+        private readonly PushGateway $client,
+    ) {
+    }
+
+    public function report(MergeRequest $request, LintResult $result): void
+    {
+        $jobId = sprintf('%s-%s', $request->uri, time());
+        $jobIdHash = md5($jobId);
+
+        $this->client->push($jobIdHash, $this->collectMetrics($request, $result));
+    }
+
+    /**
+     * @return array<Metric>
+     */
+    private function collectMetrics(MergeRequest $request, LintResult $result): array
+    {
+        $labels = ['repo' => (string) $request->uri, 'request_id' => $request->id];
+        $metrics = [];
+
+        $metrics[] = Metric::gauge('mr_linter_lint_state', 'MR Linter: lint state', $labels, $result->state->value);
+        $metrics[] = Metric::gauge('mr_linter_lint_duration', 'MR Linter: lint duration', $labels, $result->duration->seconds);
+        $metrics[] = Metric::gauge('mr_linter_lint_notes', 'MR Linter: lint duration', $labels, $result->notes->count());
+
+        return $metrics;
+    }
+}

src/Application/Report/Reporter/Reporter.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Application\Report\Reporter;
+
+use ArtARTs36\MergeRequestLinter\Domain\Linter\LintResult;
+use ArtARTs36\MergeRequestLinter\Domain\Request\MergeRequest;
+
+interface Reporter
+{
+    public function report(MergeRequest $request, LintResult $result): void;
+}

src/Application/Report/Reporter/ReporterFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Application\Report\Reporter;
+
+use ArtARTs36\MergeRequestLinter\Infrastructure\Http\Client\ClientGuzzleWrapper;
+use ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway\PushGateway;
+use ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway\PushGatewayClient;
+use ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway\Renderer;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
+use GuzzleHttp\Client;
+use Psr\Log\LoggerInterface;
+
+class ReporterFactory
+{
+    public function __construct(
+        private readonly MetricManager $metrics,
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+
+    public function create(string $type, array $params): Reporter
+    {
+        if ($type === 'prometheusPushGateway') {
+            return new PrometheusPushGatewayReporter(
+                $this->metrics,
+                new PushGateway(new PushGatewayClient(new ClientGuzzleWrapper(new Client(), $this->logger)), new Renderer()),
+            );
+        }
+    }
+}

src/Application/Report/ReporterHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Application\Report;
+
+use ArtARTs36\MergeRequestLinter\Application\Report\Reporter\Reporter;
+use ArtARTs36\MergeRequestLinter\Domain\Linter\LintFinishedEvent;
+use ArtARTs36\MergeRequestLinter\Infrastructure\NotificationEvent\Listener;
+
+class ReporterHandler implements Listener
+{
+    public function __construct(
+        private readonly Reporter $reporter,
+    ) {
+    }
+
+    public function handle(object $event): void
+    {
+        if (! $event instanceof LintFinishedEvent) {
+            throw new \LogicException(sprintf(
+                'ReporterHandler expects event of %s, actual: %s',
+                LintFinishedEvent::class,
+                $event::class,
+            ));
+        }
+
+        $this->reporter->report($event->request, $event->result);
+    }
+}

src/Infrastructure/Http/Exceptions/HttpRequestException.php

@@ -24,7 +24,12 @@ public static function create(RequestInterface $request, ResponseInterface $resp
         return new static(
             $request,
             $response,
-            sprintf('%s returns response with status %d', $request->getUri()->getHost(), $response->getStatusCode()),
+            sprintf(
+                '%s returns response with status %d: %s',
+                $request->getUri()->getHost(),
+                $response->getStatusCode(),
+                $response->getBody()->getContents(),
+            ),
         );
     }
 

src/Infrastructure/Prometheus/PushGateway/Metric.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway;
+
+/**
+ * @codeCoverageIgnore
+ */
+readonly class Metric
+{
+    /**
+     * @param array<string, int|string> $labels
+     */
+    public function __construct(
+        public string $type,
+        public string $key,
+        public string $help,
+        public array $labels,
+        public int|string|float $value,
+    ) {
+    }
+
+    /**
+     * @param array<string, int|string> $labels
+     */
+    public static function gauge(string $key, string $help, array $labels, int|string|float $value): self
+    {
+        return new self('gauge', $key, $help, $labels, $value);
+    }
+}

src/Infrastructure/Prometheus/PushGateway/PushGateway.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway;
+
+class PushGateway
+{
+    public function __construct(
+        private readonly PushGatewayClient $client,
+        private readonly Renderer $renderer,
+    ) {
+    }
+
+    /**
+     * @param iterable<Metric> $records
+     */
+    public function push(string $job, iterable $records): void
+    {
+        $data = $this->renderer->render($records);
+
+        $this->client->replace($job, $data);
+    }
+}

src/Infrastructure/Prometheus/PushGateway/PushGatewayClient.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway;
+
+use ArtARTs36\MergeRequestLinter\Infrastructure\Contracts\Http\Client;
+use GuzzleHttp\Psr7\Request;
+
+class PushGatewayClient
+{
+    public function __construct(
+        private readonly Client $http,
+    ) {
+    }
+
+    public function replace(string $job, string $data): void
+    {
+        $url = "http://host.docker.internal:9091/metrics/job/{$job}";
+
+        $this->http->sendRequest(new Request('POST', $url, body: $data));
+    }
+}

src/Infrastructure/Prometheus/PushGateway/Renderer.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Infrastructure\Prometheus\PushGateway;
+
+class Renderer
+{
+    /**
+     * @param iterable<Metric> $records
+     */
+    public function render(iterable $records): string
+    {
+        $content = '';
+
+        foreach ($records as $metric) {
+            $value = $metric->value;
+
+            $labelsString = $this->collectLabels($metric);
+
+            $content .= <<<HTML
+# HELP {$metric->key} The number of items in the queue.
+# TYPE {$metric->key} {$metric->type}
+
+{$metric->key}{$labelsString} $value
+
+HTML;
+        }
+
+        return $content;
+    }
+
+    private function collectLabels(Metric $metric): string
+    {
+        if (count($metric->labels) === 0) {
+            return '';
+        }
+
+        $labelsString = '{';
+        $labels = $metric->labels;
+
+        foreach ($labels as $labelKey => $labelValue) {
+            $labelsString .= sprintf(
+                '%s=%s',
+                $labelKey,
+                is_string($labelValue) ? ('"'. $labelValue .'"') : $labelValue,
+            );
+
+            if (next($labels) !== false) {
+                $labelsString .= ',';
+            }
+        }
+
+        return $labelsString . '}';
+    }
+}

src/Presentation/Console/Application/ApplicationFactory.php

@@ -41,6 +41,7 @@
 use ArtARTs36\MergeRequestLinter\Providers\CommentProvider;
 use ArtARTs36\MergeRequestLinter\Providers\EventDispatcherProvider;
 use ArtARTs36\MergeRequestLinter\Providers\NotificationsProvider;
+use ArtARTs36\MergeRequestLinter\Providers\ReportProvider;
 use ArtARTs36\MergeRequestLinter\Providers\RuleProvider;
 use ArtARTs36\MergeRequestLinter\Providers\ServiceProvider;
 use ArtARTs36\MergeRequestLinter\Shared\Events\EventManager;
@@ -61,6 +62,7 @@ class ApplicationFactory
         NotificationsProvider::class,
         RuleProvider::class,
         CommentProvider::class,
+        ReportProvider::class,
     ];
 
     public function __construct(

src/Presentation/Console/Command/LintCommand.php

@@ -117,7 +117,7 @@ private function printMetrics(StyleInterface $style, LintResult $result, bool $f
         if ($fullMetrics) {
             $metrics = $metrics->merge(
                 $this->metrics->describe()->mapToArray(
-                    static fn (Record $record) => new Metric($record->subject->name, $record->getValue()),
+                    static fn (Record $record) => new Metric($record->subject->name, $record->value->getMetricValue()),
                 )
             );
         }

src/Providers/ReportProvider.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace ArtARTs36\MergeRequestLinter\Providers;
+
+use ArtARTs36\MergeRequestLinter\Application\Report\Reporter\ReporterFactory;
+use ArtARTs36\MergeRequestLinter\Domain\Linter\LintFinishedEvent;
+use ArtARTs36\MergeRequestLinter\Shared\Events\CallbackListener;
+use ArtARTs36\MergeRequestLinter\Shared\Events\EventManager;
+use ArtARTs36\MergeRequestLinter\Shared\Metrics\Value\MetricManager;
+use Psr\Container\ContainerInterface;
+use Psr\Log\LoggerInterface;
+
+final class ReportProvider extends Provider
+{
+    public function provide(): void
+    {
+        $this
+            ->container
+            ->bind(ReporterFactory::class, static function (ContainerInterface $container) {
+                return new ReporterFactory(
+                    $container->get(MetricManager::class),
+                    $container->get(LoggerInterface::class),
+                );
+            });
+
+        $this
+            ->container
+            ->get(EventManager::class)
+            ->listen(LintFinishedEvent::class, new CallbackListener('reporter', function (LintFinishedEvent $event) {
+                $factory = $this->container->get(ReporterFactory::class);
+
+                $factory->create('prometheusPushGateway', [])->report($event->request, $event->result);
+            }));
+    }
+}

src/Shared/Metrics/Value/Record.php

@@ -6,13 +6,8 @@
 {
     public function __construct(
         public MetricSubject      $subject,
-        private Metric            $value,
+        public Metric             $value,
         public \DateTimeInterface $date,
     ) {
     }
-
-    public function getValue(): string
-    {
-        return $this->value->getMetricValue();
-    }
 }