Class: RailsSemanticLogger::Options

Inherits:

Object

Object
RailsSemanticLogger::Options

show all

Defined in:: lib/rails_semantic_logger/options.rb

Overview

Options for controlling Rails Semantic Logger behavior

Convert Action Controller and Active Record text messages to semantic data
```
Rails -- Started -- { :ip => "127.0.0.1", :method => "GET", :path => "/dashboards/inquiry_recent_activity" }
```
rubocop:disable Layout/LineLength UserController -- Completed #index -- { :action => "index", :db_runtime => 54.64, :format => "HTML", :method => "GET", :mongo_runtime => 0.0, :path => "/users", :status => 200, :status_message => "OK", :view_runtime => 709.88 } rubocop:enable Layout/LineLength
```
config.rails_semantic_logger.semantic = true
```
Change Rack started message to debug so that it does not appear in production
```
config.rails_semantic_logger.started = false
```
Change Processing message to debug so that it does not appear in production
```
config.rails_semantic_logger.processing = false
```

Change Action View render log messages to debug so that they do not appear in production

ActionView::Base --   Rendered data/search/_user.html.haml (46.7ms)

config.rails_semantic_logger.rendered = false

Override the Amazing Print options for logging Hash data as text:

Any valid Amazing Print option for rendering data.
The defaults can changed be creating a `~/.aprc` file.
See: https://github.com/amazing-print/amazing_print

Note: The option :multiline is set to false if not supplied.
Note: Has no effect if Amazing Print is not installed.

 config.rails_semantic_logger.ap_options = {multiline: false}

Whether to automatically add an environment specific log file appender. For Example: 'log/development.log'

Note:
When Semantic Logger fails to log to an appender it logs the error to an
internal logger, which by default writes to STDERR.
Example, change the default internal logger to log to stdout:
  SemanticLogger::Processor.logger = SemanticLogger::Appender::IO.new($stdout, level: :warn)

config.rails_semantic_logger.add_file_appender = true

DEPRECATED: declare appenders via #appenders instead. Declaring any appender there already replaces the default file appender, so this flag is no longer needed:

config.rails_semantic_logger.appenders { |appenders| appenders.add(file_name: ...) }

Silence asset logging

config.rails_semantic_logger.quiet_assets = false

Disable automatic logging to stderr when running a Rails console.
```
config.rails_semantic_logger.console_logger = false
```
DEPRECATED: declare a console appender explicitly via #appenders instead, or declare none to disable it:
```
config.rails_semantic_logger.appenders { |appenders| appenders.add_console(...) }
```

Override the output format for the primary Rails log file.

Valid options:
* :default
  Plain text output with no color.
* :color
  Plain text output with color.
* :json
  JSON output format.
* class

* Proc
  A block that will be called to format the output.
  It is supplied with the `log` entry and should return the formatted data.

Note:
* `:default` is automatically changed to `:color` if `config.colorize_logging` is `true`.

JSON Example, in `application.rb`:
 config.rails_semantic_logger.format = :json

Custom Example, create `app/lib/my_formatter.rb`:

# My Custom colorized formatter
class MyFormatter < SemanticLogger::Formatters::Color
  # Return the complete log level name in uppercase
  def level
    "#{color}log.level.upcase#{color_map.clear}"
  end
end

# In application.rb:
config.rails_semantic_logger.format = MyFormatter.new


config.rails_semantic_logger.format = :default

Add a filter to the file logger [Regexp|Proc] RegExp: Only include log messages where the class name matches the supplied regular expression. All other messages will be ignored. Proc: Only include log messages where the supplied Proc returns true. The Proc must return true or false.
```
config.rails_semantic_logger.filter = nil
```
Change the message format of Action Controller action. A block that will be called to format the message. It is supplied with the message and payload and should return the formatted data.
```
config.rails_semantic_logger.action_message_format = -> (message, payload) do
"#{message} - #{payload[:controller]}##{payload[:action]}"
end
```
Do not replace the Sidekiq logger with a Semantic Logger logger.
```
config.rails_semantic_logger.replace_sidekiq_logger = false
```

Do not replace the SolidQueue logger / log subscriber.

config.rails_semantic_logger.replace_solid_queue_logger = false

Constant Summary collapse

LOGGER_INIT_SETTINGS = Settings consumed while the logger itself is built, during Rails' :initialize_logger initializer. Changing them after that (e.g. from config/initializers/*, which Rails loads later) has no effect.

%i[semantic replace_sidekiq_logger replace_solid_queue_logger].freeze

POST_INIT_SETTINGS = Settings consumed as Rails finishes initializing (config.after_initialize), which runs after config/initializers/*. They may still be set there, but changing them after the application has booted has no effect.

%i[started processing rendered quiet_assets action_message_format].freeze

Instance Attribute Summary collapse

#add_file_appender ⇒ Object
DEPRECATED: configure these on the appender instead, via #appenders.
#ap_options ⇒ Object
DEPRECATED: configure these on the appender instead, via #appenders.
#console_logger ⇒ Object
DEPRECATED: configure these on the appender instead, via #appenders.
#filter ⇒ Object
DEPRECATED: configure these on the appender instead, via #appenders.
#format ⇒ Object
DEPRECATED: configure these on the appender instead, via #appenders.

Instance Method Summary collapse

#appenders ⇒ Object
Declare the appenders for Rails Semantic Logger to create, replacing the default file appender:.
#appenders? ⇒ Boolean
Whether the application declared its own appenders via #appenders.
#fully_initialized! ⇒ Object
Marks that Rails has finished initializing the application (the engine's config.after_initialize has run).
#initialize ⇒ Options constructor
Setup default values.
#logger_initialized! ⇒ Object
Marks that Rails Semantic Logger has already built its logger and the init-time appenders.

Constructor Details

#initialize ⇒ `Options`

Setup default values

# File 'lib/rails_semantic_logger/options.rb', line 156

def initialize
  @semantic                   = true
  @started                    = false
  @processing                 = false
  @rendered                   = false
  @ap_options                 = {multiline: false}
  @add_file_appender          = true
  @quiet_assets               = false
  @format                     = :default
  @filter                     = nil
  @console_logger             = true
  @action_message_format      = nil
  @replace_sidekiq_logger     = true
  @replace_solid_queue_logger = true
end