Skip to content

boundary/boundary-plugin-aws-redshift

Repository files navigation

Boundary AWS Redshift Plugin

The Boundary AWS Redshift plugin collects information on AWS Redshift Clusters using the CloudWatch API.

The plugin requires Python 2.6 or later, as well as the Boto Python library. Click here for Boto installation instructions.

Metrics

he plugin reports all Redshift metrics reported by CloudWatch for the cluster dimension. For a full list of these metrics and their descriptions, see this AWS documentation article. This plugin does not collect metrics per-node, since this would be a prohibitive number of metrics and would quickly deplete resources and cost API calls.

Note: CloudWatch reports Redshift metrics in 60 second periods. You will only see data appear in Boundary every 60 seconds for the preceding 60 seconds. This is normal and a product of how CloudWatch works.

Adding the Redshift Plugin to Premium Boundary

  1. Login into Boundary Premium
  2. Display the settings dialog by clicking on the settings icon:
  3. Click on the Plugins in the settings dialog.
  4. Locate the aws_redshift plugin item and click on the Install button.
  5. A confirmation dialog is displayed indicating the plugin was installed successfully, along with the metrics and the dashboards.
  6. Click on the OK button to dismiss the dialog.

Removing the Redshift Plugin from Premium Boundary

  1. Login into Boundary Premium
  2. Display the settings dialog by clicking on the settings icon:
  3. Click on the Plugins in the settings dialog which lists the installed plugins.
  4. Locate the aws_redshift plugin and click on the item, which then displays the uninstall dialog.
  5. Click on the Uninstall button which displays a confirmation dialog along with the details on what metrics and dashboards will be removed.
  6. Click on the Uninstall button to perfom the actual uninstall and then click on the Close button to dismiss the dialog.

Configuration

Once the Redshift plugin is installed, metric collection requires that a relay is installed on the target system. Instructions on how to install a relay for Linux/Unix can found here, and for Windows here.

Before the plugin will collect metrics, you must provide it with a valid AWS Access Key ID and Secret Access Key. Click here for more information on where to find/generate these keys. The keys you generate should be for a user with access to both CloudWatch and Redshift.

General operations for plugins are described in this article.

About

Collects metrics from Amazon Redshift

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages