https://github.com/ruby/logger-application

https://github.com/ruby/logger-application

ruby

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ruby/logger-application
• Owner: ruby
• License: other
• Created: 2014-07-02T01:05:37.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2023-09-11T02:21:00.000Z (over 2 years ago)
• Last Synced: 2025-01-30T07:32:50.590Z (about 1 year ago)
• Topics: ruby
• Language: Ruby
• Size: 34.2 KB
• Stars: 8
• Watchers: 5
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Logger::Application

[![Gem Version](https://badge.fury.io/rb/logger-application.png)](http://badge.fury.io/rb/logger-application)

[![Build Status](https://travis-ci.org/ruby/logger-application.svg)](https://travis-ci.org/ruby/logger-application)

## Description

Add logging support to your application.

## Installation

Add this line to your application's Gemfile:

    gem 'logger-application'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install logger-application

## Usage

 1. Define your application class as a sub-class of this class.

 2. Override the +run+ method in your class to do many things.

 3. Instantiate it and invoke #start.

## Example

```ruby

class FooApp < Logger::Application

  def initialize(foo_app, application_specific, arguments)

    super('FooApp') # Name of the application.

  end

  def run

    ...

    log(WARN, 'warning', 'my_method1')

    ...

    @log.error('my_method2') { 'Error!' }

    ...

  end

end

status = FooApp.new(....).start

```

## Contributing

1. Fork it ( https://github.com/ruby/logger-application/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