https://github.com/phallguy/shog

Simple colored logging for rails 4 and 5 apps
https://github.com/phallguy/shog

logging ruby-on-rails

Last synced: about 1 year ago
JSON representation

Simple colored logging for rails 4 and 5 apps

• Host: GitHub
• URL: https://github.com/phallguy/shog
• Owner: phallguy
• License: mit
• Created: 2014-07-19T03:49:53.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2018-05-21T16:34:49.000Z (about 8 years ago)
• Last Synced: 2025-05-12T17:23:53.648Z (about 1 year ago)
• Topics: logging, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 569 KB
• Stars: 69
• Watchers: 2
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Shog

[![Gem Version](https://badge.fury.io/rb/shog.svg)](http://badge.fury.io/rb/shog)

[![Code Climate](https://codeclimate.com/github/phallguy/shog.png)](https://codeclimate.com/github/phallguy/shog)

[![Circle CI](https://circleci.com/gh/phallguy/shog.svg?style=svg)](https://circleci.com/gh/phallguy/shog)

(Also check [scorpion](http://github.com/phallguy/scorpion) for a light-weight IoC container)

Simple colored logging for rails 4 and 5 apps.

There are plenty of logging frameworks for making tags (like timestamp, log

level, etc.) more colorful - but what about the details in the line of text?

What about the HTTP method used to make the request? What about the render

times?

Shog adds colors to highlight context and make it easier to pick out the

important parts of the message. Unformatted logs like this

![Plain Logs](docs/images/plain.png)

become easy to ready and process logs like this

![Shogged Logs](docs/images/shogged.png)

## Using Shog

Just add the following to your Gemfile to enable shiny output logs.

```

gem 'shog'

```

Shog comes built in with some sane defaults for rails apps. But you can

customize the output  to match additional log message by your app, or to use

different options in production.

To change the defaults, add `shog.rb` to your `config/initializers` folder

```ruby

Shog.configure do

  if ::Rails.env.production?

    reset_config!

    timestamp

  end

  match /execution expired/ do |msg,matches|

    # Highlight timeout errors

    msg.red

  end

end

```

See [Shog::Formatter#configure](lib/shog/formatter.rb) for more configuration options.

## Contributing

1. Fork it ( https://github.com/phallguy/shog/fork )

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 a new Pull Request

# License

[The MIT License (MIT)](http://opensource.org/licenses/MIT)

Copyright (c) 2014 Paul Alexander