README.md in alephant-logger-0.2.0 vs README.md in alephant-logger-1.0.1
- old
+ new
@@ -1,93 +1,61 @@
# Alephant::Logger
-Logger functionality for Alephant
+Logger functionality for BBC News' [Alephant](https://github.com/BBC-News/alephant) framework.
[](https://travis-ci.org/BBC-News/alephant-logger)
+Status](https://travis-ci.org/BBC-News/alephant-logger.png)](https://travis-ci.org/BBC-News/alephant-logger) [](http://badge.fury.io/rb/alephant-logger)
-[](http://badge.fury.io/rb/alephant-logger)
-
## Installation
Add this line to your application's Gemfile:
- gem 'alephant-logger'
+```
+gem 'alephant-logger'
+```
And then execute:
+```
$ bundle
+```
Or install it yourself as:
+```
$ gem install alephant-logger
+```
## Usage
```rb
-require 'alephant/logger'
+require "alephant/logger"
+require "alephant/logger/statsd"
+require "alephant/logger/cloudwatch"
-# Using the standard logger
-class IncludesLogger
- include Alephant::Logger
+config = {
+ :host => "statsd.test.service.bbc.co.uk",
+ :port => 6452,
+ :namespace => "test"
+}
- def calls_logger
- logger.warn "MUCH WARN. WOW."
- end
-end
+statsd_driver = Alephant::Logger::Statsd.new config
+cloudwatch_driver = Alephant::Logger::CloudWatch.new "my_namespace"
-# Sets a logger
-class SetsLogger
- include Alephant::Logger
-
- def calls_logger
- Alephant::Logger.set_logger(CustomLogger.new)
- logger.warn "SUCH CUSTOM. MUCH LOG."
- end
-end
+logger = Alephant::Logger.create([statsd_driver, cloudwatch_driver])
+logger.increment "foo.bar"
+logger.metric(:name => "FooBar", :unit => "Count", :value => 1)
```
-### AWS CloudWatch Metrics
+## Drivers
-```ruby
-require "aws-sdk"
-require "alephant/logger"
-require "alephant/logger/cloudwatch_decorator"
+You can consume an array of other gems to allow Alephant Logger to send custom metrics:
-AWS.config(
- :region => "eu-west-1",
- :access_key_id => "ACCESS_KEY_ID",
- :secret_access_key => "SECRET_ACCESS_KEY",
- :session_token => "SESSION_TOKEN"
-)
+1. [Statsd](https://github.com/BBC-News/alephant-logger-statsd#alephantloggerstatsd)
-LOGGER = Alephant::Logger::CloudWatchDecorator.new(
- Logger.new("app.log"), "SomeCloudWatchMetricNameSpace"
-)
-
-Alephant::Logger.set_logger LOGGER
-
-class Foo
- include Alephant::Logger
-
- def initialize
- logger.info "some info"
- logger.debug "much debug"
- logger.error "great error"
- logger.warn "so warn"
- logger.fatal "ooh fatal"
-
- # Without the CloudWatchDecorator the `metric` call is a no-op
- logger.metric({:name => "SomeMetricName", :unit => "Count", :value => 1})
- end
-end
-
-Foo.new
-```
-
## Contributing
-1. Fork it ( http://github.com/BBC-News/alephant-logger/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 new Pull Request
+1. [Fork it!](http://github.com/BBC-News/alephant-logger/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 new [Pull Request](https://github.com/BBC-News/alephant-logger/compare).