https://github.com/akagi201/jsonbeat
Jsonbeat is a JSON log harvester, mostly used to fetch logs files and feed them into Elasticsearch.
https://github.com/akagi201/jsonbeat
beats elastic elasticsearch filebeat jsonbeat logging
Last synced: about 2 months ago
JSON representation
Jsonbeat is a JSON log harvester, mostly used to fetch logs files and feed them into Elasticsearch.
- Host: GitHub
- URL: https://github.com/akagi201/jsonbeat
- Owner: Akagi201
- License: other
- Created: 2017-03-10T08:30:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-23T08:00:55.000Z (about 9 years ago)
- Last Synced: 2025-01-08T23:25:56.617Z (over 1 year ago)
- Topics: beats, elastic, elasticsearch, filebeat, jsonbeat, logging
- Language: Go
- Homepage:
- Size: 18.4 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Jsonbeat
Welcome to Jsonbeat.
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/Akagi201/jsonbeat`
## Getting Started with Jsonbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with Jsonbeat 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 Jsonbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/Akagi201/jsonbeat
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 Jsonbeat run the command below. This will generate a binary
in the same directory with the name jsonbeat.
```
make
```
### Run
To run Jsonbeat with debugging output enabled, run:
```
./jsonbeat -c jsonbeat.yml -e -d "*"
```
### Test
To test Jsonbeat, 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 Jsonbeat 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 Jsonbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/src/github.com/Akagi201/jsonbeat
git clone https://github.com/Akagi201/jsonbeat ${GOPATH}/src/github.com/Akagi201/jsonbeat
```
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.