beats README

The project's README from github.com/elastic/beats. As one markdown file: README.md.

Go Report Card Reviewed by Hound

Beats - The Lightweight Shippers of the Elastic Stack

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.

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

This repository contains libbeat, our Go framework for creating Beats, and all the officially supported Beats:

Beat Description
Auditbeat Collect your Linux audit framework data and monitor the integrity of your files.
Filebeat Tails and ships log files
Heartbeat Ping remote services for availability
Metricbeat Fetches sets of metrics from the operating system and services
Packetbeat Monitors the network and applications by sniffing packets
Winlogbeat Fetches and ships Windows Event logs
Osquerybeat Runs Osquery and manages interaction with it.

In addition to the above Beats, which are officially supported by Elastic, the community has created a set of other Beats that make use of libbeat but live outside of this GitHub repository. We maintain a list of community Beats here.

Documentation and Getting Started

You can find the documentation and getting started guides for each of the Beats on the elastic.co site:

Documentation and Getting Started information for the Elastic Agent

You can find the documentation and getting started guides for the Elastic Agent on the elastic.co site

Getting Help

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

Downloads

You can download pre-compiled Beats binaries, as well as packages for the supported platforms, from this page.

Contributing

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 even create your own Beat.

Please start by reading our CONTRIBUTING file.

AI Coding Agents

Repository instructions for AI coding agents are in AGENTS.md. To use it, copy it to the agent-specific filename: CLAUDE.md, GEMINI.md, and similar files, which are ignored by Git.

Building Beats from the Source

See our CONTRIBUTING file for information about setting up your dev environment to build Beats from the source.

Snapshots

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

CI

PR Comments

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.)

PR Labels

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

beats (elastic/beats)

Searching Database…

12.7K ·GitHub
这是做什么的?Beats 是用 Go 编写的轻量级数据采集器:把它们装到服务器上,就能收集运维数据——日志、指标、网络数据包——并发送到 Elasticsearch,再由 Kibana 进行可视化展示。
这是一个采集器,还是一整套各自独立的采集器?是七个官方 Beats 组成的一套:Filebeat 跟踪日志文件,Metricbeat 获取操作系统和服务指标,Packetbeat 抓取网络数据包,Heartbeat 监测服务是否在线,还有 Auditbeat、Winlogbeat 和 Osquerybeat。
我怎么把 Beat 装到我的服务器上?从 Elastic 下载页面下载适用于各支持平台的预编译二进制文件或安装包;每个 Beat 的文档和入门指南都在 elastic.co 上。
这些采集器会拖上一堆依赖吗?不会——Beats 的设计目标就是安装体积小、资源占用少,没有任何运行时依赖,可以安静地和主机上的其他东西共存运行。
snapshot 版本能在生产环境里跑吗?不能——snapshot 版本基于 main 分支构建,官方明确说明不适用于生产环境;正式部署请使用官方下载页面。
支持 Windows 服务器吗,还是只有 Linux 能用?两边都支持:Winlogbeat 采集 Windows 事件日志,Auditbeat 收集 Linux 审计数据,macOS 也在持续集成中经过测试;各支持平台都有预编译安装包。
libbeat 是什么?它是本仓库中包含的 Go 框架,所有官方 Beats 都基于它构建——你也可以用它来打造自己的 Beat。
数据必须经过 Logstash 中转吗?不用——Beats 可以直接把数据发给 Elasticsearch,也可以先经过 Logstash 再转发;无论哪种方式,结果最终都会在 Kibana 里可视化展示。
除了官方支持的 Beat,还有别的吗?有——社区基于 libbeat 开发了一些 Beats,它们不在这个 GitHub 仓库里,Elastic 维护了一份它们的列表。
Creator
elastic
Size
523.2 MB
Stars
12.7K
Age
12y
Commits · 90 Days