Skip to content

ChiragKParmar/newrelic_redshift_plugin

Repository files navigation

NewRelic Redshift Plugin

NewRelic Redshift Plugin

The New Relic Redshift Plugin enables integrated monitoring of your Redshift database in a custom NewRelic dashboard. Currently the following metrics are recorded:

  • Database Memory Statistics
  • Total Disk Space
  • Free Space
  • Percentage Utilized
  • Table Statistics
  • Total Rows Per Table
  • Sorted Rows Per Table
  • Unsorted Rows Per Table
  • Percentage of Unsorted Region Per Table
  • Size of Table in Proportion to the Cluster Size
  • Staleness of the Table Stats (real size vs size recorded in stats)

More metrics coming!


Requirements

Proxy host

You need a host to install the plugin on that is able to poll the desired Redshift database. That host also needs Ruby (tested with 2.2.0), and support for rubygems.

Installation and Running

    • Option 1
      1. Install this gem from RubyGems: gem install newrelic_redshift_plugin
    • Option 2
      1. Download the latest newrelic_redshift_plugin-X.Y.Z.tar.gz from the tag list
      2. Extract the downloaded archive to the location you want to run the Redshift agent from
      3. Run bundle install to install required gems
  1. In the installation directory, execute

    ./bin/redshift_plugin install -l LICENSE_KEY

    using the license key from your New Relic account.

  2. Edit the config/newrelic_plugin.yml file generated in step 2. Setup host/port/user/password/dbname/schema for your redshift connection.

  3. Execute

    ./bin/redshift_plugin run

  4. Wait a few minutes for New Relic to begin processing the data sent from your agent.

  5. Log into your New Relic account here and click on Redshift on the left hand nav bar to start seeing your Redshift metrics.

##Source Code This plugin can be found at here

Screenshots

![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/1.png) ![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/2.png) ![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/3.png) ![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/4.png) ![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/5.png) ![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/6.png) ![img] (https://github.com/ChiragKParmar/newrelic_redshift_plugin/blob/master/screenshots/7.png)

Support

Please use Github issue for support. git issue tracking

Frequently Asked Questions

Q: What is the default polling time ?

A: Default polling period is 60 seconds.

Q: How can I change the default polling time ?

A: You can change the default value by editing the newrelic_plugin.yml and Please read Newrelic's note on time periods for metrics

Contributing

Pull requests welcome!

  1. Fork it ( https://github.com/ChiragKParmar/newrelic_redshift_plugin/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

More Metrics Coming Soon!!!

Using AWS Cloudwatch

  1. NetworkReceiveThroughput
  2. NetworkTransmitThroughput
  3. ReadIOPS
  4. ReadLatency
  5. ReadThroughput
  6. WriteIOPS
  7. WriteLatency
  8. WriteThroughput