0b733ea23f | ||
---|---|---|
.github | ||
_meta | ||
beater | ||
cmd | ||
config | ||
data | ||
docs | ||
include | ||
screenshots | ||
tests/system | ||
.gitignore | ||
.mailmap | ||
.travis.yml | ||
AUTHORS | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
LICENSE.txt | ||
Makefile | ||
NOTICE.txt | ||
README.md | ||
RELEASE.md | ||
dashboards.yml | ||
fields.yml | ||
go.mod | ||
go.sum | ||
icingabeat.docker.yml | ||
icingabeat.reference.yml | ||
icingabeat.yml | ||
magefile.go | ||
main.go | ||
main_test.go |
README.md
Icingabeat
The Beats are lightweight data shippers, written in Go, that you install on your servers to capture all sorts of operational data (think of logs, metrics, or network packet data). The Beats send the operational data to Elasticsearch, either directly or via Logstash, so it can be visualized with Kibana.
Icingabeat is an Elastic Beat that fetches data from the Icinga 2 API and sends it either directly to Elasticsearch or Logstash.
Documentation
Please read the documentation on icinga.com/docs/icingabeat/latest for more information
Development
Building and running manually
Requirements
- Golang 1.16
Clone
To clone Icingabeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/icinga
cd ${GOPATH}/github.com/icinga
git clone https://github.com/icinga/icingabeat
For further development check out the beat developer guide.
Build
Ensure that this folder is at the following location:
${GOPATH}/github.com/icinga
To build the binary for Icingabeat run the command below. This will generate a binary in the same directory with the name icingabeat.
mage build
Run
To run Icingabeat with debugging output enabled, run:
./icingabeat -c icingabeat.yml -e -d "*"
Packaging
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires docker and vendoring as described above. To build packages of your beat, run the following command:
export PLATFORMS="linux/amd64 linux/386"
mage package
This will fetch and create all images required for the build process. The whole process can take several minutes to finish.