# SqlMonitor Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sql_monitor`. To experiment with that code, run `bin/console` for an interactive prompt. TODO: Delete this and the text above, and describe your gem ## Installation Add this line to your application's Gemfile: ```ruby group :development do gem 'sql_monitor', git: 'https://github.com/moneyforwardvietnam/sql_monitor.git', branch: 'master' end ``` And then execute: $ bundle install Or install it yourself as: $ gem install sql_monitor ## Usage To change the configuration of health_check, create a file `config/initializers/sql_monitor.rb` and add a configuration block like: ```ruby # frozen_string_literal: true SqlMonitor::Config.configure do |config| config.enabled = true # default is false config.redis_host = ENV.fetch('REDIS_HOST', 'redis://localhost/1') config.redis_db = 11 config.release_version = ENV.fetch('CIRCLE_WORKFLOW_ID', nil) end ``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/moneyforwardvietnam/sql_monitor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/moneyforwardvietnam/sql_monitor/blob/master/CODE_OF_CONDUCT.md). ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). ## Code of Conduct Everyone interacting in the SqlMonitor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/moneyforwardvietnam/sql_monitor/blob/master/CODE_OF_CONDUCT.md).