Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seungyongshim/countbeat
https://www.elastic.co/guide/en/beats/devguide/7.2/newbeat-generate.html
https://github.com/seungyongshim/countbeat
Last synced: 15 days ago
JSON representation
https://www.elastic.co/guide/en/beats/devguide/7.2/newbeat-generate.html
- Host: GitHub
- URL: https://github.com/seungyongshim/countbeat
- Owner: seungyongshim
- License: other
- Created: 2019-11-13T05:57:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-13T06:46:41.000Z (about 5 years ago)
- Last Synced: 2024-06-19T14:50:56.944Z (6 months ago)
- Language: Go
- Size: 2.28 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Countbeat
Welcome to Countbeat.
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/seungyongshim/countbeat`
## Getting Started with Countbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with Countbeat 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 Countbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/seungyongshim/countbeat
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 Countbeat run the command below. This will generate a binary
in the same directory with the name countbeat.
```
make
```
### Run
To run Countbeat with debugging output enabled, run:
```
./countbeat -c countbeat.yml -e -d "*"
```
### Test
To test Countbeat, 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 Countbeat source code, run the following command:
```
make fmt
```
To clean up the build directory and generated artifacts, run:
```
make clean
```
### Clone
To clone Countbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/src/github.com/seungyongshim/countbeat
git clone https://github.com/seungyongshim/countbeat ${GOPATH}/src/github.com/seungyongshim/countbeat
```
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 release
```
This will fetch and create all images required for the build process. The whole process to finish can take several minutes.