Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
robsonbittencourt committed Oct 18, 2019
1 parent 47ce7a3 commit d618e0a
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 5 deletions.
50 changes: 45 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,61 @@
# aws-cost-miner
Application to extract usefull information from Aws Billing Report
# AWS Cost Miner
> Application to extract useful information from AWS Billing Report
#UNDER CONSTRUCTION
## Goal

Understanding all the costs we have when using Amazon Web Services is not a simple task.

The goal of this project is to provide useful and organized data on the costs of your infrastructure, thus facilitating resource optimization.

## Mining Data

AWS provides a report in CSV format of all your detailed costs. This report is in a bucket of your S3. More details on how to get it [click here](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/DetailedBillingReport.html).

With this file in hand, simply execute one of the docker commands below, as needed.

## Reports

This tool provides a few different types of report. The data is presented in the console itself, but there are plans for new reports to be built in new formats.

Replace *$(pwd)/data.csv* with *$(pwd)/YOUR_FILE_NAME.csv* to run the command.

### EC2 COST REPORT

This report presents the detailed costs of your EC2-related products such as instances and disks.

![ec2-report](images/ec2Report.png)

```
docker run --rm \
--name aws-cost-miner \
-v $(pwd)/data.csv:/app/data.csv \
-e report=EC2_COST_REPORT \
-e groupBy="user:Name" \
robsonbittencourt/aws-cost-miner
```
./gradlew clean build && docker build -t robsonbittencourt/aws-cost-miner:latest .

You can group the data according to one of the columns of the CSV file. Use the column name as it is in the file.

```
docker run --rm \
--name aws-cost-miner \
-v $(pwd)/data.csv:/app/data.csv \
-e report=EC2_COST_REPORT \
-e groupBy="user:Name" \
robsonbittencourt/aws-cost-miner
```

### RESERVED INSTANCE USAGE REPORT

This report demonstrates the usage percentages for all of your [Reserved Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-reserved-instances.html).

![reserved-instance-report](images/reservedInstancesReport.png)

```
docker run --rm \
--name aws-cost-miner \
-v $(pwd)/data.csv:/app/data.csv \
-e report=RESERVED_INSTANCE_USAGE_REPORT \
robsonbittencourt/aws-cost-miner
``
```

Binary file added images/ec2Report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/reservedInstancesReport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d618e0a

Please sign in to comment.