https://github.com/pravoru/consulbeat
Push services health checks from consul to elastic
https://github.com/pravoru/consulbeat
Last synced: 6 months ago
JSON representation
Push services health checks from consul to elastic
- Host: GitHub
- URL: https://github.com/pravoru/consulbeat
- Owner: Pravoru
- License: other
- Created: 2016-11-07T04:01:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-07T09:03:58.000Z (over 9 years ago)
- Last Synced: 2025-02-12T09:56:46.254Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 62.5 KB
- Stars: 5
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Consulbeat
Welcome to Consulbeat.
Ensure that this folder is at the following location:
`${GOPATH}/github.com/pravoru`
## Getting Started with Consulbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
* [Glide](https://github.com/Masterminds/glide)
### Init Project
To get running with Consulbeat and also install the
dependencies, run the following command:
```
glide install
```
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 Consulbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/pravoru/consulbeat
git push origin master
```
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
### Build
To build the binary for Consulbeat run the command below. This will generate a binary
in the same directory with the name consulbeat.
```
make
```
### Run
To run Consulbeat with debugging output enabled, run:
```
./consulbeat -c consulbeat.yml -e -d "*"
```
### Test
To test Consulbeat, 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/consulbeat.template.json and etc/consulbeat.asciidoc
```
make update
```
### Cleanup
To clean Consulbeat 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 Consulbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/github.com/pravoru
cd ${GOPATH}/github.com/pravoru
git clone https://github.com/pravoru/consulbeat
```
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
## Packaging
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires [docker](https://www.docker.com/) 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.
## Downloading
You can download prebuild binaries from [releases page](https://github.com/Pravoru/consulbeat/releases/)