debian-mirror-gitlab/debian/gems-compat/gitlab-labkit-0.2.0

LabKit-Ruby 🔬🔬🔬🔬🔬

LabKit-Ruby is minimalist library to provide functionality for Ruby services at GitLab.

LabKit-Ruby is the Ruby companion for LabKit, a minimalist library to provide functionality for Go services at GitLab.

LabKit-Ruby and LabKit are intended to provide similar functionality, but use the semantics of their respective languages, so are not intended to provide identical APIS.

Documentation

API Documentation is available at the Rubydoc site.

Functionality

LabKit-Ruby provides functionality in three areas:

1. Labkit::Correlation for handling and propagating Correlation-IDs.
2. Labkit::Logging for sanitizing log messages.
3. Labkit::Tracing for handling and propagating distributed traces.

Developing

Anyone can contribute!

$ git clone git@gitlab.com:gitlab-org/labkit-ruby.git
$ cd labkit-ruby
$ bundle install

$ # Autoformat code and auto-correct linters
$ bundle exec rake fix

$ # Run tests, linters
$ bundle exec rake verify

Note that LabKit-Ruby uses the rufo for auto-formatting. Please run bundle exec rake fix to auto-format your code before pushing.

Please also review the development section of the LabKit (go) README for details of the LabKit architectural philosophy.