logstasher-logger gem - Ruby

The logstasher-logger gem is a powerful Ruby gem that provides an integrated solution for logging and monitoring your Ruby applications. This gem provides a powerful framework for managing log files and providing real-time monitoring of your application's performance.

The gem has been designed to be highly customizable and compatible with a wide variety of logging frameworks, including log4r, logstash, and syslog. With this gem, you can easily create custom log files, serialize log data to JSON, and track specific metrics related to your application's performance.

Installation

To install the logstasher-logger gem, simply add the following line to your Gemfile and run bundle install:

gem 'logstasher-logger'

Configuration

Once the gem is installed, you can configure it to suit your needs. The gem provides a number of configuration options that let you customize how your logs are handled and what data is tracked.

Here's an example configuration that sets up log rotation and configures the gem to generate JSON logs:

LogStasher.configure do |config|
  config.log_file_path = '/path/to/logs'
  config.log_file_rotation_period = 'daily'
  config.log_level = Logger::DEBUG
  config.log_output = 'logstash'
  config.log_formatter = LogStasher::JsonFormatter.new
end

This configuration sets up the gem to use a log file at /path/to/logs, rotate logs daily, and generate JSON logs. It also sets the logging level to debug and configures the logs to be output to Logstash.

Usage

Once the gem is configured, you can use it to log messages and track metrics related to your application's performance.

Here's an example of how to log a message:

require 'logstasher-logger'

logger = LogStasher::Logger.new

logger.debug 'Debug message'
logger.info 'Info message'
logger.warn 'Warning message'
logger.error 'Error message'
logger.fatal 'Fatal message'

This code creates a new logger and uses it to log messages at different levels. When one of these messages is logged, the gem's JSON formatter is used to serialize the log data.

Additionally, you can track specific metrics related to your application's performance. Here's an example of how to do this:

require 'logstasher-logger'

logger = LogStasher::Logger.new

logger.track('response_time', value: 1234)

This code tracks a metric called response_time with a value of 1234. This metric will be serialized to JSON and included in your application's logs.

Conclusion

The logstasher-logger gem is a powerful Ruby gem that provides an integrated solution for logging and monitoring your Ruby applications. With its ability to manage log files, serialize log data to JSON, and track performance metrics, this gem provides everything you need to effectively monitor your application's performance.