Trifle::Logs

Simple log storage where you can dump your data. It allows you to search on top of your log files with ripgrep for fast regexp queries and utilises head and tail to paginate through a file.

For comprehensive guides, API reference, and examples, visit trifle.io/trifle-logs

Add this line to your application's Gemfile:

gem 'trifle-logs'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install trifle-logs

require 'trifle/logs'

Trifle::Logs.configure do |config|
  config.driver = Trifle::Logs::Driver::File.new(path: './logs')
  config.formatter = Trifle::Logs::Formatter::Json.new
end

Trifle::Logs.dump('test', 'This is test message')
Trifle::Logs.dump('test', 'Or another message')
Trifle::Logs.dump('test', 'That someone cares about')

search = Trifle::Logs.searcher('test', pattern: 'test')
result = search.perform
result.data
#=> [
#     {
#       "type"=>"match",
#       "data"=>{
#         "path"=>{"text"=>"<stdin>"},
#         "lines"=>{"text"=>"2022-09-17T08:33:04.843195 {\"scope\":{},\"content\":\"This is test message\"}\n"},
#         "line_number"=>1,
#         "absolute_offset"=>0,
#         "submatches"=>[{"match"=>{"text"=>"test"}, "start"=>58, "end"=>62}]
#       }
#     }
#   ]

• File-based storage - Simple, reliable log storage
• Fast search - Uses ripgrep for high-performance regex searches
• Flexible formatting - JSON, text, and custom formatters
• Pagination support - Efficient log browsing with head/tail
• Structured logging - Scope and metadata support
• Production ready - Handles log rotation and large files

Currently supports:

• File - Local file system storage with rotation support

• JSON - Structured JSON output with timestamps
• Text - Plain text formatting for human readability
• Timestamp - Adds automatic timestamping to all entries

Tests verify log storage, search functionality, and formatter behavior. To run the test suite:

$ bundle exec rspec

Ensure ripgrep is installed locally for search functionality tests.

Tests are meant to be simple and isolated. Every test should be independent and able to run in any order. Tests should be self-contained and set up their own configuration.

Use single layer testing to focus on testing a specific class or module in isolation. Use appropriate stubbing for file system operations when testing drivers and formatters.

Repeat yourself in test setup for clarity rather than complex shared setups that can hide dependencies.

Tests verify that logs are properly written, search operations return expected results, and formatters produce correct output. File system tests use temporary directories to avoid conflicts.

Bug reports and pull requests are welcome on GitHub at https://github.com/trifle-io/trifle-logs.

The gem is available as open source under the terms of the MIT License.