BenMorganIO / logtail-ruby-rails

The Logtail Ruby on Rails library

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logtail - Ruby on Rails Logging Made Easy

Logtail ruby dashboard

ISC License Gem Version Build Status

Collect logs directly from your Ruby on Rails projects. To start logging Ruby projects explore the Logtail Ruby library.

Logtail is a hosted service that centralizes all of your logs into one place. Allowing for analysis, correlation and filtering with SQL. Actionable Grafana dashboards and collaboration come built-in. Logtail works with any language or platform and any data source.

Features

  • Simple integration.
  • Support for structured logging and events.
  • Automatically captures useful context.
  • Performant, light weight, with a thoughtful design.

Supported language versions

  • Ruby 2.7.0 or newer Rails 6.1.4.2 or newer

Installation

Install the Logtail Ruby on Rails client library, run the following command:

bundle add logtail-rails

Alternatively, add gem "logtail-rails" to your Gemfile manually and then run bundle install.


Example project

To help you get started with using Logtail in your Ruby on Rails projects, we have prepared a simple program that showcases the usage of Logtail logger.

Download and install the example project

You can download the example project from GitHub directly or you can clone it to a select directory. Make sure you are in the projects directory and run the following command:

bundle install

This will install all dependencies listed in the Gemfile.lock file.

Then run the following command to create the default config file:

bundle exec rake logtail:install source_token=SOURCE_TOKEN

Don't forget to replace SOURCE_TOKEN with your actual source token which you can find by going to logtail.com -> sources -> edit. This will generate config/initializers/logtail.rb.

Run the example project

To run the example application, run the following command:

rails server

This will open a local server 127.0.0.1:3000. On the main page, click the "Let's go!" button to generate test logs.

You should see the following output:

All done!
Log into your Logtail account to check your logs.

This will create a total of 6 different logs, each corresponding to a different log level and one with additional structured data. You can review these logs in Logtail.

Explore how example project works

Learn how to setup Ruby logging by exploring the workings of the example project in detail.


Get in touch

Have any questions? Please explore the Logtail documentation or contact our support.

About

The Logtail Ruby on Rails library

License:Other


Languages

Language:Ruby 98.1%Language:HTML 1.0%Language:CSS 0.9%Language:JavaScript 0.1%