Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanjm/natsbeat
Natsbeat is a beat based on <github.com/nats-io/nats-top/util>
https://github.com/hanjm/natsbeat
elasticbeats go nats
Last synced: about 1 month ago
JSON representation
Natsbeat is a beat based on <github.com/nats-io/nats-top/util>
- Host: GitHub
- URL: https://github.com/hanjm/natsbeat
- Owner: hanjm
- License: other
- Created: 2018-04-07T15:10:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-07T15:20:42.000Z (over 6 years ago)
- Last Synced: 2024-10-14T18:52:53.706Z (2 months ago)
- Topics: elasticbeats, go, nats
- Language: Go
- Size: 19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Natsbeat
Natsbeat is a beat based on
Welcome to Natsbeat.
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/hanjm/natsbeat`
## Getting Started with Natsbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with Natsbeat 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 Natsbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/hanjm/natsbeat
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 Natsbeat run the command below. This will generate a binary
in the same directory with the name natsbeat.
```
make
```
### Run
To run Natsbeat with debugging output enabled, run:
```
./natsbeat -c natsbeat.yml -e -d "*"
```
### Test
To test Natsbeat, 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 Natsbeat 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 Natsbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/src/github.com/hanjm/natsbeat
git clone https://github.com/hanjm/natsbeat ${GOPATH}/src/github.com/hanjm/natsbeat
```
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.