twingly-metrics 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be11bd1a0f91edf2ac37637732b5ed9452d9ac959354c7cd4cb2dac448e00939
-  data.tar.gz: 4f4aa1606534e1a67ddacdc5058a737733ca0be788af51fa91fb807d7cac8e3c
+  metadata.gz: db46b25f0b710bb60e8b504902a79718e2828b067badaeb9690f90516f4e6324
+  data.tar.gz: 99b630dbcbb6da1830cd2b7605f89dcaef1fcf0d95108370bad2c651aa9249bc
 SHA512:
-  metadata.gz: cb94deb9dc0274ec9400662f84b93a857fc43d15d39d6c6bcd2ff57c7b2a0a11da6fb1923283537c44fc33ce135464b9788a615a4c6a97a9c670832004471e1d
-  data.tar.gz: df1823f5e97aa1c08d1fdca1ab4e8d30d9620881aa0facbafbe700218f5d1d4bac6e79ee2ba50c436abbce5fa22e1c3499ef00bb30c660db80daf4720f132463
+  metadata.gz: 31463227adeae2852358eea87082bc69cdc7692cece9935c13bccb68f6ce19f87470f0d75bd330e2d4b7eecc2e9f86b3138d9e10e3fb1b9fdafd173ce45af8ff
+  data.tar.gz: 2d557c902b80cb79a78b1a64c35191eb4261919e66d9f5f4faef84cf24b9a684b9e3becbde33cc7f00d8894d97c4265e9a4cd11b2799f8d0e52a05a000462cc8

data/README.md

@@ -4,7 +4,7 @@
 
 A gem for collecting and reporting metrics from our Ruby applications.
 
-This gem currently relies on the [`metriks` gem][metriks] for collecting metrics. The reason for this is that we're already using that gem in our projects. What the `twingly-metrics` gem currently adds in functionality, is the ability to report metrics to [Grafana cloud][grafana-cloud], using their [Graphite HTTP API][grafana-cloud-graphite-api].
+This gem currently relies on the [`metriks` gem][metriks] for collecting metrics. The reason for this is that we're already using that gem in our projects. What the `twingly-metrics` gem currently adds in functionality, is the ability to report metrics to [Grafana cloud][grafana-cloud], using their [Graphite HTTP API][grafana-cloud-graphite-api], along with some convenience methods for working with metrics.
 
 The code here was inspired by the reporter in the [`metriks-librato_metrics` gem][metriks-librato_metrics].
 
@@ -50,21 +50,41 @@ reporter = Twingly::Metrics::GrafanaCloudReporter.new(
 reporter.start # Starts the reporter thread in the background
 
 # Create some metrics for the reporter to have something to report
-Metriks.meter("test.meter").mark(1)
+Twingly::Metrics.meter("test.meter").mark(1)
 
 at_exit do
   reporter.flush # Ensure all unreported metrics are sent before exiting
 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:
 
-* [`Metriks.counter`](https://github.com/eric/metriks?tab=readme-ov-file#counters)
-* [`Metriks.gauge`](https://github.com/eric/metriks?tab=readme-ov-file#gauges)
-* [`Metriks.meter`](https://github.com/eric/metriks?tab=readme-ov-file#meters)
-* [`Metriks.timer`](https://github.com/eric/metriks?tab=readme-ov-file#timers)
+* `Twingly::Metrics.counter` - See [`Metriks.counter`](https://github.com/eric/metriks?tab=readme-ov-file#counters)
+* `Twingly::Metrics.gauge` - See [`Metriks.gauge`](https://github.com/eric/metriks?tab=readme-ov-file#gauges)
+* `Twingly::Metrics.meter` - See [`Metriks.meter`](https://github.com/eric/metriks?tab=readme-ov-file#meters)
+* `Twingly::Metrics.timer` - See [`Metriks.timer`](https://github.com/eric/metriks?tab=readme-ov-file#timers)
+
+Helper methods are also provided for some common use cases:
+
+```ruby
+# Equivalent to Twingly::Metrics.meter("my_meter").mark(1)
+Twingly::Metrics.mark("my_meter", 1)
+
+# Equivalent to Twingly::Metrics.timer("my_timer").time { ... }
+Twingly::Metrics.time("my_timer") { ... }
+```
 
 [metriks]: https://github.com/eric/metriks
 [grafana-cloud]: https://grafana.com/products/cloud/

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.4.0"
   end
 end

data/lib/twingly/metrics.rb

@@ -1,4 +1,36 @@
 # frozen_string_literal: true
 
+require "metriks"
+
 require_relative "metrics/version"
 require_relative "metrics/grafana_cloud_reporter"
+
+module Twingly
+  module Metrics
+    def self.counter(name)
+      Metriks.counter(name)
+    end
+
+    def self.gauge(name, callable = nil, &block)
+      Metriks.gauge(name, callable, &block)
+    end
+
+    def self.timer(name)
+      Metriks.timer(name)
+    end
+
+    def self.meter(name)
+      Metriks.meter(name)
+    end
+
+    def self.mark(name, val = 1)
+      meter(name).mark(val)
+    end
+
+    def self.time(name, duration = nil, &block)
+      return timer(name).update(duration) if duration
+
+      timer(name).time(&block)
+    end
+  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.4.0
 platform: ruby
 authors:
 - Twingly AB
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks