Class: LogStruct::Configuration

Inherits:
T::Struct
  • Object
show all
Extended by:
T::Sig
Includes:
Sorbet::SerializeSymbolKeys
Defined in:
lib/log_struct/configuration.rb

Overview

Core configuration class that provides a type-safe API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Sorbet::SerializeSymbolKeys

#serialize, #to_h

Constructor Details

#initialize(enabled: true, enabled_environments:, local_environments:, prefer_json_in_development: true, enable_color_output: true, color_map: nil, filter_noisy_loggers: false, integrations:, filters:, string_scrubbing_handler: nil, error_reporting_handler: nil, error_handling_modes:) ⇒ void

Parameters:

  • enabled (Boolean) (defaults to: true) —

    Props

  • enabled_environments (Array<Symbol>)
  • local_environments (Array<Symbol>)
  • prefer_json_in_development (Boolean) (defaults to: true) —

    Prefer production-style JSON in development when LogStruct is enabled

  • enable_color_output (Boolean) (defaults to: true) —

    Enable colorful human formatter in development

  • color_map (Hash{Symbol => Symbol}, nil) (defaults to: nil) —

    Custom color map for the color formatter

  • filter_noisy_loggers (Boolean) (defaults to: false) —

    Filter noisy loggers (ActionView, etc.)

  • integrations (ConfigStruct::Integrations)
  • filters (ConfigStruct::Filters)
  • string_scrubbing_handler (Handlers::StringScrubber, nil) (defaults to: nil) —

    Custom log scrubbing handler for any additional string scrubbing Default: nil

  • error_reporting_handler (Handlers::ErrorReporter, nil) (defaults to: nil) —

    Custom handler for error reporting Default: Errors are handled by MultiErrorReporter (auto-detects Sentry, Bugsnag, Rollbar, Honeybadger, etc.)

  • error_handling_modes (ConfigStruct::ErrorHandlingModes) —

    How to handle errors from various sources




# File ''

prop :enabled, T::Boolean, default: true
prop :enabled_environments, T::Array[Symbol], factory: -> { [:test, :production] }
prop :local_environments, T::Array[Symbol], factory: -> { [:development, :test] }
prop :prefer_json_in_development, T::Boolean, default: true
prop :enable_color_output, T::Boolean, default: true
prop :color_map, T.nilable(T::Hash[Symbol, Symbol]), default: nil
prop :filter_noisy_loggers, T::Boolean, default: false
const :integrations, ConfigStruct::Integrations, factory: -> { ConfigStruct::Integrations.new }
const :filters, ConfigStruct::Filters, factory: -> { ConfigStruct::Filters.new }
prop :string_scrubbing_handler, T.nilable(Handlers::StringScrubber)
prop :error_reporting_handler, T.nilable(Handlers::ErrorReporter), default: nil
const :error_handling_modes,
ConfigStruct::ErrorHandlingModes,
factory: -> {
  ConfigStruct::ErrorHandlingModes.new
}

Instance Attribute Details

#color_map ⇒ Hash{Symbol => Symbol}?

Custom color map for the color formatter

Returns:

  • (Hash{Symbol => Symbol}, nil) 



# File ''

prop :color_map, T.nilable(T::Hash[Symbol, Symbol]), default: nil

#enable_color_output ⇒ Boolean

Enable colorful human formatter in development

Returns:

  • (Boolean) 



# File ''

prop :enable_color_output, T::Boolean, default: true

#enabled ⇒ Boolean

Props

Returns:

  • (Boolean) 



# File ''

prop :enabled, T::Boolean, default: true

#enabled_environments ⇒ Array<Symbol>

Returns the value of prop enabled_environments.

Returns:

  • (Array<Symbol>) 



# File ''

prop :enabled_environments, T::Array[Symbol], factory: -> { [:test, :production] }

#error_handling_modes ⇒ ConfigStruct::ErrorHandlingModes (readonly)

How to handle errors from various sources

Returns:




# File ''

const :error_handling_modes,
ConfigStruct::ErrorHandlingModes,
factory: -> {
  ConfigStruct::ErrorHandlingModes.new
}

#error_reporting_handler ⇒ Handlers::ErrorReporter?

Custom handler for error reporting Default: Errors are handled by MultiErrorReporter (auto-detects Sentry, Bugsnag, Rollbar, Honeybadger, etc.)

Returns:




# File ''

prop :error_reporting_handler, T.nilable(Handlers::ErrorReporter), default: nil

#filter_noisy_loggers ⇒ Boolean

Filter noisy loggers (ActionView, etc.)

Returns:

  • (Boolean) 



# File ''

prop :filter_noisy_loggers, T::Boolean, default: false

#filters ⇒ ConfigStruct::Filters (readonly)

Returns the value of prop filters.

Returns:




# File ''

const :filters, ConfigStruct::Filters, factory: -> { ConfigStruct::Filters.new }

#integrations ⇒ ConfigStruct::Integrations (readonly)

Returns the value of prop integrations.

Returns:




# File ''

const :integrations, ConfigStruct::Integrations, factory: -> { ConfigStruct::Integrations.new }

#local_environments ⇒ Array<Symbol>

Returns the value of prop local_environments.

Returns:

  • (Array<Symbol>) 



# File ''

prop :local_environments, T::Array[Symbol], factory: -> { [:development, :test] }

#prefer_json_in_development ⇒ Boolean

Prefer production-style JSON in development when LogStruct is enabled

Returns:

  • (Boolean) 



# File ''

prop :prefer_json_in_development, T::Boolean, default: true

#string_scrubbing_handler ⇒ Handlers::StringScrubber?

Custom log scrubbing handler for any additional string scrubbing Default: nil

Returns:




# File ''

prop :string_scrubbing_handler, T.nilable(Handlers::StringScrubber)

Class Method Details

.instance ⇒ Configuration

Returns:



63
64
65
 
# File 'lib/log_struct/configuration.rb', line 63

def self.instance
  @instance ||= T.let(Configuration.new, T.nilable(Configuration))
end

.set_instance(config) ⇒ void

This method returns an undefined value.

Parameters:



68
69
70
 
# File 'lib/log_struct/configuration.rb', line 68

def self.set_instance(config)
  @instance = config
end