Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
shipit.rubygems.yml
structured-event-logger.gemspec

README.md

StructuredEventLogger

Build Status

Structured event logger that submits events to a list of listeners, including human readable logs, json formatted event streams, and other endpoints.

Installation

Add this line to your application's Gemfile:

gem 'structured-event-logger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install structured-event-logger

Usage

# Creating an instance of a StructuredEventLogger with several endpoints.
# The listeners provided to the constructors should respond to #log_event.
json_io = File.open(Rails.root.join("log", "event.log"), "a")
event_logger = StructuredEventLogger.new(
    logger: StructuredEventLogger::HumanReadableLogger.new(Rails.logger),
    json:   StructuredEventLogger::JsonWriter.new(json_io)
)

# Basic usage
event_logger.event('scope', event, field: 'value', other_field: 'other value')

# Add context per thread/request (e.g. in an around_filter)
around_filter do
  event_logger.context[:my_value] = 'whatever'
  yield
  event_logger.context.delete(:my_value)
end

# later, while processing a request inside that filter
event_logger.event('scope', 'event', other_value: 'blah') # will also include { my_value: 'whatever' }

Fields

The default event fields that this library sets are prefixed with event_:

  • event_scope: scope of the event, the first parameter to the event call.
  • event_name: name of the event, the second parameter to the event call.
  • event_uuid: A unique identifier for the event generated using SecureRandom.uuid.
  • event_timestamp: The timestamp of the event, set to Time.now.utc.

All these fields can be overriden by passing new values to the context hash, i.e. the third parameter to the event call.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.