Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ollionorg/aws-ec2-custom-metrics-automation-scripts

These scripts automate the collection and publishing of custom metrics for Amazon EC2 instances running on Windows and Linux operating systems. They are IMDSv2 enabled and provide an easy way to collect and publish custom metrics to CloudWatch, including automatic creation of alarms with thresholds of 75% and 90% for Memory and Disk metrics.
https://github.com/ollionorg/aws-ec2-custom-metrics-automation-scripts

alarm amazon-web-services aws cloudwatch cloudwatch-alarms cloudwatch-metrics ec2

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/ollionorg/aws-ec2-custom-metrics-automation-scripts
Owner: ollionorg
License: mit
Created: 2023-03-27T05:33:45.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-05-08T07:46:21.000Z (over 1 year ago)
Last Synced: 2024-04-16T14:13:41.901Z (8 months ago)
Topics: alarm, amazon-web-services, aws, cloudwatch, cloudwatch-alarms, cloudwatch-metrics, ec2
Language: Shell
Homepage: https://cldcvr.com
Size: 109 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

![Logo](./img/cldcvr_logo.png)

# AWS EC2 Custom Metrics Automation Scripts

This repository contains a set of scripts that automate the collection and publishing of custom metrics for Amazon EC2 instances running on Windows and Linux operating systems. These scripts use `cron`, the AWS CLI, and PutMetric to send custom metrics to CloudWatch. Additionally, there are scripts that create alarms with thresholds of 75% and 90% (which can be changed) for Memory and Disk metrics.

The custom metrics collected and published by these scripts are:

- Memory usage (in percent)
- Disk usage (in percent)

## Prerequisites

Before you can use these scripts, you'll need to ensure that:

- Your EC2 instances are running on either Windows or Linux operating systems.
- You have installed and configured the AWS CLI.
- For ( `Linux` and `Windows` ), Script `auto-install-custom-metrics-linux.sh` and `custom-metrics-disk-memory-linux.sh` will auto install AWS CLI on your instances. [here](https://github.com/cldcvr/aws-ec2-custom-metrics-automation-scripts/blob/main/Linux/README.md)
- For creating alarms, when you run script on your local machine, You have to install AWS CLI. See [Installing the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) in the AWS documentation for instructions on how to install and configure the CLI on your local machine.
- You have set up IAM permissions for the AWS CLI to access the CloudWatch service. See [Creating a Role for an Amazon EC2 Instance to Access AWS CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/create-iam-roles-for-cloudwatch-agent.html) in the AWS documentation for instructions on how to set up these permissions.
- Your instances are running with Instance Metadata Service version 2 (IMDSv2) enabled. These scripts are compatible with IMDSv2 (recommended) and will also work with earlier versions (**not recommended**).

## Usage

To use these scripts, simply download or clone the repository to your local machine. Then, navigate to your operating system directory (`Linux` or `Windows`). Each subdirectory contains a set of scripts that you can use to collect and publish custom metrics to CloudWatch.

Each directory has it's own readme and usage.

- For Linux, click [here](https://github.com/cldcvr/aws-ec2-custom-metrics-automation-scripts/blob/main/Linux/README.md)
- For Windows, click [here](https://github.com/cldcvr/aws-ec2-custom-metrics-automation-scripts/blob/main/Windows/README.md)