Skip to content

Commit

Permalink
doc: add grafana template file of the cost dashboard example (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
gluckzhang authored Apr 26, 2024
1 parent 9b96649 commit 2e84899
Show file tree
Hide file tree
Showing 2 changed files with 549 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This AWS Cost Metrics Exporter helps users to fetch AWS cost information using A
## Example of Dashboard on Grafana

![dashboard-example](doc/images/aws-cost-overview-dashboard-example.png)
*This is just an example with fake data that shows the idea of visualizing AWS cost metrics exported by this tool.*
_This is just an example with fake data that shows the idea of visualizing AWS cost metrics exported by this tool. You can find a simplified version of this dashboard in json [here](doc/aws-cost-overview-dashboard-example.json)._

## Sample Output

Expand All @@ -21,7 +21,7 @@ aws_daily_cost_usd{ChargeType="Usage",EnvironmentName="prod",ProjectName="myproj
...
```

*ps: As the metric name indicate, the metric shows the daily costs in USD. `Daily` is based a fixed 24h time window, from UTC 00:00 to UTC 24:00. `EnvironmentName` and `ProjectName` are the custom labels that can be configured. `RegionName` is a label based on `group_by` configuration.*
_ps: As the metric name indicate, the metric shows the daily costs in USD. `Daily` is based a fixed 24h time window, from UTC 00:00 to UTC 24:00. `EnvironmentName` and `ProjectName` are the custom labels that can be configured. `RegionName` is a label based on `group_by` configuration._

## How Does This Work

Expand Down Expand Up @@ -86,11 +86,13 @@ docker run --rm -v ./exporter_config.yaml:/app/exporter_config.yaml -p 9090:9090
### Kubernetes

- Create Namespace

```
kubectl create ns finops
```

- Create Secret

```
kubectl create secret generic aws-cost-exporter \
--namespace=finops \
Expand All @@ -99,11 +101,13 @@ kubectl create secret generic aws-cost-exporter \
```

- Create ConfigMap

```
kubectl create configmap aws-cost-exporter-config --namespace finops --from-file=./exporter_config.yaml
```

- Create Deployment

```
kubectl create --namespace finops -f ./deployment/k8s/deployment.yaml
```
Loading

0 comments on commit 2e84899

Please sign in to comment.