tyler.durden
/
icingabeat
mirror of https://github.com/Icinga/icingabeat.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Blerim Sheqa 2020-02-26 15:33:45 +01:00
parent f47c510aff
commit 67afdc97b1
1 changed files with 4 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -25,7 +25,7 @@ for more information
#### Requirements
* [Golang](https://golang.org/dl/) 1.10
* [Golang](https://golang.org/dl/) 1.13
#### Clone
@ -47,7 +47,7 @@ To build the binary for Icingabeat run the command below. This will generate a
binary in the same directory with the name icingabeat.
```shell
make
mage build
```
#### Run
@ -57,39 +57,6 @@ To run Icingabeat with debugging output enabled, run:
./icingabeat -c icingabeat.yml -e -d "*"
```
#### Test
To test Icingabeat, run the following command:
```shell
make ci
```
#### Update
Each beat has a template for the mapping in elasticsearch and a documentation
for the fields which is automatically generated based on `etc/fields.yml`.
To generate etc/icingabeat.template.json and etc/icingabeat.asciidoc
```shell
make update
```
#### Cleanup
To clean Icingabeat source code, run the following commands:
```shell
make fmt
make simplify
```
To clean up the build directory and generated artifacts, run:
```shell
make clean
```
### Packaging
The beat frameworks provides tools to crosscompile and package your beat for
@ -98,35 +65,8 @@ vendoring as described above. To build packages of your beat, run the following
command:
```shell
make package
mage package
```
This will fetch and create all images required for the build process. The whole
process can take several minutes to finish.
To disable snapshot packages or build specific packages, set the following
environment variables:
```shell
export SNAPSHOT=false
export TARGETS="\"linux/amd64 linux/386\""
export PACKAGES=icingabeat/deb
make package
```
#### Dashboards
To be able to export dashboards with all their dependencies (visualizations and
searches) you have to name the dashboard with a `icingabeat-` prefix.
Export dashboards:
```shell
export ES_URL=http://127.0.0.1:9200
make export-dashboards
```
After exporting, dashboards can be packaged:
```shell
export SNAPSHOT=false
make package-dashboards
```
process can take several minutes to finish.