Skip to main content
# Redshift Console

_Redshift Console_'s goal is to be the tool to monitor and manage a Redshift cluster. The first release has basic tools to monitor running queries, WLM queue and your tables/schemas.

After over a year of managing our Redshift cluster with a collection of scripts and queries, we decided to bundle this into a more user friendly tool that can be used by a wider audience. This project also aims to uncover all the useful information hidden in [Redshift's Developer Guide](http://docs.aws.amazon.com/redshift/latest/dg/) (such as the [table design status](http://docs.aws.amazon.com/redshift/latest/dg/c_analyzing-table-design.html) query).

![Screenshots](https://dl.dropboxusercontent.com/u/2186704/rdc_screenshots.gif)

### Features

* Inflight queries view with option to cancel any query and view related alerts (when available; from [STL_ALERT_EVENT_LOG](http://docs.aws.amazon.com/redshift/latest/dg/r_STL_ALERT_EVENT_LOG.html)).
* WLM queue view.
* Schemas view with additional information for each table including: total size (rows/MB), unsorted area size, is the table properly distributed and more.
* Load errors (aggregated view) from the past 24h, based on [STL_LOAD_ERRORS](http://docs.aws.amazon.com/redshift/latest/dg/r_STL_LOAD_ERRORS.html)

### Roadmap

This project is safe for usage, but still in its early stage (version 0.1). Future versions will include:

* Loads - Progress of current operations and history of recent ones.
* Vacuum status.
* SNS/CloudWatch integration to show metrics and events from AWS' console.
* Proactive notifications re. important events in the system: long running queries, problems, changes to the schema, dangerous levels of unsorted areas and more.

We are always happy to receive feedback and suggestions, especially if they are accompanied by a pull request.

## Usage

You can either use the PyPI package or the docker image.

#### PyPI

1. The easiest way to install the project is from pypi:

```bash
$ pip install redshift-console
```

2. Settings are set from environment variables. The main setting to set is the connection string to your Redshift cluster: (make sure the user has sufficient permissions)

```bash
$ export REDSHIFT_CONNECTION_STRING='user= password= host= port= dbname='
```

3. Start the server:

```bash
$ redshift-console runserver
Starting server on port 5000 (debug mode: False).
```

#### Docker
```bash
$ docker run -e REDSHIFT_CONNECTION_STRING="user= password= host= port=5439 dbname=" -p 5000:5000 everythingme/redshift-console
Starting server on port 5000 (debug mode: False).
```

## Authors

[Arik Fraimovich](http://github.com/arikfr) and [Oren Itamar](http://github.com/orenitamar).

Metadata

Release files for redshift-console 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for redshift-console 0.1.3
File Size Uploaded Provenance Actions
redshift-console-0.1.3.tar.gz 1.4 MB Without provenance Details for redshift-console-0.1.3.tar.gz

Release files / redshift-console-0.1.3.tar.gz

Download URL redshift-console-0.1.3.tar.gz
Size 1.4 MB
Tags Source
SHA-256 checksum
How to use checksums
ac2fe8f2d1baca67ff9c3555fa62e3cd32d894efb8d5736f679375f9b0bb736a
BLAKE2b-256 checksum
How to use checksums
9418ac98f85378f8785518df0059a381404268c54cccb71e1e483600a714eaad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for redshift-console 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page