Hivelog

Hivebrite ECS events logger. It supports stdout and elasticsearch output.

ECS Reference

Installation

Add this line to your application's Gemfile:

gem 'hivelog'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hivelog

Usage

    labels = {
      environment: "production",
      application: "ror"
    }

    options = {
      event: event,
      user: user,
      group: group,
      tags: tags
    }

    Hivelogger = Hivelog::Logger.new(:stdout, @labels)

    Hivelogger.debug("deb ya", options)
    Hivelogger.warn("warning message", options)
    Hivelogger.info("information message", options)
    Hivelogger.error("error message", options)

Each log is a sentence, meaning it shoud always start with a capital letter and end with a period.

Hivelog's schema should respect ECS guidelines (current version is 1.7) for 2 main reasons:

• To avoid ElasticSearch index mapping conflicts
• To ease readability for search and analytics

Each log should contain mandatory fields event.action and event.category which will explicitly add keywords for search & filtering. You can find more information here

    options = {
      event: {
        action: 'xxx',
        category: ['xxx'],
      },
    }

    Hivelogger.info("information message", options)

Logs are not only for errors. Please use the appropriate method, whether that be info, warn, error or debug.

Please note that Hivelogger writes logs to stdout by default on your development environment.

License

The gem is available as open source under the terms of the MIT License.