flare 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcfa9283973a11f13fd17397781c76cc03d3e39c9bd08a92025417397eb74eb9
-  data.tar.gz: 30e2f84a92f9689aabdd64b7c6839598dc0c3c2bb1dd32a31e2ab9b3a6f5f85a
+  metadata.gz: 1adc85107fcbe273da78049b6882bda0f234913b743b5c67988b8b90f53261ae
+  data.tar.gz: c46bca41c454100e57ea005ad2a83af2bb7ada763ba48a9cb2ffb19e0811198f
 SHA512:
-  metadata.gz: 581e6e9ed512b82ac086ab76644ff0d618408649a110ef3b623a3bf4a1648e3695dfcedcefad01bd54b7a11687a1c5ed154ed01e74f2cf14c27fa400bf97f73a
-  data.tar.gz: 4a407b09a229f512d6cb1f35ab04dfb8de7ecaa982837fd356c41435c7758d3c4e05ad33812670b2e570830bef5a21e9bdffe297234cec9e33f9ab5250c42af1
+  metadata.gz: 76e48757e0e4dedffd5363b6cbb671271f2e1447cc1b06f1f1d1518315ab775a9198f72c522cbb74fc3969c54e93b2baca82d65919855025247e28897f015f9f
+  data.tar.gz: 89661ee1a5b0a1aa90cd21d410c087c359351b2714211f55d4a33bb35a739ef943348771fb7bf3a9cb7f4e8fd66446b0f213ac34f1c4da0e9f54b0babea74ec5

data/lib/flare/client_headers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "socket"
+
+require_relative "version"
+
+module Flare
+  # Single source of truth for the headers that identify this client and its
+  # version to the Flare API. The server parses the gem version out of the
+  # User-Agent ("Flare Ruby/X.Y.Z") to gate version-dependent features, and
+  # uses the X-Client-* headers to build a per-client picture.
+  #
+  # Safe to send on any request that targets the Flare API (metrics POST,
+  # rules GET, trace-notify POST). Do NOT send these on the presigned R2 blob
+  # PUT -- they're meaningless to R2 and can invalidate the signed-header set.
+  #
+  # Excludes Authorization / Flare-Project / Flare-Environment -- callers add
+  # those since they're request- or context-specific.
+  module ClientHeaders
+    USER_AGENT = "Flare Ruby/#{Flare::VERSION}"
+
+    def self.to_h
+      {
+        "User-Agent"                => USER_AGENT,
+        "X-Client-Language"         => "ruby",
+        "X-Client-Language-Version" => RUBY_VERSION,
+        "X-Client-Platform"         => RUBY_PLATFORM,
+        "X-Client-Pid"              => Process.pid.to_s,
+        "X-Client-Hostname"         => hostname
+      }
+    end
+
+    def self.hostname
+      Socket.gethostname
+    rescue StandardError
+      "unknown"
+    end
+  end
+end

data/lib/flare/metric_submitter.rb

@@ -5,7 +5,8 @@ require "json"
 require "zlib"
 require "stringio"
 require "securerandom"
-require "socket"
+
+require_relative "client_headers"
 
 module Flare
   # Submits metrics to the Flare metrics service via HTTP.
@@ -13,7 +14,6 @@ module Flare
   class MetricSubmitter
     SCHEMA_VERSION = "V1"
     GZIP_ENCODING = "gzip"
-    USER_AGENT = "Flare Ruby/#{Flare::VERSION}"
 
     # Default timeouts (in seconds)
     DEFAULT_OPEN_TIMEOUT = 2
@@ -123,16 +123,11 @@ module Flare
       request["Content-Type"] = "application/json"
       request["Content-Encoding"] = GZIP_ENCODING
       request["Authorization"] = "Bearer #{@api_key}"
-      request["User-Agent"] = USER_AGENT
       request["X-Request-Id"] = request_id
       request["X-Schema-Version"] = SCHEMA_VERSION
 
-      # Client metadata headers (like Flipper)
-      request["X-Client-Language"] = "ruby"
-      request["X-Client-Language-Version"] = RUBY_VERSION
-      request["X-Client-Platform"] = RUBY_PLATFORM
-      request["X-Client-Pid"] = Process.pid.to_s
-      request["X-Client-Hostname"] = Socket.gethostname rescue "unknown"
+      # Client + version identifying headers, shared across every Flare-API request.
+      ClientHeaders.to_h.each { |name, value| request[name] = value }
 
       request.body = body
       response = http.request(request)

data/lib/flare/rule_manager.rb

@@ -5,6 +5,7 @@ require "logger"
 require "concurrent/timer_task"
 require "concurrent/atomic/atomic_fixnum"
 
+require_relative "client_headers"
 require_relative "http_transport"
 
 module Flare
@@ -118,11 +119,11 @@ module Flare
     end
 
     def request_headers
-      headers = {
+      headers = ClientHeaders.to_h.merge(
         "Authorization"     => "Bearer #{@api_key}",
         "Flare-Project"     => @project,
         "Flare-Environment" => @environment
-      }
+      )
       headers["If-None-Match"] = @etag if @etag
       headers
     end

data/lib/flare/trace_exporter.rb

@@ -8,6 +8,7 @@ require "uri"
 require "concurrent/atomic/atomic_fixnum"
 require "opentelemetry/sdk"
 
+require_relative "client_headers"
 require_relative "sampler"
 require_relative "trace_blob"
 require_relative "http_transport"
@@ -117,13 +118,16 @@ module Flare
       @logger.warn("[Flare::TraceExporter] notify exception: #{e.class}: #{e.message}")
     end
 
+    # Identifies the client on the Flare-API notify POST. The presigned R2
+    # PUT in #ship deliberately uses PUT_HEADERS only -- adding these there
+    # could invalidate the signed-header set.
     def notify_headers
-      {
+      ClientHeaders.to_h.merge(
         "Content-Type"      => "application/json",
         "Authorization"     => "Bearer #{@api_key}",
         "Flare-Project"     => @project,
         "Flare-Environment" => @environment
-      }
+      )
     end
 
     def record_put_failure(response)

data/lib/flare/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flare
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/flare.rb

@@ -5,6 +5,7 @@ require_relative "flare/configuration"
 
 require "opentelemetry/sdk"
 
+require_relative "flare/client_headers"
 require_relative "flare/source_location"
 require_relative "flare/metric_key"
 require_relative "flare/metric_storage"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flare
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - John Nunemaker
@@ -196,6 +196,7 @@ files:
 - lib/flare/cli/output.rb
 - lib/flare/cli/setup_command.rb
 - lib/flare/cli/status_command.rb
+- lib/flare/client_headers.rb
 - lib/flare/configuration.rb
 - lib/flare/engine.rb
 - lib/flare/filtering_span_processor.rb