vectordotdev / timber-ruby

🌲 Great Ruby logging made easy.

🌲 Timber - Great Ruby Logging Made Easy

Timber.io is a hosted service for aggregating logs across your entire stack - any language, any platform, any data source.

Unlike traditional logging tools, Timber integrates with language runtimes to automatically capture in-app context, turning your text-based logs into rich structured events. Timber integrates with Ruby through this library. And Timber's rich free-form query tools and real-time tailing, make drilling down into important stats easier than ever.

---

Features

• Simple integration. Exposes the same API as the Ruby Logger.
• Performant, light-weight, and thoughtful design.
• Support for structured logging.
• Support for context.
• Automatic context capturing.
• Integrates with popular 3rd party libraries, such as Rails and Rack.

---

Get Started

• Installation
• Configuration
• Usage
• Guides
• Integrations
• Performance

---

Timber • Docs • Pricing • Security • Compliance

timber-ruby's Issues

Add a active merchant probe

Add a probe / context for active merchant.

Provide a simple timing API

We had a client request something like:

logger.time("message", ...) do
  # code to time
end

Implement context specific attributes

Context docs have these specific attributes

1. dt
2. index
3. success
4. time_ms

Make rails installation more obvious

Some people are not noticing the rails installation step.

Add a colorize option and respect existing framework option

We need an option to turn off colorizing, this should default to the framework's setting.

Add an action cable probe

Add a probe / contexts for action cable.

Release gem

Currently in alpha testing and am not bothering with a gem to reduce the iteration cycle.

Add sinatra support

Support sinatra in the same way that we support rails.

Update to new server and process schema

^

Update with new alpha changes

Epic for migrating to the new alpha changes

Add an action mailer probe

Add context for action mailer emails.

Error in staging and no more logs are shown

Hi I am getting this error in the Timber console and no more logs are shown:

Could not log "start_processing.action_controller" event. NameError: uninitialized constant Timber::Events::ControllerCall::SANITIZED_VALUE

followed by a long traceback

This does not happen in production, only in staging.
To differentiate between the 2, I am using an environment variable:

production.rb

  # Install the Timber.io logger, send logs over HTTP
  log_device = Timber::LogDevices::HTTP.new(ENV["TIMBER_API_KEY"])
  logger = Timber::Logger.new(log_device)
  logger.level = config.log_level
  config.logger = ActiveSupport::TaggedLogging.new(logger)

Rails 5.0.2 EC2 Ubuntu 16.04

Dynamic values should be sent as a map

We don't need to cast dynamic values into the underlying API array format. The API is handling the conversion now.

Ensure all context and event attributes are casted to the proper types

Our log event JSON schema is string. For example, if we get an integer instead of a string for Timber::Contexts::System#pid validation will fail. We need to ensure all attributes are casted properly.

Scrub sensitive parameters

Rails provides this, but we grab parameters within a rack middleware. We need to ensure that params are scrubbed and also provide options to add additional parameters (this should fallback to the rails settings).

Improve test coverage to 100%

Still in the early phases, but we should get to 100% before we launch out of beta.

Context should be an array

The context structure should be an array of context docs in the order of the hierarchy.

Test all context and event hashes against the log event json schema

This ensures changes are valid with the specified schema version

Add a sidekiq probe

Add a probe / context for sidekiq.

Option to write JSON ecoded lines to a log

Advanced users might want to forgo the built in log transport strategy and write their logs to an intermediary destination where an agent will tail and send the logs to our API. A good example is the heroku log drains. It is more efficient to write the JSON payload to STDOUT and have heroku handle the transport.

Check for missing files during the installer process

We need to handle missing files and failed changes better when we're updating files like production.rb. Current it just errors, we can ask the user to manually provide the path, etc.

HTTP response should be nested under HTTP request

We moved http_response under http_request, they are coupled by nature.

Make collecting context optional / conditional

This should be an optional feature in the event people want the raw log lines only. Perhaps the ability to turn of individual contexts as well?

Update installer to confirm application details like our elixir installer

Do not prompt for Heroku installation if the app is receiving logs

Nil Error: "undefined method `encoding' for nil:NilClass"

Rails 4.0.13
Timber 2.0.14

undefined method `encoding' for nil:NilClass

Stack trace that relates to timber

/gems/timber-2.0.14/lib/timber/util/string.rb:9 in normalize_to_utf8
/gems/timber-2.0.14/lib/timber/util/http_event.rb:31 in block in normalize_headers
/gems/timber-2.0.14/lib/timber/util/http_event.rb:27 in each
/gems/timber-2.0.14/lib/timber/util/http_event.rb:27 in each_with_object
/gems/timber-2.0.14/lib/timber/util/http_event.rb:27 in normalize_headers
/gems/timber-2.0.14/lib/timber/events/http_server_request.rb:13 in initialize
/gems/timber-2.0.14/lib/timber/integrations/rack/http_events.rb:15 in new
/gems/timber-2.0.14/lib/timber/integrations/rack/http_events.rb:15 in block in call
/usr/local/rvm/rubies/ruby-2.1.3/lib/ruby/2.1.0/logger.rb:372 in add
/gems/timber-2.0.14/lib/timber/logger.rb:232 in info
/gems/timber-2.0.14/lib/timber/integrations/rack/http_events.rb:14 in call
/gems/timber-2.0.14/lib/timber/integrations/rack/user_context.rb:21 in call
/gems/timber-2.0.14/lib/timber/integrations/rack/session_context.rb:18 in call
/gems/timber-2.0.14/lib/timber/integrations/rack/http_context.rb:19 in block in call
/gems/timber-2.0.14/lib/timber/current_context.rb:65 in with
/gems/timber-2.0.14/lib/timber/current_context.rb:18 in with
/gems/timber-2.0.14/lib/timber/integrations/rack/http_context.rb:18 in call

Send pre-flight request on HTTP initialization

This ensure the HTTP device is setup properly.

Add option to capture context if no log lines were written

In certain circumstances a context will be set but a log line will not be written. We should allow a safety / default log line to be written so that it gets sent to the Timber API. The ensures context data does not get lost if this is desired.

Change `Logger` method signature to support options

The ruby Logger currently takes one parameter for it's info, warn, etc methods. As a result, of our "no risk of lock-in" policy, it requires us to do:

Logger.info(message: "My message", data: "value")

People will absolutely forget to do that because they are not used to logging hashes of that manner. I propose we allow:

Logger.info("My message", data: "value")

This requires us to change the default Logger method signatures, but it's so much more user friendly.

Add a delayed job probe

Add a probe / context for delayed job.

Add option to log and trace network requests

Adding network request details to the logs provides insight into service interaction. If this is performed within a http request we should carry over the request_id so that this can be traced.

Fix heroku log drain instructions

The actual command is something like heroku drains:add https://id:[email protected]/heroku/logplex_frames
--app=app-name

Capture dyno metadata is present

https://devcenter.heroku.com/articles/dyno-metadata

Move level to the root document

We no longer have a logger context, level is on the root log line document.

Consider staging and production environments during installation

There are a few instances where this can overlap. I'm not entirely sure what we can do here, but it's worth thinking about and specifying reasons for closing.

Fix require: true for Gemfile

require: true in the Gemfile should work.

Timber delimited context should be a full context json doc

When the alpha API is released we'll need to switch the context delimited data to be structured as JSON instead of logfmt. This should also include the root context key.

Git commands in the installer are out of date

We need to update these, they currently specify an initializer that doesn't exist.

Update docs to follow new format

We need this to pull install instructions, etc.

Check for lograge existence

This conflicts with out gem.

Include Timber API errors and retry count as headers in the HTTP client

If the HTTP client fails a request, we'll get an error from the Timber service. I'd like to record this, as well as the retry count, and include it in subsequent retries so that we can report on it. Ideally these would be headers.

Capture log tags

For ActiveSupport::TaggedLogger we should capture the log tags.

Ensure that events, etc, are logged properly in dev / test

Add a resque probe

Add a probe / context for resque.

Consider a simple log instantiator

Rails is a little nuts with it's Logger classes. Example:

config.logger = ::ActiveSupport::TaggedLogging.new(::ActiveSupport::Logger.new(Timber::LogDevices::HerokuLogplex.new))

1. ActiveSupport::TaggedLogging is only in >= 3.2
2. ActiveSupport::Logger is only in >= 3.2

We'll get support tickets saying it doesn't work for older rails versions. We could do:

Timber::Logger.default(Timber::LogDevices::HerokuLogplex.new)

Where all of this class checking is done within that method.

Timber causes 500 if Rack env contains Symbol keys

Example exception: https://sentry.io/share/issue/3136313033372e323738373237393632/

It's not uncommon for certain middleware to add their own keys to the rack env that have nothing to do with HTTP. Often, these are symbols. In my case, the authentication library Clearance is doing this.

Document code

Finish documenting code and throw it on a docs site. Most likely rdoc.info.

Document custom contexts

We need to ensure setting custom contexts is easy and document it well. This should map to dynamic fields within the API.

Provide option to filter headers

Users need a way to filter additional headers via the configuration.

Add a server probe to track restarts

We need a way to track server restarts. Thin, mongrel, unicorn all log when they boot up.