Merge pull request #21 from ujamii/sergeylanzman/master

Sergeylanzman/master

metrics/index.php

@@ -3,6 +3,7 @@
 require_once '../vendor/autoload.php';
 
 $scheme = getenv('HTTP_PROTO') ?: 'https';
-$exporter = new \Ujamii\OpenMetrics\Sentry\SentryExporter(getenv('AUTH_TOKEN'), $scheme .'://'. getenv('SENTRY_HOST') .'/api/0/');
+$useThrottling = strtolower(getenv("USE_THROTTLING")) === "true" || getenv("USE_THROTTLING") === "1";
+$exporter = new \Ujamii\OpenMetrics\Sentry\SentryExporter(getenv('AUTH_TOKEN'), $scheme .'://'. getenv('SENTRY_HOST') .'/api/0/', $useThrottling);
 $exporter->run();
 

readme.md

@@ -36,9 +36,9 @@ $exporter->run();
 The image is based on `php:8.1-apache` and thus exposes data on port 80 by default. Assuming you fire this up with `-p 80:80` on 
 localhost, you can see the metrics on http://localhost/metrics.
 
-Configuration is done with 3 env variables: `SENTRY_HOST`, `AUTH_TOKEN` and `HTTP_PROTO`.
-The first 2 are mandatory, `HTTP_PROTO` is optional and set to `https` by default. If you're working with the Sentry 
-Cloud, your `SENTRY_HOST` variable must be "sentry.io"
+Configuration is done with 3 env variables: `SENTRY_HOST`, `AUTH_TOKEN`, `USE_THROTTLING` and `HTTP_PROTO`.
+The first 2 are mandatory, `HTTP_PROTO` is optional and set to `https` by default. If you're working with the Sentry Cloud, your `SENTRY_HOST` variable must be "sentry.io"
+When you set `USE_THROTTLING` to `true/TRUE` or `1`, the exporter will throttle the API requests to prevent a rate limit. This is useful if you have a lot of projects and/or a lot of issues.
 
 ```shell
 docker run -d --name sentry-prometheus -e SENTRY_HOST=sentry.foobar.com -e AUTH_TOKEN=foobarlongtoken -p "80:80" ghcr.io/ujamii/prometheus-sentry-exporter

src/SentryExporter.php

@@ -18,7 +18,9 @@ class SentryExporter
 
     protected array $options = [];
 
-    public function __construct(string $token, string $sentryBase = 'https://sentry.io/api/0/')
+    protected bool $useThrottling = false;
+
+    public function __construct(string $token, string $sentryBase = 'https://sentry.io/api/0/', bool $useThrottling = false)
     {
         $this->httpClient = new Client([
             'base_uri' => $sentryBase,
@@ -29,7 +31,7 @@ public function __construct(string $token, string $sentryBase = 'https://sentry.
                 'Accept'        => 'application/json',
             ]
         ];
-
+        $this->useThrottling = $useThrottling;
     }
 
     /**
@@ -40,8 +42,14 @@ public function run(): void
         $gauges = GaugeCollection::withMetricName(MetricName::fromString('sentry_open_issue_events'))->withHelp('Number of events for one unresolved issue.');
 
         $projectData = $this->getProjects();
+        if($this->useThrottling){
+            sleep(1);
+        }
         foreach ($projectData as $project) {
             $projectIssues = $this->getIssues($project);
+            if($this->useThrottling){
+                sleep(1);
+            }
             foreach ($projectIssues as $issue) {
                 $gauges->add(
                     Gauge::fromValue($issue->count)->withLabels(