Module: Timber

Defined in:

lib/timber.rb,
lib/timber/cli.rb,
lib/timber/util.rb,
lib/timber/event.rb,
lib/timber/timer.rb,
lib/timber/cli/io.rb,
lib/timber/config.rb,
lib/timber/events.rb,
lib/timber/logger.rb,
lib/timber/cli/api.rb,
lib/timber/context.rb,
lib/timber/version.rb,
lib/timber/contexts.rb,
lib/timber/log_entry.rb,
lib/timber/overrides.rb,
lib/timber/util/hash.rb,
lib/timber/frameworks.rb,
lib/timber/integrator.rb,
lib/timber/cli/io/ansi.rb,
lib/timber/integration.rb,
lib/timber/log_devices.rb,
lib/timber/util/struct.rb,
lib/timber/events/error.rb,
lib/timber/integrations.rb,
lib/timber/util/request.rb,
lib/timber/cli/installer.rb,
lib/timber/cli/os_helper.rb,
lib/timber/contexts/http.rb,
lib/timber/contexts/user.rb,
lib/timber/events/custom.rb,
lib/timber/cli/installers.rb,
lib/timber/cli/config_file.rb,
lib/timber/cli/file_helper.rb,
lib/timber/cli/io/messages.rb,
lib/timber/contexts/custom.rb,
lib/timber/contexts/system.rb,
lib/timber/current_context.rb,
lib/timber/contexts/release.rb,
lib/timber/contexts/runtime.rb,
lib/timber/contexts/session.rb,
lib/timber/events/exception.rb,
lib/timber/events/sql_query.rb,
lib/timber/frameworks/rails.rb,
lib/timber/log_devices/http.rb,
lib/timber/integrations/rack.rb,
lib/timber/integrations/rails.rb,
lib/timber/cli/api/application.rb,
lib/timber/cli/installers/root.rb,
lib/timber/config/integrations.rb,
lib/timber/events/http_request.rb,
lib/timber/cli/installers/other.rb,
lib/timber/cli/installers/rails.rb,
lib/timber/events/http_response.rb,
lib/timber/contexts/organization.rb,
lib/timber/events/controller_call.rb,
lib/timber/events/template_render.rb,
lib/timber/config/integrations/rack.rb,
lib/timber/integrations/action_view.rb,
lib/timber/util/attribute_normalizer.rb,
lib/timber/util/non_nil_hash_builder.rb,
lib/timber/cli/installers/config_file.rb,
lib/timber/integrations/active_record.rb,
lib/timber/integrations/action_dispatch.rb,
lib/timber/integrations/rack/middleware.rb,
lib/timber/integrations/rack/error_event.rb,
lib/timber/integrations/rack/http_events.rb,
lib/timber/integrations/action_controller.rb,
lib/timber/integrations/rack/http_context.rb,
lib/timber/integrations/rack/user_context.rb,
lib/timber/integrations/rails/rack_logger.rb,
lib/timber/log_devices/http/request_attempt.rb,
lib/timber/integrations/rack/session_context.rb,
lib/timber/util/active_support_log_subscriber.rb,
lib/timber/integrations/action_view/log_subscriber.rb,
lib/timber/overrides/active_support_tagged_logging.rb,
lib/timber/integrations/active_record/log_subscriber.rb,
lib/timber/integrations/action_controller/log_subscriber.rb,
lib/timber/integrations/action_dispatch/debug_exceptions.rb,
lib/timber/log_devices/http/flushable_dropping_sized_queue.rb,
lib/timber/integrations/action_view/log_subscriber/timber_log_subscriber.rb,
lib/timber/integrations/active_record/log_subscriber/timber_log_subscriber.rb,
lib/timber/integrations/action_controller/log_subscriber/timber_log_subscriber.rb

Defined Under Namespace

Modules: Contexts, Events, Integration, Integrations, Timer Classes: Config, CurrentContext, Integrator, LogEntry, Logger

Constant Summary

VERSION =

"2.6.1"

Class Method Summary

• .config ⇒ Object

  Access the main configuration object.

• .start_timer ⇒ Object

  Starts a timer for timing events.

• .with_context(context, &block) ⇒ Object

  Adds context to all logs written within the passed block.

Class Method Details

.config ⇒ Object

Access the main configuration object. Please see {Timber{Timber::Config} for more details.

# File 'lib/timber.rb', line 22

def self.config
  Config.instance
end

.start_timer ⇒ Object

Starts a timer for timing events. Please see {Timber{Timber::Timber{Timber::Timber.start} for more details.

# File 'lib/timber.rb', line 27

def self.start_timer
  Timer.start
end

.with_context(context, &block) ⇒ Object

Adds context to all logs written within the passed block. Please see {Timber{Timber::CurrentContext{Timber::CurrentContext.with} for a more detailed description with examples.

# File 'lib/timber.rb', line 33

def self.with_context(context, &block)
  CurrentContext.with(context, &block)
end