Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pvital/countbeat
Dummy Elastic Beat example
https://github.com/pvital/countbeat
Last synced: about 1 month ago
JSON representation
Dummy Elastic Beat example
- Host: GitHub
- URL: https://github.com/pvital/countbeat
- Owner: pvital
- License: other
- Created: 2021-08-31T13:59:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-31T14:02:31.000Z (over 3 years ago)
- Last Synced: 2024-06-20T23:58:01.734Z (6 months ago)
- Language: Go
- Size: 217 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# {Beat}
Welcome to {Beat}.
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/pvital/countbeat`
## Getting Started with {Beat}
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with {Beat} and also install the
dependencies, run the following command:
```
make update
```
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 {Beat} in the git repository, run the following commands:
```
git remote set-url origin https://github.com/pvital/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 {Beat} run the command below. This will generate a binary
in the same directory with the name countbeat.
```
make
```
### Run
To run {Beat} with debugging output enabled, run:
```
./countbeat -c countbeat.yml -e -d "*"
```
### Test
To test {Beat}, 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 {Beat} source code, run the following command:
```
make fmt
```
To clean up the build directory and generated artifacts, run:
```
make clean
```
### Clone
To clone {Beat} from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/src/github.com/pvital/countbeat
git clone https://github.com/pvital/countbeat ${GOPATH}/src/github.com/pvital/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.