Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 2.77 KB

README.md

File metadata and controls

130 lines (82 loc) · 2.77 KB
Raw

Esbeat

Welcome to Esbeat.

Esbeat is used to collect ElasticSearch statistics by rest http api.

  • /_cluster/health
  • /_cluster/stats
  • /_nodes/_local
  • /_nodes/_local/stats

Esbeat will find the list of all nodes in elasticsearch cluster automatically when it is started, and fetch data by every node.

Pull Request and Suggestion is most welcome to us. You can add any problems to Issues.

Ensure that this folder is at the following location: ${GOPATH}/github.com/wangdisdu/esbeat

Getting Started with Esbeat

Requirements

Init Project

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

git remote set-url origin https://github.com/wangdisdu/esbeat
git push origin master

For further development, check out the beat developer guide.

Build

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

make

Run

To run Esbeat with debugging output enabled, run:

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

Test

To test Esbeat, 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/esbeat.template.json and etc/esbeat.asciidoc

make update

Cleanup

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

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

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.