Use the `Timber::Logger` just like you would `::Logger`: ```ruby logger.debug("Debug message") logger.info("Info message") logger.warn("Warn message") logger.error("Error message") logger.fatal("Fatal message") ``` We encourage standard / traditional log messages for non-meaningful events. And because Timber [augments](https://timber.io/docs/concepts/structuring-through-augmentation) your logs with metadata, you don't have to worry about making every log structured! ---
Custom events allow you to extend beyond events already defined in the [`Timber::Events`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Events) namespace. If you aren't sure what an event is, please read the ["Metdata, Context, and Events" doc](https://timber.io/docs/concepts/metadata-context-and-events). ### How to use it ```ruby logger.warn "Payment rejected", payment_rejected: {customer_id: "abcd1234", amount: 100, reason: "Card expired"} ``` 1. [Search it](https://timber.io/docs/app/console/searching) with queries like: `type:payment_rejected` or `payment_rejected.amount:>100` 2. [Alert on it](https://timber.io/docs/app/console/alerts) with threshold based alerts 3. [Graph & visualize it](https://timber.io/docs/app/console/graphing) 4. [View this event's data and context](https://timber.io/docs/app/console/view-metdata-and-context) 5. ...read more in our [docs](https://timber.io/docs/languages/ruby/usage/custom-events) ---
Custom contexts allow you to extend beyond contexts already defined in the [`Timber::Contexts`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Contexts) namespace. If you aren't sure what context is, please read the ["Metdata, Context, and Events" doc](https://timber.io/docs/concepts/metadata-context-and-events). ### How to use it ```ruby logger.with_context(build: {version: "1.0.0"}) do logger.info("My log message") end ``` 1. [Search it](https://timber.io/docs/app/console/searching) with queries like: `build.version:1.0.0` 2. [View this context when viewing a log's metadata](https://timber.io/docs/app/console/view-metdata-and-context) 3. ...read more in our [docs](https://timber.io/docs/languages/ruby/usage/custom-context) ---
Aggregates destroy details, events tell stories. With Timber, logging metrics and timings is simply [logging an event](https://timber.io/docs/languages/ruby/usage/custom-events). Timber is based on modern big-data principles and can aggregate inordinately large data sets in seconds. Logging events (raw data as it exists), gives you the flexibility in the future to segment and aggregate your data any way you see fit. This is superior to choosing specific paradigms before hand, when you are unsure how you'll need to use your data in the future. ### How to use it Below is a contrived example of timing a background job: ```ruby timer = Timber::Timer.start # ... code to time ... logger.info("Processed background job", background_job: {time_ms: timer}) ``` And of course, `time_ms` can also take a `Float` or `Fixnum`: ```ruby logger.info("Processed background job", background_job: {time_ms: 45.6}) ``` Lastly, metrics aren't limited to timings. You can capture any metric you want: ```ruby logger.info("Credit card charged", credit_card_charge: {amount: 123.23}) ``` 1. [Search it](https://timber.io/docs/app/console/searching) with queries like: `background_job.time_ms:>500` 2. [Alert on it](https://timber.io/docs/app/console/alerts) with threshold based alerts 3. [View this log's metadata in the console](https://timber.io/docs/app/console/view-metdata-and-context) 4. ...read more in our [docs](https://timber.io/docs/languages/ruby/usage/metrics-and-timings)
Timber allows you to silence noisy logs that aren't of value to you, just like [lograge](https://github.com/roidrage/lograge). As such, we've provided a convenience configuration option for anyone transitioning from lograge. ### How to use it ```ruby # config/initializers/timber.rb config = Timber::Config.instance config.logrageify!() ``` ## How it works It turns this: ``` Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100 Processing by HomeController#index as HTML Rendered text template within layouts/application (0.0ms) Rendered layouts/_assets.html.erb (2.0ms) Rendered layouts/_top.html.erb (2.6ms) Rendered layouts/_about.html.erb (0.3ms) Rendered layouts/_google_analytics.html.erb (0.4ms) Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms) ``` Into this: ``` Get "/" sent 200 OK in 79ms @metadata {...} ``` Internally this is equivalent to: ```ruby # config/initializers/timber.rb config = Timber::Config.instance config.integrations.action_controller.silence = true config.integrations.action_view.silence = true config.integrations.active_record.silence = true config.integrations.rack.http_events.collapse_into_single_event = true ``` ### Pro-tip: Keep controller call logs (recommended) Feel free to deviate and customize which logs you silence. We recommend a slight deviation from lograge with the following settings: ```ruby # config/initializers/timber.rb config = Timber::Config.instance config.integrations.action_view.silence = true config.integrations.active_record.silence = true config.integrations.rack.http_events.collapse_into_single_event = true ``` This does _not_ silence the controller call log event. This is because Timber captures the parameters passed to the controller, which are generally valuable when debugging. For a full list of integration settings, see [Timber::Config::Integrations](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config/Integrations) ---
Silencing noisy requests can be helpful for silencing load balance health checks, bot scanning, or activity that generally is not meaningful to you. ### How to use it The following will silence all `[GET] /_health` requests: ```ruby # config/initializers/timber.rb config = Timber::Config.instance config.integrations.rack.http_events.silence_request = lambda do |rack_env, rack_request| rack_request.path == "/_health" end ``` We require a block because it gives you complete control over how you want to silence requests. The first parameter being the traditional Rack env hash, the second being a [Rack Request](http://www.rubydoc.info/gems/rack/Rack/Request) object. ---
By default Timber automatically captures user context for most of the popular authentication libraries (Devise, Omniauth, and Clearance). See [Timber::Integrations::Rack::UserContext](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Integrations/Rack/UserContext) for a complete list. ### How to use it In cases where you Timber doesn't support your strategy, or you want to customize it further, you can do so like: ```ruby # config/initializers/timber.rb config = Timber::Config.instance config.integrations.rack.user_context.custom_user_hash = lambda do |rack_env| user = rack_env['warden'].user if user { id: user.id, # unique identifier for the user, can be an integer or string, name: user.name, # identifiable name for the user, email: user.email, # user's email address } else nil end end ``` *All* of the user hash keys are optional, but you must provide at least one. ---
[Timber::Contexts::Release](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Contexts/Release) tracks the current application release and version. ### How to use it If you're on Heroku, simply enable the [dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata) feature. If you are not, set the following environment variables and this context will be added automatically: 1. `RELEASE_COMMIT` - Ex: `2c3a0b24069af49b3de35b8e8c26765c1dba9ff0` 2. `RELEASE_CREATED_AT` - Ex: `2015-04-02T18:00:42Z` 3. `RELEASE_VERSION` - Ex: `v2.3.1` All variables are optional, but at least one must be present. ---