unleash 6.4.1 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c28fb398c92bd470282a94e7fe07b910fa4afed65381da67231c60c2b2960c2
-  data.tar.gz: 3a5b78a63ccfcec23ed8eba1e2168a5be7f183ca0c3beac0eb6497d1d4d6678c
+  metadata.gz: 8f2aacf28333e06f4ca46369b9ece6fd1472a8e363cdc4a0fe1aeb0810d879a2
+  data.tar.gz: bc8e366ec18bff858f835260af79650ab6179daa6af93bf84a675eb3d74ad904
 SHA512:
-  metadata.gz: 3d66480a2211bc60a0ddb2899d189a7966be1659f8618873233c8e419f2261dc5cf13cf79f747d36039af5f9ce1ead45fb4e3bc4140d420d4d59369a9a995bc4
-  data.tar.gz: ba06afc53ff6d2806d6bbf18cc93e2287ae327f42cb6699f663a3f2f5bb9abc6e3f71ce02ba7fe18f48bdcb9fb1913c2d9cc4a6be2d05bae6f740def1a4281d5
+  metadata.gz: 9c397ef806b4e77fb8a1d8afbacd3ded420f5979fcf1999b03e524d77dca3f04205fa28e4a1e83037c7670837654c5f0e193f74b53654dedb034c1e9016fb22e
+  data.tar.gz: 07bfa665ecb17ffbe86b9dbb66c3247d824a27e27d846000f181ad5783d8af3a6e9adb9a47d2e2f37732bec80c137683609b63726cd58616164efe464a4fcd4c

data/CHANGELOG.md

@@ -13,6 +13,11 @@ Note: These changes are not considered notable:
 
 ## [Unreleased]
 
+## [6.5.0] - 2026-01-29
+
+### Added
+- Impact metrics 
+
 ## [6.4.1] - 2025-12-04
 
 ### Changed

data/README.md

@@ -28,7 +28,7 @@ You can use this client with [Unleash Enterprise](https://www.getunleash.io/pric
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'unleash', '~> 6.4.1'
+gem 'unleash', '~> 6.5.0'
 ```
 
 And then execute:
@@ -534,6 +534,56 @@ Unleash.configure do |config|
 end
 ```
 
+## Impact metrics
+
+Impact metrics are lightweight, application-level time-series metrics stored and visualized directly inside Unleash. They allow you to connect specific application data, such as request counts, error rates, or latency, to your feature flags and release plans.
+
+These metrics help validate feature impact and automate release processes. For instance, you can monitor usage patterns or performance to determine if a feature meets its goals.
+
+The SDK automatically attaches context labels to metrics: `appName` and `environment`.
+
+### Counters
+
+Use counters for cumulative values that only increase (total requests, errors):
+
+```ruby
+client = Unleash::Client.new
+
+client.impact_metrics.define_counter(
+  'request_count',
+  'Total number of HTTP requests processed'
+)
+
+client.impact_metrics.increment_counter('request_count')
+```
+
+### Gauges
+
+Use gauges for point-in-time values that can go up or down:
+
+```ruby
+client.impact_metrics.define_gauge(
+  'total_users',
+  'Total number of registered users'
+)
+
+client.impact_metrics.update_gauge('total_users', user_count)
+```
+
+### Histograms
+
+Histograms measure value distribution (request duration, response size):
+
+```ruby
+client.impact_metrics.define_histogram(
+  'request_time_ms',
+  'Time taken to process a request in milliseconds',
+  [50, 100, 200, 500, 1000]
+)
+
+client.impact_metrics.observe_histogram('request_time_ms', 125)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/unleash/client.rb

@@ -6,12 +6,15 @@ require 'unleash/streaming_client_executor'
 require 'unleash/variant'
 require 'unleash/util/http'
 require 'unleash/util/event_source_wrapper'
+require 'unleash/environment_resolver'
+require 'unleash/impact_metrics'
 require 'logger'
 require 'time'
 
 module Unleash
   class Client
     attr_accessor :fetcher_scheduled_executor, :metrics_scheduled_executor
+    attr_reader :impact_metrics
 
     # rubocop:disable Metrics/AbcSize
     def initialize(*opts)
@@ -23,6 +26,8 @@ module Unleash
       Unleash.engine = YggdrasilEngine.new
       Unleash.engine.register_custom_strategies(Unleash.configuration.strategies.custom_strategies)
 
+      @impact_metrics = ImpactMetrics.new(Unleash.engine, Unleash.configuration.app_name)
+
       Unleash.toggle_fetcher = Unleash::ToggleFetcher.new Unleash.engine unless Unleash.configuration.streaming_mode?
 
       if Unleash.configuration.disable_client

data/lib/unleash/configuration.rb

@@ -107,6 +107,12 @@ module Unleash
         self.experimental_mode[:format] == 'delta'
     end
 
+    def generate_custom_http_headers
+      return self.custom_http_headers.call if self.custom_http_headers.respond_to?(:call)
+
+      self.custom_http_headers
+    end
+
     private
 
     def set_defaults
@@ -153,12 +159,6 @@ module Unleash
       raise ArgumentError, "custom_http_headers must be a Hash or a Proc."
     end
 
-    def generate_custom_http_headers
-      return self.custom_http_headers.call if self.custom_http_headers.respond_to?(:call)
-
-      self.custom_http_headers
-    end
-
     def set_option(opt, val)
       __send__("#{opt}=", val)
     rescue NoMethodError

data/lib/unleash/environment_resolver.rb

@@ -0,0 +1,27 @@
+module Unleash
+  class EnvironmentResolver
+    def self.extract_environment_from_custom_headers(custom_headers)
+      authorization_header = extract_authorization_header(custom_headers)
+      extract_environment_from_header(authorization_header)
+    end
+
+    def self.extract_authorization_header(custom_headers)
+      return nil if custom_headers.nil? || !custom_headers.is_a?(Hash)
+
+      key = custom_headers.keys.find{ |k| k.to_s.downcase == 'authorization' }
+      custom_headers[key] if key
+    end
+
+    def self.extract_environment_from_header(authorization_header)
+      return nil if authorization_header.nil? || authorization_header.empty?
+
+      after_colon = authorization_header.split(':', 2)[1]
+      return nil unless after_colon&.include?('.')
+
+      environment = after_colon.split('.')[0]
+      environment unless environment.empty?
+    end
+
+    private_class_method :extract_authorization_header, :extract_environment_from_header
+  end
+end

data/lib/unleash/impact_metrics.rb

@@ -0,0 +1,43 @@
+module Unleash
+  class ImpactMetrics
+    def initialize(engine, app_name)
+      @engine = engine
+      @app_name = app_name
+    end
+
+    def define_counter(name, help_text)
+      @engine.define_counter(name, help_text)
+    end
+
+    def increment_counter(name, value = 1)
+      @engine.inc_counter(name, value, base_labels)
+    end
+
+    def define_gauge(name, help_text)
+      @engine.define_gauge(name, help_text)
+    end
+
+    def update_gauge(name, value)
+      @engine.set_gauge(name, value, base_labels)
+    end
+
+    def define_histogram(name, help_text, buckets = nil)
+      @engine.define_histogram(name, help_text, buckets)
+    end
+
+    def observe_histogram(name, value)
+      @engine.observe_histogram(name, value, base_labels)
+    end
+
+    private
+
+    def base_labels
+      {
+        'appName' => @app_name,
+        'environment' => EnvironmentResolver.extract_environment_from_custom_headers(
+          Unleash.configuration.generate_custom_http_headers
+        ) || Unleash.configuration.environment
+      }
+    end
+  end
+end

data/lib/unleash/metrics_reporter.rb

@@ -23,7 +23,8 @@ module Unleash
     def post
       Unleash.logger.debug "post() Report"
 
-      report = build_report
+      impact_metrics = collect_impact_metrics_safely
+      report = build_report(impact_metrics)
       return unless report
 
       send_report(report)
@@ -44,15 +45,20 @@ module Unleash
       }
     end
 
-    def build_report
+    def build_report(impact_metrics)
       report = generate_report
-      return nil if report.nil? && Time.now - self.last_time < LONGEST_WITHOUT_A_REPORT
+      has_data = !report.nil? || !impact_metrics.empty?
 
-      report || generate_report_from_bucket({
+      return nil if !has_data && Time.now - self.last_time < LONGEST_WITHOUT_A_REPORT
+
+      report ||= generate_report_from_bucket({
         'start': self.last_time.utc.iso8601,
         'stop': Time.now.utc.iso8601,
         'toggles': {}
       })
+
+      report[:impactMetrics] = impact_metrics unless impact_metrics.empty?
+      report
     end
 
     def send_report(report)
@@ -66,8 +72,24 @@ module Unleash
       else
         # :nocov:
         Unleash.logger.error "Error when sending report to unleash server. Server responded with http code #{response.code}."
+        restore_impact_metrics(report[:impactMetrics])
         # :nocov:
       end
     end
+
+    def restore_impact_metrics(impact_metrics)
+      return if impact_metrics.nil? || impact_metrics.empty?
+
+      Unleash.engine&.restore_impact_metrics(impact_metrics)
+    rescue StandardError => e
+      Unleash.logger.warn "Failed to restore impact metrics: #{e.message}"
+    end
+
+    def collect_impact_metrics_safely
+      Unleash.engine&.collect_impact_metrics || []
+    rescue StandardError => e
+      Unleash.logger.warn "Failed to collect impact metrics: #{e.message}"
+      []
+    end
   end
 end

data/lib/unleash/version.rb

@@ -1,3 +1,3 @@
 module Unleash
-  VERSION = "6.4.1".freeze
+  VERSION = "6.5.0".freeze
 end

data/unleash-client.gemspec

@@ -24,12 +24,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "ld-eventsource", "2.2.4" unless RUBY_ENGINE == 'jruby'
-  spec.add_dependency "yggdrasil-engine", "~> 1.1.1"
+  spec.add_dependency "yggdrasil-engine", "~> 1.2.1"
 
   spec.add_dependency "base64", "~> 0.3.0"
   spec.add_dependency "logger", "~> 1.6"
 
-  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.12"
   spec.add_development_dependency "rspec-json_expectations", "~> 2.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unleash
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 6.5.0
 platform: ruby
 authors:
 - Renato Arruda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-04 00:00:00.000000000 Z
+date: 2026-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ld-eventsource
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +205,8 @@ files:
 - lib/unleash/client.rb
 - lib/unleash/configuration.rb
 - lib/unleash/context.rb
+- lib/unleash/environment_resolver.rb
+- lib/unleash/impact_metrics.rb
 - lib/unleash/metrics_reporter.rb
 - lib/unleash/scheduled_executor.rb
 - lib/unleash/spec_version.rb
@@ -251,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Unleash feature toggle client.