No commit activity in last 3 years
No release in over 3 years
Sinatra logging for human beings
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.13
>= 0
~> 12.0
~> 3.5

Runtime

 Project Readme

sinatra-sane-logging

Code Climate Gem Version CircleCI

Sinatra logging for human beings.

It allows to set both Rack, error and application logger.

It uses Rack::Commonlogger under the hood so the logger has to respond to:

  • <<(message)
  • puts(message)
  • flush

Installation

Add this line to your application's Gemfile:

gem "sinatra-sane-logging", require: "sinatra/sane_logging"

And then execute:

$ bundle

Or install it yourself as:

$ gem install sinatra-sane-logging

Usage

require "logger"
require "sinatra/base"
require "sinatra/sane_logging"

class FileLogger < Logger
  def flush; end
end

class App < Sinatra::Base
  register Sinatra::SaneLogging

  sane_logging logger: Filelogger.new(File.open("log/app.log", "a+").tap { |log_file| log_file.sync = true })

  get "/" do
    logger.info "OK"

    "OK"
  end
end

Development

Build the Docker image:

$ docker-compose build

Create services:

$ docker-compose create

Run specs:

$ docker-compose run --rm app rspec spec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tomekw/sinatra-sane-logging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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