Repository files navigation

TheBeats are lightweight datashippers, written in Go, that you install on your servers to capture all sortsof operational data (think of logs, metrics, or network packet data). The Beatssend the operational data to Elasticsearch, either directly or via Logstash, soit can be visualized with Kibana.

By "lightweight", we mean that Beats have a small installation footprint, uselimited system resources, and have no runtime dependencies.

This repository containslibbeat, our Goframework for creating Beats, and all the officially supported Beats:

In addition to the above Beats, which are officially supported byElastic, the community has created a set of other Beatsthat make use of libbeat but live outside of this Github repository. We maintaina list of community Beatshere.

You can find the documentation and getting started guides for each of the Beatson theelastic.co site:

• Beats platform
• Auditbeat
• Filebeat
• Heartbeat
• Metricbeat
• Packetbeat
• Winlogbeat

You can find the documentation and getting started guides for the Elastic Agenton theelastic.co site

If you need help or hit an issue, please start by opening a topic on ourdiscuss forums. Please note that wereserve GitHub tickets for confirmed bugs and enhancement requests.

You can download pre-compiled Beats binaries, as well as packages for thesupported platforms, fromthis page.

We'd love working with you! You can help make the Beats better in many ways:report issues, help us reproduce issues, fix bugs, add functionality, or evencreate your own Beat.

Please start by reading ourCONTRIBUTING file.

See ourCONTRIBUTING file for information about setting upyour dev environment to build Beats from the source.

For testing purposes, we generate snapshot builds that you can findhere. Please be aware that these are built on top of main and are not meant for production.

It is possible to trigger some jobs by putting a comment on a GitHub PR.(This service is only available for users affiliated with Elastic and not for open-source contributors.)

• beats CI pipeline
  • /test will kick off a default build.
• docs CI pipeline
  • run docs-build will kick off a docs build.

It's possible to configure the build on a GitHub PR by labeling the PR with certain labels. Elastic users can find more details athttps://docs.elastic.dev/ingest-dev-docs/beats/beats-ci.