Table of Contents

1. GreenHat
2. Requirements
   1. 1. Ubuntu
   2. Installation
   3. Usage
   4. Testing
   5. Release Process
   6. Contributing
   7. Limitations
   8. License

GreenHat

Experimental SOS and Log Parser for GitLab

12.x and above only (due to structured logging)

Requirements

bsdtar - Used to extract archives

Ubuntu

apt-get install libarchive-tools

Installation

gem install greenhat

Usage

greenhat sos-archive.tar.gz
greenhat production_json.log
# launches a console
>> help # the program is self-documented through the builtin help command

Testing

bundle exec rake

Release Process

• Update CHANGELOG
• Increment version.rb
• Create MR
• Merge to Master

# Build and Push
bundle exec rake build
gem push pkg/greenhat-1.x.x.gem

Contributing

Bug reports and merge requests are welcome on GitLab at https://gitlab.com/gitlab-com/support/toolbox/greenhat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Limitations

• Shell Helpers cannot use Camel Case

License

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