bitfab 0.51.8 → 0.51.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb890a0d2b1a3c73861202e60fd33bec34064055b1f504f8e00e5f3528637b63
-  data.tar.gz: 8458309c3af142a661f499797744bc6c729fec269c8b781a99e6b18061baf323
+  metadata.gz: f468d991f207bab17dbf93e1d8336e293aa2d759a83a31a8eee7631f1e93daa8
+  data.tar.gz: 4ab69ab42011952d9611a3708ed9f4308760aeb839eaa109ba413a798d5c59d4
 SHA512:
-  metadata.gz: a3a704cae73ccb79b7470715b4c695856bd0d4c1dddb7b9ff55964a638dda96bc7f218334c69033eb019d40d16ec9de27492c412b921af547d440c62abf40f8e
-  data.tar.gz: c79764db436a2ea1855626e8cae7d8dbdde77e50012e703a78a8c25739efeaf7bb7d48dcc8e5c6f3c5d6c818a554cb6615d3edc315a12b7b73824896c44a6074
+  metadata.gz: fcd27044d500aa10fb278940b3665cd54e27c2732e011e828bdd778dc598807960ae84686968957d48fd279f26dc93e2ff72cc1c8ccfa8a91824235548f0b394
+  data.tar.gz: 5c3c831e7c6e30e5ea9f8aaa2a5d63f55f561c831e57caa87504a86b7d73cfc62a98260c943f4024b664c9d6a419bb0b2727e83952dc10f0f62ba4bdb3b496ad

data/README.md

@@ -72,7 +72,7 @@ Bitfab.configure(
 
 ### Disabling Span Sending
 
-The `enabled` option controls whether spans are sent to Bitfab. When disabled, your code executes normally but no spans are created or sent.
+The `enabled` option controls whether spans are sent to Bitfab. When disabled, your code executes normally but no spans are created or sent. Leave it out and `BITFAB_CAPTURE_ENABLED` decides: `1`, `true`, or `yes` sends spans, `0`, `false`, or `no` stops them, and sending stays on when the variable is unset.
 
 ```ruby
 # Disable tracing (useful for development/test environments)
@@ -91,10 +91,10 @@ Bitfab.configure(
   enabled: Rails.env.production?
 )
 
-# Environment variable control
+# Environment variable control: leave enabled: out and set BITFAB_CAPTURE_ENABLED
+# to 0 or 1 in the environment. Anything passed here wins over it.
 Bitfab.configure(
-  api_key: ENV.fetch('BITFAB_API_KEY', 'dummy-key'),
-  enabled: ENV.fetch('BITFAB_ENABLED', 'false') == 'true'
+  api_key: ENV.fetch('BITFAB_API_KEY', 'dummy-key')
 )
 
 # Multi-environment control

data/lib/bitfab/client.rb

@@ -4,6 +4,7 @@ require "securerandom"
 require "time"
 
 require_relative "constants"
+require_relative "env"
 require_relative "http_client"
 require_relative "replay"
 require_relative "span_context"
@@ -37,11 +38,12 @@ module Bitfab
     # Trace lookup operations for the authenticated organization.
     attr_reader :traces
 
-    def initialize(api_key: nil, service_url: nil, enabled: true, strict: false)
+    def initialize(api_key: nil, service_url: nil, enabled: nil, strict: false)
       @api_key_config = api_key
       @service_url = service_url || DEFAULT_SERVICE_URL
       # The user's on/off intent; effective enabled also requires a resolved key.
-      @explicitly_enabled = enabled
+      @enabled_in_code = enabled
+      @capture_configured_from_env = nil
       @strict = strict
       # Cached only once a non-empty key is found, so an early resolve (before
       # env loaded) can't poison a later one.
@@ -654,17 +656,25 @@ module Bitfab
           "Bitfab.configure. If a script loads env later, load it before the first " \
           "traced call, or pass api_key: -> { ENV[\"BITFAB_API_KEY\"] }."
       end
-      if @explicitly_enabled && !@api_key_warned
+      if capture_configured? && !@api_key_warned
         @api_key_warned = true
         warn("Bitfab: api_key is empty: tracing is disabled. Provide a valid API key to enable tracing.")
       end
       nil
     end
 
+    def capture_configured?
+      return @enabled_in_code unless @enabled_in_code.nil?
+      return @capture_configured_from_env unless @capture_configured_from_env.nil?
+
+      from_env = Bitfab.read_boolean_env(CAPTURE_ENABLED_ENV)
+      @capture_configured_from_env = from_env.nil? || from_env
+    end
+
     # Whether tracing should run, decided lazily at call time. An explicit
     # `enabled: false` short-circuits without ever touching the key.
     def tracing_enabled?
-      return false unless @explicitly_enabled
+      return false unless capture_configured?
 
       !resolve_api_key.nil?
     end

data/lib/bitfab/constants.rb

@@ -2,6 +2,7 @@
 
 module Bitfab
   DEFAULT_SERVICE_URL = "https://bitfab.ai"
+  CAPTURE_ENABLED_ENV = "BITFAB_CAPTURE_ENABLED"
   REPLAY_CONTEXT_KEY = :__bitfab_replay_context
 
   # Wire prefix the Bitfab plugin scans for on stderr to report live progress

data/lib/bitfab/env.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "warn_once"
+
+module Bitfab
+  TRUE_ENV_VALUES = %w[1 true yes].freeze
+  FALSE_ENV_VALUES = %w[0 false no].freeze
+  private_constant :TRUE_ENV_VALUES, :FALSE_ENV_VALUES
+
+  class << self
+    def read_boolean_env(name)
+      raw = ENV[name]
+      return nil if raw.nil?
+
+      value = raw.strip.downcase
+      return nil if value.empty?
+      return true if TRUE_ENV_VALUES.include?(value)
+      return false if FALSE_ENV_VALUES.include?(value)
+
+      warn_once(
+        "unrecognized-boolean-env:#{name}",
+        "#{name}=\"#{raw}\" is not 0 or 1; ignoring it."
+      )
+      nil
+    end
+  end
+end

data/lib/bitfab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitfab
-  VERSION = "0.51.8"
+  VERSION = "0.51.9"
 end

data/lib/bitfab.rb

@@ -79,7 +79,7 @@ module Bitfab
     # @example
     #   Bitfab.configure(api_key: ENV["BITFAB_API_KEY"])
     #
-    def configure(api_key: nil, service_url: nil, enabled: true, strict: false)
+    def configure(api_key: nil, service_url: nil, enabled: nil, strict: false)
       @client = Client.new(api_key:, service_url:, enabled:, strict:)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.51.8
+  version: 0.51.9
 platform: ruby
 authors:
 - Harvest Team
@@ -145,6 +145,7 @@ files:
 - lib/bitfab/constants.rb
 - lib/bitfab/datasets.rb
 - lib/bitfab/db_snapshot.rb
+- lib/bitfab/env.rb
 - lib/bitfab/git_command.rb
 - lib/bitfab/git_state.rb
 - lib/bitfab/http_client.rb