logkit

Logkit

Logkit is a Ruby client for logging events to Logkit. It provides a simple interface to send data from your Ruby or Ruby on Rails application to your Logkit endpoint.

Installation

Add this line to your application's Gemfile:

gem 'logkit'

And then execute:

bundle install

Or install it yourself as:

gem install logkit

Configuration

Ruby on Rails

To configure the gem in a Rails application, you'll want to set up an initializer file where you can configure the logkit_url and other settings.

Create a file config/initializers/logkit.rb:

# config/initializers/logkit.rb
require 'logkit'

Logkit::Client.logkit_url = "https://your-logkit-endpoint.com"
Logkit::Client.mode = Rails.env.production? ? "prod" : "dev"

This configuration sets the Logkit URL and adjusts the logging mode based on the environment. In production, it logs to the Logkit service, and in development or test environments, it logs to the console.

Usage

To log events, simply call the log method anywhere in your Rails application:

Logkit.log("event_name", { key: "value" })

Or alternatively you can use the shortcut methods:

Logkit.event_name({ key: "value" })

This will send an event named event_name with the provided payload to the configured Logkit endpoint.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/philipp-spiess/logkit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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