https://github.com/blockdaemon/polkadotbeat
https://github.com/blockdaemon/polkadotbeat
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/blockdaemon/polkadotbeat
- Owner: Blockdaemon
- License: other
- Created: 2019-08-14T17:29:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-14T17:31:25.000Z (over 5 years ago)
- Last Synced: 2024-11-14T00:32:50.800Z (6 months ago)
- Language: Go
- Size: 42.6 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Polkadotbeat
Welcome to Polkadotbeat.
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/Blockdaemon/polkadotbeat`
## Getting Started with Polkadotbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with Polkadotbeat 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 Polkadotbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/Blockdaemon/polkadotbeat
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 Polkadotbeat run the command below. This will generate a binary
in the same directory with the name polkadotbeat.
```
make
```
### Run
To run Polkadotbeat with debugging output enabled, run:
```
./polkadotbeat -c polkadotbeat.yml -e -d "*"
```
### Test
To test Polkadotbeat, 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 Polkadotbeat source code, run the following command:
```
make fmt
```
To clean up the build directory and generated artifacts, run:
```
make clean
```
### Clone
To clone Polkadotbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/src/github.com/Blockdaemon/polkadotbeat
git clone https://github.com/Blockdaemon/polkadotbeat ${GOPATH}/src/github.com/Blockdaemon/polkadotbeat
```
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.