twingly-metrics 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c23b7fe7fa29534ac78882741d226c25a69629b6520329ae36d489a1ead5cc
-  data.tar.gz: 4750028c638903b62dd13f4911a8d15906accf0c7d7d275f1d46b81064f50858
+  metadata.gz: 645a000c596946e7ec3ac3ace454267fc2d55784eb757f4357a26beaaf165fef
+  data.tar.gz: edf608261027d9dee342a10cd473c2e04d621b1d189db93c24c27bac1159ae9f
 SHA512:
-  metadata.gz: 843481f3ac90c856cff73cbb67adcf7be831c4aeabcd7dd41f0b996543bf35aa3519ff8367e24ecbbeee954927be24e141bc87ab1672d92286096a1445a32b2e
-  data.tar.gz: 9b4baf1f630f4e99b6a0118c84325a93b712e9e662d12124c14074da9554be7bdf22925eb434b9c969e8d6094c714a204b06d0235e21eb87e522315fa795d416
+  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:
@@ -70,3 +80,19 @@ The reporter currently supports the following metric types from the `metriks` ge
 [grafana-cloud]: https://grafana.com/products/cloud/
 [grafana-cloud-graphite-api]: https://grafana.com/docs/grafana-cloud/send-data/metrics/metrics-graphite/http-api/#adding-new-data-posting-to-metrics
 [metriks-librato_metrics]: https://github.com/eric/metriks-librato_metrics
+
+## Release workflow
+
+* Bump the version in `lib/twingly/metrics/version.rb` in a commit, no need to push (the release task does that).
+
+* Build and [publish](http://guides.rubygems.org/publishing/) the gem. This will create the proper tag in git, push the commit and tag and upload to RubyGems.
+
+        bundle exec rake release
+
+    * If you are not logged in as [twingly][twingly-rubygems] with ruby gems, the rake task will fail. Login using `gem signin` and run the `release` task again. It will be okay.
+
+* Update the changelog with [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/) (`gem install github_changelog_generator` if you don't have it, set `CHANGELOG_GITHUB_TOKEN` to a personal access token to avoid rate limiting by GitHub). This command will update `CHANGELOG.md`, commit and push manually.
+
+        github_changelog_generator -u twingly -p twingly-metrics
+
+[twingly-rubygems]: https://rubygems.org/profiles/twingly

data/lib/twingly/metrics/grafana_cloud_reporter.rb

@@ -3,6 +3,7 @@
 require "net/https"
 require "json"
 require "metriks"
+require "socket"
 
 module Twingly
   module Metrics
@@ -43,15 +44,17 @@ module Twingly
       attr_reader :interval
       attr_reader :timeout
 
-      def initialize(endpoint:, user:, token:, **options) # rubocop:disable Metriks/AbcSize, Metrics/MethodLength
-        @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]
+        @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) }
@@ -68,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
@@ -84,6 +88,8 @@ module Twingly
       end
 
       def stop
+        return unless credentials_provided?
+
         @running = false
 
         return unless @reporter_thread
@@ -98,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)
@@ -109,6 +119,17 @@ module Twingly
 
       private
 
+      def default_source
+        process_id = Process.pid # In case there are multiple processes running on the same host
+        hostname   = if ENV["NOMAD_ALLOC_ID"].to_s.strip.empty?
+                       Socket.gethostname.gsub(/[^a-zA-Z0-9_-]/, "_")
+                     else
+                       ENV.fetch("NOMAD_ALLOC_ID")
+                     end
+
+        "#{hostname}_pid-#{process_id}"
+      end
+
       def make_request(request_data) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         return if request_data.empty?
 
@@ -132,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
 
@@ -212,7 +251,7 @@ module Twingly
           time:     time.to_i,
         }
 
-        graphite_data[:tags] = ["source=#{@source}"] unless @source.to_s.empty?
+        graphite_data[:tags] = ["source=#{source}"]
 
         graphite_data
       end
@@ -235,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.1.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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Twingly AB
 bindir: bin
 cert_chain: []
-date: 2025-07-15 00:00:00.000000000 Z
+date: 2025-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metriks