Repository files navigation

An Elastic beat for cloudtrail w/ S3 -> SNS -> SQS

Welcome to Cloudtrailbeat.

Ensure that this folder is at the following location:${GOPATH}/src/github.com/forter/cloudtrailbeat

• Golang 1.7

To get running with Cloudtrailbeat and also install thedependencies, run the following command:

make setup

It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.

To push Cloudtrailbeat in the git repository, run the following commands:

git remote set-url origin https://github.com/forter/cloudtrailbeatgit push origin master

For further development, check out thebeat developer guide.

To build the binary for Cloudtrailbeat run the command below. This will generate a binaryin the same directory with the name cloudtrailbeat.

make

To run Cloudtrailbeat with debugging output enabled, run:

./cloudtrailbeat -c cloudtrailbeat.yml -e -d "*"

To test Cloudtrailbeat, run the following command:

make testsuite

alternatively:

make unit-testsmake system-testsmake integration-testsmake coverage-report

The test coverage is reported in the folder./build/coverage/

Each beat has a template for the mapping in elasticsearch and a documentation for the fieldswhich is automatically generated based onfields.yml by running the following command.

make update

To clean Cloudtrailbeat source code, run the following command:

make fmt

To clean up the build directory and generated artifacts, run:

make clean

To clone Cloudtrailbeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/src/github.com/forter/cloudtrailbeatgit clone https://github.com/forter/cloudtrailbeat ${GOPATH}/src/github.com/forter/cloudtrailbeat

For further development, check out thebeat developer guide.

The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requiresdocker and vendoring as described above. To build packages of your beat, run the following command:

make release