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 сделаны так, чтобы занимать мало места и потреблять немного ресурсов, без зависимостей во время работы, поэтому они тихо живут на хосте рядом со всем остальным.
Снапшот-сборки можно безопасно использовать в продакшене?Нет — снапшот-сборки строятся на основе main и прямо не предназначены для продакшена; для реальных развёртываний используйте официальную страницу загрузок.
Это работает на серверах с Windows или только под Linux?Поддерживаются обе платформы: Winlogbeat собирает журналы событий Windows, Auditbeat — данные аудита Linux, а macOS проверяется в CI; заранее скомпилированные пакеты есть для всех поддерживаемых платформ.
Что такое libbeat?Это Go-фреймворк из этого репозитория, на котором построены все официальные Beats — с его помощью можно создать и свой собственный Beat.
Мне обязательно прогонять всё через Logstash?Нет — Beats могут отправлять данные прямо в Elasticsearch или сначала пропускать их через Logstash; в обоих случаях результаты в итоге визуализируются в Kibana.
Есть ли Beats помимо официально поддерживаемых?Да — сообщество создало Beats на базе libbeat, которые живут вне этого репозитория на GitHub, и Elastic ведёт их список.
Creator
elastic
Size
523.1 MB
Stars
12.7K
Age
12y
Commits · 90 Days