Moviebeat

Welcome to Moviebeat.

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

Getting Started with Moviebeat

Requirements

• Golang 1.7

Init Project

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

git remote set-url origin https://github.com/robincartier/moviebeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Moviebeat with debugging output enabled, run:

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

Test

To test Moviebeat, 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

To write your own fields in fields.yml check https://www.elastic.co/guide/en/elasticsearch/reference/master/mapping-types.html#_core_datatypes

Cleanup

To clean Moviebeat 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 Moviebeat from the git repository, run the following commands:

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

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.

Useful commands

Delete an elastic index ;

curl -XDELETE localhost:9200/moviebeat-7.0.0-alpha1-2018.xx.xx
curl -XDELETE 'http://localhost:9200/_template/moviebeat*'

Set Up/testing fields.yml

Elastic keep the fields in cache, delete them

curl -XDELETE 'http://localhost:9200/_template/moviebeat*'

Delete your elatic index

curl -XDELETE 'http://localhost:9200/moviebeat*'

Delete indexes in kibana (Management>Index)

If there are errors in fields.yml, elastic doesn't accept the template (but seems not to log anything either).