https://github.com/exasol/cloudwatch-dashboard-examples

Template for an Exasol – CouldWatch dashboard
https://github.com/exasol/cloudwatch-dashboard-examples

aws aws-cloudwatch aws-cloudwatch-metrics database-statistics exasol-integration java monitoring

Last synced: about 1 month ago
JSON representation

Template for an Exasol – CouldWatch dashboard

• Host: GitHub
• URL: https://github.com/exasol/cloudwatch-dashboard-examples
• Owner: exasol
• License: mit
• Created: 2021-01-28T11:42:45.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-07-04T08:42:35.000Z (almost 3 years ago)
• Last Synced: 2025-01-13T21:09:28.386Z (over 1 year ago)
• Topics: aws, aws-cloudwatch, aws-cloudwatch-metrics, database-statistics, exasol-integration, java, monitoring
• Language: Java
• Homepage:
• Size: 628 KB
• Stars: 1
• Watchers: 9
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Exasol CloudWatch Example Dashboard

[![Build Status](https://github.com/exasol/cloudwatch-dashboard-examples/actions/workflows/ci-build.yml/badge.svg)](https://github.com/exasol/cloudwatch-dashboard-examples/actions/workflows/ci-build.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=security_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=sqale_index)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=code_smells)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=coverage)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Acloudwatch-dashboard-examples&metric=ncloc)](https://sonarcloud.io/dashboard?id=com.exasol%3Acloudwatch-dashboard-examples)

This project contains an [AWS CDK](https://aws.amazon.com/cdk/) template for an example CouldWatch dashboard that visualizes the metrics reported by the [Exasol – CloudWatch adapter](https://github.com/exasol/cloudwatch-adapter).

This dashboard should get you started with Exasol and CloudWatch integration.

![Exasol CloudWatch dashboard example](doc/images/exasolCloudwatchDashboard.png)

## Quick Usage

If you just want to use the example dashboard, you can simply download the latest AWS CloudFormation template in the [releases section](https://github.com/exasol/cloudwatch-dashboard-examples/releases/) and run it in cloudformation.

There you will have to set a Deployment Name. This is the name of your Exasol installation you entered during the setup of the cloudwatch-adapter.

Now you can view and edit your CloudWatch dashboard in the AWS Console. You can also deploy this template multiple times and build different dashboards for different use cases.

## Advanced Usage

In this repository we define the dashboard by code using [AWS CDK](https://aws.amazon.com/cdk/). That allows us to define the dashboard in a very readable way.

You can use this as a starting point for your own dashboards. In contrast to changing the dashboard using the AWS Console that allows you for example to version your dashboards in Git, add a review process or simply copy the same dashboard for multiple Exasol deployments. For that you need to go through the following steps:

* Checkout (or fork) this repository

* Adapt the dashboard to your needs (modify [`src/main/java/com/exasol/cloudwatchexampledashboard/CloudwatchDashboardExamplesStack.java`](src/main/java/com/exasol/cloudwatchexampledashboard/CloudwatchDashboardExamplesStack.java))

* [Install the AWS CDK](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#getting_started_install)

* Deploy your dashboard using

    ```shell

    cdk deploy --parameters deploymentName= --parameters clusterName=MAIN

    ```

  (Don't forget to replace `` with the value you configured during the CloudWatch-adapter setup)

## Injecting Metrics Values for Testing

To test your dashboard and alarms you can manually inject metrics values by executing commands like these:

```shell

aws cloudwatch put-metric-data --namespace "Exasol" --dimensions "Cluster Name=MAIN,Deployment=" --unit Seconds --value 30 --metric-name "BACKUP_DURATION"

aws cloudwatch put-metric-data --namespace "Exasol" --dimensions "Cluster Name=MAIN,Deployment=" --unit Count --value 1 --metric-name "EVENT_BACKUP_START"

aws cloudwatch put-metric-data --namespace "Exasol" --dimensions "Cluster Name=MAIN,Deployment=" --unit Count --value 1 --metric-name "EVENT_BACKUP_END"

aws cloudwatch put-metric-data --namespace "Exasol" --dimensions "Cluster Name=MAIN,Deployment=" --unit Count --value 1 --metric-name "EVENT_BACKUP_ABORTED"

```

## Additional Information

* [Changelog](doc/changes/changelog.md)

* [Dependencies](dependencies.md)