Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timstott/service_logger
Facilitate log aggregation via unified logging
https://github.com/timstott/service_logger
Last synced: about 1 month ago
JSON representation
Facilitate log aggregation via unified logging
- Host: GitHub
- URL: https://github.com/timstott/service_logger
- Owner: timstott
- License: mit
- Created: 2015-05-08T21:58:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-05-14T11:22:23.000Z (over 9 years ago)
- Last Synced: 2023-08-05T02:25:57.830Z (over 1 year ago)
- Language: Ruby
- Size: 176 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Loga
## Description
Loga defines a single log format, logger and middleware logger
to faciliate log aggregation.
It provides provides:
- Rack logger middleware
- Sidekiq logger middleware to log jobs
- Ruby logger
- GELF log formatter
- GELF log device
## Road Map
- [ ] CI setup with ruby 1.9 and 2.0
- [ ] Setting to limit backtrace size
- [ ] Setting to filter out sensitive request parameters
- [x] Support standard Ruby logger message input
- [ ] Hutch logging integration (Producer and Consumer)
- [ ] ActionMailer integration (New events)
- [ ] GELF additional fields naming retrospective
- [ ] Hooks to augment data being logged
## Installation
Add this line to your application's Gemfile:
gem 'loga'
And then execute:
$ bundle
Or install it yourself as:
$ gem install loga
## Usage
Configuration
```ruby
# config/initializers/loga.rb
target = Loga::GELFUPDLogDevice.new(host: '192.168.99.100')
Loga.configure do |config|
config.service_name = 'marketplace'
config.service_verion = 'v1.0.0' or SHA
config.device = target
end
```
Rails-less applications
```ruby
# config.ru
use Loga::Rack::Logger
```
Rails applications
```ruby
# config/application.rb
config.middleware.insert_after Rack::MethodOverride,
Loga::Rack::Logger
```
Sidekiq
```ruby
# config/initializers/sidekiq.rb
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.insert_before Sidekiq::Middleware::Server::RetryJobs,
Loga::Sidekiq::ServerLogger
end
config.client_middleware do |chain|
chain.add Loga::Sidekiq::ClientLogger
end
end
Sidekiq.configure_client do |config|
config.client_middleware do |chain|
chain.add Loga::Sidekiq::ClientLogger
end
end
```
Custom events
```ruby
# Anywhere in your application
# Passing a String
Loga.logger.info('Hello World')
=> '{
"version": "1.1",
"host": "example.com",
"short_message": "Hello World",
"timestamp": "1450171805.123",
"level": "6",
"_service.name": "hello_app",
"_service.version": "abcdef",
"_event": "unknown"
}'
# Passing a Hash
Loga.logger.info(
short_message: 'Hello World', # REQUIRED
full_message: 'Hello World and the Moon', # OPTIONAL
type: 'new_user', # OPTIONAL
timestamp: Time, # OPTIONAL
data: { # OPTIONAL
'color' => 'red',
'user' => {
'name' => 'Bob',
},
},
exception: Exception, # OPTIONAL
)
=> '{
"version": "1.1",
"host": "example.com",
"short_message": "GET /hello_world",
"timestamp": "1450171805.123",
"level": "6",
"_service.name": "hello_app",
"_service.version": "abcdef",
"_event": "unknown",
"_color": "red",
"_user.name": "Bob"
}'
```
## Event types
Middleware augment the GELF payload with the `_event` key to label events.
| event type | description | middleware |
|-------------------|-----------------------------------|-------------------------|
| http_request | HTTP request and response | Rack |
| job_enqueued | Sidekiq client enqueues a job | SidekiqClient |
| job_consumed | Sidekiq worker consumes a job | SidekiqServer |
| message_published | Publisher publishes a RMQ message | TODO |
| message_consumed | Consumer consumes a RMQ message | TODO |
| unknown | Event within the application | Logger (not middleware) |
## Sample GELF
:warning: Coming up
## Contributing
1. Fork it ( https://github.com/[my-github-username]/loga/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
## Credits
- [Sidekiq](https://github.com/mperham/sidekiq)
- [Rails](https://github.com/rails/rails)
- [RackLogstasher](https://github.com/alphagov/rack-logstasher)
- [gelf-rb](https://github.com/Graylog2/gelf-rb)