Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trackit/trackit
Trackit helps you understand and improve your use of AWS
https://github.com/trackit/trackit
aws aws-cost aws-cost-explorer aws-costing aws-ec2 aws-lambda aws-rds aws-s3 cloud cost-estimation cost-optimization
Last synced: 3 months ago
JSON representation
Trackit helps you understand and improve your use of AWS
- Host: GitHub
- URL: https://github.com/trackit/trackit
- Owner: trackit
- License: apache-2.0
- Created: 2017-10-05T19:37:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T15:56:25.000Z (about 1 year ago)
- Last Synced: 2024-08-02T02:13:50.392Z (7 months ago)
- Topics: aws, aws-cost, aws-cost-explorer, aws-costing, aws-ec2, aws-lambda, aws-rds, aws-s3, cloud, cost-estimation, cost-optimization
- Language: Go
- Size: 5.5 MB
- Stars: 140
- Watchers: 13
- Forks: 33
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - trackit/trackit - Trackit helps you understand and improve your use of AWS (Go)
README
[](https://hub.docker.com/r/msolution/trackit2-api)
[](https://circleci.com/gh/trackit/trackit)
[](LICENSE)
TrackIt is a tool to optimize your AWS cloud usage and spending.
## Features
- Easy account setup
- AWS Cost Breakdown
- AWS Tags overview
- Events alerts
## How to use
### With Docker Compose
You can start using TrackIt by using the `docker-compose.yml` template available in this repository. It will pull Docker images from Docker Registry.
````sh
$> docker-compose up -d
````
You can also build locally the needed Docker images by using the `docker-compose.yml` file available in `docker/` folder.
````sh
$> docker-compose up -d -f docker/docker-compose.yml
````
### Manually
#### 0. Be sure all requirements below are met
- [Docker](https://docs.docker.com/engine/installation/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) and [configure your credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)
- [Golang](https://golang.org/doc/install)
- [Govender](https://github.com/kardianos/govendor)
#### 1. Clone this repository
````sh
$> mkdir -p $HOME/go/src/github.com/trackit
$> cd $HOME/go/src/github.com/trackit
$> git clone https://github.com/trackit/trackit
$> cd trackit
````
#### 2. Check out dependencies
````sh
$> govendor sync -v
````
#### 3. Start TrackIt
````sh
$> ./start.sh
````
Note: On most operating systems, you will need to [increase the mmap limit](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html) to allow elasticsearch to run properly:
````sh
$> sudo sysctl -w vm.max_map_count=262144
````
#### 4. Now you can use TrackIt
TrackIt API is now listening on `localhost:8080`
## Web UI
A Web UI made with React is available here: [TrackIt Client](https://github.com/trackit/trackit2-client)
## API documentation
The API exposes its own documentation on the `GET /docs` route, in JSON format.
Also, the documentation for each route can be retrieved by an `OPTIONS`
request. We are working on an actual viewer for this.
## Recommendation plugins
Trackit uses a plugin system to easily implement new recommendation checks.
Information on how to write plugins is available in a README in the `plugins` directory.