Module: WebValve

Defined in:
lib/webvalve.rb,
lib/webvalve/manager.rb,
lib/webvalve/railtie.rb,
lib/webvalve/version.rb,
lib/webvalve/fake_service.rb,
lib/webvalve/fake_service_config.rb,
lib/webvalve/fake_service_wrapper.rb,
lib/webvalve/instrumentation/middleware.rb,
lib/webvalve/instrumentation/log_subscriber.rb

Defined Under Namespace

Modules: Instrumentation Classes: FakeService, FakeServiceConfig, FakeServiceWrapper, Manager, Railtie

Constant Summary collapse

ALWAYS_ENABLED_ENVS = 
%w(development test).freeze
ENABLED_VALUES = 
%w(1 t true).freeze
VERSION = 
"0.9.9"

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.logger ⇒ Object 



39
40
41
42
43
44
45
46
47
 
# File 'lib/webvalve.rb', line 39

def logger
  @logger ||=
    if defined?(::Rails)
      # Rails.logger can be nil
      ::Rails.logger || default_logger
    else
      default_logger
    end
end

Class Method Details

.config_paths ⇒ Object 



35
36
37
 
# File 'lib/webvalve.rb', line 35

def config_paths
  @config_paths ||= Set.new
end

.default_logger ⇒ Object 



49
50
51
52
53
 
# File 'lib/webvalve.rb', line 49

def default_logger
  ActiveSupport::Logger.new(STDOUT).tap do |l|
    l.formatter = ::Logger::Formatter.new
  end
end

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/webvalve.rb', line 21

def enabled?
  if env.in?(ALWAYS_ENABLED_ENVS)
    if ENV.key? 'WEBVALVE_ENABLED'
      logger.warn(<<~MESSAGE)
        WARNING: Ignoring WEBVALVE_ENABLED environment variable setting (#{ENV['WEBVALVE_ENABLED']})
        WebValve is always enabled in development and test environments.
      MESSAGE
    end
    true
  else
    ENABLED_VALUES.include?(ENV['WEBVALVE_ENABLED'])
  end
end

.manager ⇒ Object 



67
68
69
 
# File 'lib/webvalve.rb', line 67

def manager
  WebValve::Manager.instance
end

.register ⇒ Object

See Also:



18
 
# File 'lib/webvalve.rb', line 18

delegate :setup, :register, :whitelist_url, :reset, to: :manager

.reset ⇒ Object

See Also:



18
 
# File 'lib/webvalve.rb', line 18

delegate :setup, :register, :whitelist_url, :reset, to: :manager

.setup ⇒ Object

See Also:



18
 
# File 'lib/webvalve.rb', line 18

delegate :setup, :register, :whitelist_url, :reset, to: :manager

.whitelist_url ⇒ Object

See Also:



18
 
# File 'lib/webvalve.rb', line 18

delegate :setup, :register, :whitelist_url, :reset, to: :manager

Instance Method Details

#env ⇒ Object 



58
59
60
 
# File 'lib/webvalve.rb', line 58

def env
  @env ||= (ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development').inquiry
end

#env=(env) ⇒ Object 



62
63
64
 
# File 'lib/webvalve.rb', line 62

def env=(env)
  @env = env&.inquiry
end