twingly-metrics 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be11bd1a0f91edf2ac37637732b5ed9452d9ac959354c7cd4cb2dac448e00939
-  data.tar.gz: 4f4aa1606534e1a67ddacdc5058a737733ca0be788af51fa91fb807d7cac8e3c
+  metadata.gz: 645a000c596946e7ec3ac3ace454267fc2d55784eb757f4357a26beaaf165fef
+  data.tar.gz: edf608261027d9dee342a10cd473c2e04d621b1d189db93c24c27bac1159ae9f
 SHA512:
-  metadata.gz: cb94deb9dc0274ec9400662f84b93a857fc43d15d39d6c6bcd2ff57c7b2a0a11da6fb1923283537c44fc33ce135464b9788a615a4c6a97a9c670832004471e1d
-  data.tar.gz: df1823f5e97aa1c08d1fdca1ab4e8d30d9620881aa0facbafbe700218f5d1d4bac6e79ee2ba50c436abbce5fa22e1c3499ef00bb30c660db80daf4720f132463
+  metadata.gz: 979af04631cb1cc9e2697db8471119b4dcef5bb3d769aa96c4ce6aa9e35f08e7a9bcda6913b41aca8841751c0cb650df0e985aa2931ea136f0309c077d58006c
+  data.tar.gz: da7fd09eff4fee2554bbeb2d78016f8bec47ac01833d834f6a2c6f97cf2a72d89668b23d776f1d44535ab96e1b666a2961f2257377beb022f078d2e01f1669d6

data/README.md

@@ -57,6 +57,16 @@ at_exit do
 end
 ```
 
+The `endpoint`, `user`, and `token` options can also be configured by setting the following environment variables:
+
+```
+GRAFANA_METRICS_ENDPOINT=
+GRAFANA_METRICS_USER=
+GRAFANA_METRICS_TOKEN=
+```
+
+*Note: If the environment variables are not set, or the corresponding parameters are not provided, the reporter will not try to report any metrics to Grafana.*
+
 ### Supported metric types
 
 The reporter currently supports the following metric types from the `metriks` gem:

data/lib/twingly/metrics/grafana_cloud_reporter.rb

@@ -44,15 +44,17 @@ module Twingly
       attr_reader :interval
       attr_reader :timeout
 
-      def initialize(endpoint:, user:, token:, **options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
-        @endpoint = endpoint
-        @user     = user
-        @token    = token
+      def initialize(endpoint: nil, user: nil, token: nil, **options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        @endpoint = endpoint || ENV.fetch("GRAFANA_METRICS_ENDPOINT") { nil }
+        @user     = user     || ENV.fetch("GRAFANA_METRICS_USER")     { nil }
+        @token    = token    || ENV.fetch("GRAFANA_METRICS_TOKEN")    { nil }
 
         @prefix = options[:prefix]
         @source = options[:source] || default_source
         @logger = options[:logger]
 
+        log_missing_credentials unless credentials_provided?
+
         @registry = options[:registry] || Metriks::Registry.default
         @interval = options[:interval] || 60
         @on_error = options[:on_error] || proc { |ex| @logger&.error(ex) }
@@ -69,7 +71,8 @@ module Twingly
         @reporter_thread     = nil
       end
 
-      def start
+      def start # rubocop:disable Metrics/MethodLength
+        return unless credentials_provided?
         return if @reporter_thread&.alive?
 
         @running = true
@@ -85,6 +88,8 @@ module Twingly
       end
 
       def stop
+        return unless credentials_provided?
+
         @running = false
 
         return unless @reporter_thread
@@ -99,10 +104,14 @@ module Twingly
       end
 
       def flush
+        return unless credentials_provided?
+
         @flush_metrics_mutex.synchronize do
           request_data = build_metrics_data_for_request
 
-          make_request(request_data)
+          retry_failing_request do
+            make_request(request_data)
+          end
         end
       rescue StandardError => e
         @on_error.call(e)
@@ -144,6 +153,24 @@ module Twingly
         end
       end
 
+      def retry_failing_request(max_retries: 3)
+        retries = 0
+
+        begin
+          yield
+        rescue RequestFailedError => e
+          retries += 1
+
+          raise if retries > max_retries
+
+          @logger&.debug("GrafanaCloudReporter: Request failed, retrying (#{retries}/#{max_retries}) - #{e.message}")
+
+          sleep 1
+
+          retry
+        end
+      end
+
       def build_metrics_data_for_request
         time = now_floored
 
@@ -247,6 +274,16 @@ module Twingly
         @next_time = now if @next_time <= now
         @next_time += @interval - (@next_time % @interval)
       end
+
+      def credentials_provided?
+        @endpoint && @user && @token
+      end
+
+      def log_missing_credentials
+        return unless @logger
+
+        @logger.warn("#{self.class.name}: Metrics won't be reported, as endpoint, user, or token is missing.")
+      end
     end
   end
 end

data/lib/twingly/metrics/version.rb

@@ -2,6 +2,6 @@
 
 module Twingly
   module Metrics
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: twingly-metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Twingly AB
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks