podbeat

README

Podbeat

Welcome to Podbeat.

Podbeat consumes Proofpoint On Demand events from the logstream.proofpoint.com endpoint.

This is a best effort project after painful python refactors and general jankiness.

I recommend sending these to logstash and setting the guid as _id, becaue this beat has no deduplication considerations and uses overlapping starting offsets on polling to ensure all events are captured.

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

Getting Started with Podbeat

Requirements

• Golang 1.7

Init Project

To get running with Podbeat and also install the dependencies, 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 Podbeat in the git repository, run the following commands:

git remote set-url origin https://github.com/dukeofdisaster/podbeat
git push origin master

For further development, check out the beat developer guide.

Build

To build the binary for Podbeat run the command below. This will generate a binary in the same directory with the name podbeat.

make

Run

To run Podbeat with debugging output enabled, run:

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

Test

To test Podbeat, run the following command:

make testsuite

alternatively:

make unit-tests
make system-tests
make integration-tests
make coverage-report

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

Update

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

make update

Cleanup

To clean Podbeat source code, run the following command:

make fmt

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

make clean

Clone

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

mkdir -p ${GOPATH}/src/github.com/dukeofdisaster/podbeat
git clone https://github.com/dukeofdisaster/podbeat ${GOPATH}/src/github.com/dukeofdisaster/podbeat

For further development, check out the beat developer guide.

Packaging

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

make release

This will fetch and create all images required for the build process. The whole process to finish can take several minutes.