amazonbeat

README

Amazonbeat

AmazonBeat is an elastic beat that reads data about Amazon products and indexes them into elasticsearch. You can configure which products can be read.

To use AmazonBeat, you'll need a valid ASIN (Amazon Standard Identification Number). ASINs are unique blocks of 10 letters and/or numbers that identify items. You can find the ASIN on the item's product information page at Amazon.com and in the URL for the page. The quickest way to find your product's ASIN is to look in your browser's address bar.

Getting Started with Amazonbeat

Requirements

• Golang 1.7
• Python 2.7

Init Project

To get running with Amazonbeat 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 Amazonbeat in the git repository, run the following commands:

git remote set-url origin https://github.com/awormuth/amazonbeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Amazonbeat with debugging output enabled, run:

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

Test

To test Amazonbeat, 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 etc/fields.yml. To generate etc/amazonbeat.template.json and etc/amazonbeat.asciidoc

make update

Cleanup

To clean Amazonbeat source code, run the following commands:

make fmt
make simplify

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

make clean

Clone

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

mkdir -p ${GOPATH}/github.com/awormuth
cd ${GOPATH}/github.com/awormuth
git clone https://github.com/awormuth/amazonbeat

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 package

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