https://github.com/martinrusev/solid-ruby
Ruby client for Amon Lite
https://github.com/martinrusev/solid-ruby
Last synced: 9 months ago
JSON representation
Ruby client for Amon Lite
- Host: GitHub
- URL: https://github.com/martinrusev/solid-ruby
- Owner: martinrusev
- Created: 2011-11-04T17:55:48.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2013-04-03T07:56:17.000Z (almost 13 years ago)
- Last Synced: 2025-04-12T11:15:50.546Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 145 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Install
You can install the Ruby client with sudo gem install ramon
## Configuration
require 'rubygems' # Only if your app throws load error
require 'ramon'
require "logger"
Ramon.configure do |config|
config.address = 'http://127.0.0.1:2464'
config.secret_key = 'secret key from /etc/amonlite.conf'
config.logger = Logger.new(STDOUT)
end
## Usage
### Logging
You can use the logging module in any Ruby application.
# message - string, hash or array
# tags - string or array
Ramon.log(message, tags)
# Will still work and in the web interface you will see these logs with level 'unset'
Ramon.log(message)
# Log hashes - useful for post data, benchmarks, user events or parts of the application
# where printing to the terminal doesn't work
Ramon.log({:first_name => "John", :last_name => "Dev", :age => 29)
# You can log arrays as well
Ramon.log(['data', 'more data'])
# Tagged logging
Ramon.log(message, ['info','development'])
### Exception handling
At the moment the exception handling module is working only with Rails. Support for Sinatra is in the works.
In the meantime you can easily add support for your framework of choice, following the example below:
require 'ramon'
class ExceptionData
def initialize(exception, name=nil)
@exception = exception
@name = name
end
def to_hash
hash = {
'exception_class' => @exception.class.to_s,
'message' => @exception.message,
'backtrace' => @exception.backtrace,
'url' => '',
'data' => {}
}
hash['data'].merge!(extra_stuff)
end
class Catcher
def self.handle(exception, name=nil)
data = ExceptionData.new(exception, name)
Ramon.post('exception', data.to_hash)
end
end
For a real world working example you can check the source code for the Rails exception handler at
[https://github.com/martinrusev/ramon](https://github.com/martinrusev/ramon).
The example above uses the code from these files:
/lib/ramon/exception_data.rb
/lib/ramon/catcher.rb
## Rails
Amon supports only Rails 3. You can capture exceptions and log data from your Rails application
by adding gem 'ramon' to your Gemfile and running bundle update
after that.
By default Ramon sends the data to http://127.0.0.1:2464, to change these values
add a ramon.rb file in
rails_root/config/initializers
# rails_project/config/initializers/ramon.rb
Ramon.configure do |config|
config.address = 'http://127.0.0.1:2464'
config.secret_key = 'secret key from /etc/amonlite.conf'
end
## Bugs
If you find a bug in the ruby client, you can use the the github issues page to report it:
https://github.com/martinrusev/ramon/issues
## Meta
The Ruby client is hosted on [Github](https://github.com/martinrusev/ramon)