Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Enhances default Rails logging.
Ruby HTML CSS JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
gemfiles
lib
spec
.gitignore
.ruby-version
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Gemfile
Gemfile.lock
Guardfile
LICENSE.md
README.md
Rakefile
log_plus.gemspec

README.md

Log+

Gem Version Code Climate GPA Code Climate Coverage Gemnasium Status Travis CI Status Gittip

Table of Contents

Features

  • Provides customization of default settings.
  • Prefixes log output with timestamps and remote IP addresses.
  • Configures max log size to 1MB for local environments (i.e. test and development).
  • Configures max log size to 5MB with log rotation (7 files max) for remote environments (i.e. review, stage, production, etc).

Requirements

  1. MRI 2.x.x.
  2. Ruby on Rails 4.x.x.

Setup

For a secure install, type the following from the command line (recommended):

gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem)
gem install log_plus --trust-policy MediumSecurity

NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while allowing the installation of unsigned dependencies since they are beyond the scope of this gem.

For an insecure install, type the following (not recommended):

gem install log_plus

Add the following to your Gemfile:

gem "log_plus"

Usage

Within your application or environment *.rb files, you can configure any of the following settings:

  • Log+ Settings:
    • config.log_plus_settings[:max_size] = Optional. Sets max log size (local environments only). Default: 1MB.
  • Rails Settings:
    • config.log_tags = Optional. Defines log output (all environments). Default: Timestamp and remote IP prefixes.
    • config.logger = Optional. Configures the Rails logger (all environments). Default: Logger.new (with 5MB max size and 7 files max rotation).

Tests

To test, run:

bundle exec rspec spec

Versioning

Read Semantic Versioning for details. Briefly, it means:

  • Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
  • Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
  • Major (X.y.z) - Incremented for any backwards incompatible public API changes.

Code of Conduct

Please note that this project is released with a CODE OF CONDUCT. By participating in this project you agree to abide by its terms.

Contributions

Read CONTRIBUTING for details.

License

Copyright (c) 2012 Alchemists. Read the LICENSE for details.

History

Read the CHANGELOG for details. Built with Gemsmith.

Credits

Developed by Brooke Kuhlmann at Alchemists

Something went wrong with that request. Please try again.