Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 1.69 KB

README.md

File metadata and controls

56 lines (44 loc) · 1.69 KB
Raw

Snitch

Package github.com/shatil/snitch collects and (optionally) publishes ECS Cluster capacity metrics.

Documentation Build Status Go Report Card Code Coverage

AWS SDK requires you to specify the AWS Region you wish to interact with, which you can do at runtime with environment variable AWS_REGION.

Development

git clone into your $GOPATH/src/, which may be ~/go/src/.

git clone \
    [email protected]:shatil/snitch.git \
    $GOPATH/src/github.com/shatil/snitch

For deployment-worth artifacts built locally, I recommend make docker-build. Summary of interesting Makefile targets:

Dependencies

make dep will fetch dependencies to vendor/.

Test

make test runs all tests and make cover-html will do that and generate HTML code coverage.

Run

You can build and run the binaries or pick a binary and:

AWS_REGION=ca-central-1 go run cmd/snitch/main.go

Build

make build builds all binaries in cmd/ and deposits them in this folder.

Install

make install installs the binaries to $GOPATH/bin/. You probably don't love this repo enough to do that--it's there mostly to simplify compiling this repository using Docker.