Skip to content

Commit f3e1342

Browse files
committed
docs: update README, clean it a bit
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
1 parent 2173c01 commit f3e1342

File tree

1 file changed

+89
-153
lines changed

1 file changed

+89
-153
lines changed

README.md

Lines changed: 89 additions & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,62 @@
22

33
### CI Status
44

5-
| CI Workflow | Status |
6-
|-------------------|--------------------|
7-
| Unit Tests (master) | [![CI/Unit Tests](https://github.com/fluent/fluent-bit/actions/workflows/unit-tests.yaml/badge.svg?branch=master)](https://github.com/fluent/fluent-bit/actions/workflows/unit-tests.yaml) |
8-
| Integration Tests (master) | [![CI/Integration Tests](https://github.com/fluent/fluent-bit/actions/workflows/master-integration-test.yaml/badge.svg)](https://github.com/fluent/fluent-bit/actions/workflows/master-integration-test.yaml)|
9-
| Arm builds | <a href="https://actuated.dev/"><img alt="Arm CI sponsored by Actuated" src="https://docs.actuated.dev/images/actuated-badge.png" width="120px"></img></a> |
10-
| Latest release | [![CI/Build](https://github.com/fluent/fluent-bit/actions/workflows/staging-release.yaml/badge.svg)](https://github.com/fluent/fluent-bit/actions/workflows/staging-release.yaml)|
5+
| CI Workflow | Status |
6+
|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
7+
| Unit Tests (`master`) | [![CI/Unit Tests](https://github.com/fluent/fluent-bit/actions/workflows/unit-tests.yaml/badge.svg?branch=master)](https://github.com/fluent/fluent-bit/actions/workflows/unit-tests.yaml) |
8+
| Integration Tests | [![CI/Integration Tests](https://github.com/fluent/fluent-bit/actions/workflows/master-integration-test.yaml/badge.svg)](https://github.com/fluent/fluent-bit/actions/workflows/master-integration-test.yaml) |
9+
| Arm builds | <a href="https://actuated.dev/"><img alt="Arm CI sponsored by Actuated" src="https://docs.actuated.dev/images/actuated-badge.png" width="120px"></img></a> |
10+
| Latest Release Pipeline | [![CI/Build](https://github.com/fluent/fluent-bit/actions/workflows/staging-release.yaml/badge.svg)](https://github.com/fluent/fluent-bit/actions/workflows/staging-release.yaml) |
11+
12+
---
1113

1214
## About
1315

14-
![](documentation/fluentbit_ecosystem.png)
16+
[Fluent Bit](https://fluentbit.io) is a lightweight and high-performance Telemetry Agent designed to collect, process, and forward **Logs**, **Metrics**, and **Traces** from any source to any destination.
1517

16-
[Fluent Bit](http://fluentbit.io) is a fast Log, Metrics and Traces Processor and Forwarder for Linux, Windows, Embedded Linux, MacOS and BSD family operating systems. It's part of the Graduated [Fluentd](http://fluentd.org) Ecosystem and a [CNCF](https://cncf.io) sub-project.
18+
It's part of the Graduated [Fluentd](https://fluentd.org) Ecosystem and a CNCF [Cloud Native Computing Foundation](https://cncf.io) project.
1719

18-
Fluent Bit allows to collect different signal types such as logs, metrics and traces from different sources, process them and deliver them to different backends such as [Fluentd](http://fluentd.org), Elasticsearch, Splunk, DataDog, Kafka, New Relic, Azure services, AWS services, Google services, NATS, InfluxDB or any custom HTTP end-point.
20+
Fluent Bit supports a wide array of platforms, including Linux, Windows, MacOS, BSD, and Embedded environments, and is built for maximum efficiency with minimal CPU and memory footprint.
1921

20-
Fluent Bit comes with full SQL [Stream Processing](https://docs.fluentbit.io/manual/stream-processing/introduction) capabilities: data manipulation and analytics using SQL queries.
22+
![](documentation/fluentbit_ecosystem.png)
2123

22-
Fluent Bit runs on x86_64, x86, arm32v7, and arm64v8 architectures.
24+
---
2325

24-
## Features
26+
## 📌 Roadmap & Maintenance
2527

26-
- High Performance at low CPU and Memory footprint
27-
- Data Parsing
28-
- Convert your unstructured messages using our parsers: [JSON](https://docs.fluentbit.io/manual/pipeline/parsers/json), [Regex](https://docs.fluentbit.io/manual/pipeline/parsers/regular-expression), [LTSV](https://docs.fluentbit.io/manual/pipeline/parsers/ltsv) and [Logfmt](https://docs.fluentbit.io/manual/pipeline/parsers/logfmt)
29-
- Reliability and Data Integrity
30-
- [Backpressure](https://docs.fluentbit.io/manual/administration/backpressure) Handling
31-
- [Data Buffering](https://docs.fluentbit.io/manual/administration/buffering-and-storage) in memory and file system
32-
- Networking
33-
- Security: built-in TLS/SSL support
34-
- Asynchronous I/O
35-
- Pluggable Architecture and [Extensibility](https://docs.fluentbit.io/manual/development): Inputs, Filters and Outputs
36-
- More than 70 built-in plugins available
37-
- Extensibility
38-
- Write any input, filter or output plugin in C language
39-
- Write [Filters in Lua](https://docs.fluentbit.io/manual/filter/lua) or [Output plugins in Golang](https://docs.fluentbit.io/manual/development/golang-output-plugins)
40-
- [Monitoring](https://docs.fluentbit.io/manual/administration/monitoring): expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format
41-
- [Stream Processing](https://docs.fluentbit.io/manual/stream-processing/introduction): Perform data selection and transformation using simple SQL queries
42-
- Create new streams of data using query results
43-
- Aggregation Windows
44-
- Data analysis and prediction: Timeseries forecasting
45-
- Portable: runs on Linux, MacOS, Windows and BSD systems
28+
We follow a fast-paced development cycle, with major releases every 3–4 months.
29+
The active development branch (`master`) is currently focused on **v4.1**.
4630

47-
## Fluent Bit in Production
31+
For version-specific maintenance timelines and policies, see our [MAINTENANCE.md](https://github.com/fluent/fluent-bit/blob/master/MAINTENANCE.md).
4832

49-
Fluent Bit is a widely adopted solution in production environments. As of 2024, Fluent Bit has surpassed 15 billion downloads and continues to be deployed over 10 million times daily. Below is a preview of some of the organizations that rely heavily on Fluent Bit in their production systems:
33+
To track upcoming milestones, visit the [project roadmap](https://github.com/fluent/fluent-bit/wiki/Roadmap).
5034

51-
> If your company uses Fluent Bit and is not listed, feel free to open a GitHub issue and we will add the logo.
35+
---
5236

53-
![users](documentation/fluentbit_users.png)
37+
## Key Features
5438

55-
## [Documentation](https://docs.fluentbit.io)
39+
-**High Performance** with low memory footprint
40+
- 📦 **Pluggable Architecture**: 70+ built-in plugins for Inputs, Filters, and Outputs
41+
- 🧠 **SQL Stream Processing**: Perform analytics and transformations with SQL queries
42+
- 🔒 **Secure Networking**: Built-in TLS/SSL support and async I/O
43+
- 📊 **Monitoring**: Expose internal metrics over HTTP/Prometheus
44+
- 🧩 **Extensibility**:
45+
- Write plugins in **C**, filters in **Lua**, and outputs in **Go**
46+
- 🔌 **Supports Logs, Metrics, and Traces** with unified processing and delivery
5647

57-
Our official project documentation for [installation](https://docs.fluentbit.io/manual/installation), [configuration](https://docs.fluentbit.io/manual/administration/configuring-fluent-bit), deployment and development topics is located here:
48+
---
5849

59-
- [https://docs.fluentbit.io](https://fluentbit.io)
50+
## Documentation
6051

61-
### Quick Start
52+
Our official documentation includes installation guides, plugin usage, developer resources, and more:
6253

63-
#### Build from Scratch
54+
📚 [https://docs.fluentbit.io](https://docs.fluentbit.io)
6455

65-
If you aim to build Fluent Bit from sources, you can go ahead and start with the following commands.
56+
---
57+
58+
## Quick Start
59+
60+
Build from source:
6661

6762
```bash
6863
cd build
@@ -71,133 +66,74 @@ make
7166
bin/fluent-bit -i cpu -o stdout -f 1
7267
```
7368

74-
If you are interested into more details, please refer to the [Build & Install](https://docs.fluentbit.io/manual/installation/sources/build-and-install) section.
69+
More details: [Build & Install](https://docs.fluentbit.io/manual/installation/sources/build-and-install)
7570

7671
#### Requirements
7772

7873
- CMake >= 3.0
79-
- Flex
80-
- Bison
81-
- YAML library/headers
82-
- OpenSSL library/headers
83-
84-
#### Linux Packages
85-
86-
We provide packages for most common Linux distributions:
87-
88-
- [Debian](https://docs.fluentbit.io/manual/installation/linux/debian)
89-
- [Raspbian](https://docs.fluentbit.io/manual/installation/linux/raspbian-raspberry-pi)
90-
- [Ubuntu](https://docs.fluentbit.io/manual/installation/linux/ubuntu)
91-
- [CentOS](https://docs.fluentbit.io/manual/installation/linux/redhat-centos)
92-
93-
#### Linux / Docker Container Images
94-
95-
Our Linux containers images are the most common deployment model, thousands of
96-
new installation happen every day, learn more about the available images and
97-
tags [here](https://docs.fluentbit.io/manual/installation/docker).
98-
99-
#### Windows Packages
100-
101-
Fluent Bit is fully supported on Windows environments, get started with [these instructions](https://docs.fluentbit.io/manual/installation/windows).
102-
103-
#### Running on s390x
104-
105-
Fluent Bit runs on Linux on IBM Z(s390x), but the WASM filter plugin is not. For the LUA filter plugin, it runs when `libluajit` is installed on the system and fluent bit is built with `FLB_LUAJIT` and `FLB_PREFER_SYSTEM_LIB_LUAJIT` on.
106-
107-
### Plugins: Inputs, Filters and Outputs
108-
109-
[Fluent Bit](http://fluentbit.io) is based in a pluggable architecture where different plugins plays a major role in the data pipeline:
110-
111-
#### Input Plugins
112-
113-
| name | title | description |
114-
| :--- | :--- | :--- |
115-
| [collectd](https://docs.fluentbit.io/manual/pipeline/inputs/collectd) | Collectd | Listen for UDP packets from Collectd. |
116-
| [cpu](https://docs.fluentbit.io/manual/pipeline/inputs/cpu-metrics) | CPU Usage | measure total CPU usage of the system. |
117-
| [disk](https://docs.fluentbit.io/manual/pipeline/inputs/disk-io-metrics) | Disk Usage | measure Disk I/Os. |
118-
| [dummy](https://docs.fluentbit.io/manual/pipeline/inputs/dummy) | Dummy | generate dummy event. |
119-
| [exec](https://docs.fluentbit.io/manual/pipeline/inputs/exec) | Exec | executes external program and collects event logs. |
120-
| [forward](https://docs.fluentbit.io/manual/pipeline/inputs/forward) | Forward | Fluentd forward protocol. |
121-
| [head](https://docs.fluentbit.io/manual/pipeline/inputs/head) | Head | read first part of files. |
122-
| [health](https://docs.fluentbit.io/manual/pipeline/inputs/health) | Health | Check health of TCP services. |
123-
| [kmsg](https://docs.fluentbit.io/manual/pipeline/inputs/kernel-logs) | Kernel Log Buffer | read the Linux Kernel log buffer messages. |
124-
| [mem](https://docs.fluentbit.io/manual/pipeline/inputs/memory-metrics) | Memory Usage | measure the total amount of memory used on the system. |
125-
| [mqtt](https://docs.fluentbit.io/manual/pipeline/inputs/mqtt) | MQTT | start a MQTT server and receive publish messages. |
126-
| [netif](https://docs.fluentbit.io/manual/pipeline/inputs/network-io-metrics) | Network Traffic | measure network traffic. |
127-
| [proc](https://docs.fluentbit.io/manual/pipeline/inputs/process) | Process | Check health of Process. |
128-
| [random](https://docs.fluentbit.io/manual/pipeline/inputs/random) | Random | Generate Random samples. |
129-
| [serial](https://docs.fluentbit.io/manual/pipeline/inputs/serial-interface) | Serial Interface | read data information from the serial interface. |
130-
| [stdin](https://docs.fluentbit.io/manual/pipeline/inputs/standard-input) | Standard Input | read data from the standard input. |
131-
| [syslog](https://docs.fluentbit.io/manual/pipeline/inputs/syslog) | Syslog | read syslog messages from a Unix socket. |
132-
| [systemd](https://docs.fluentbit.io/manual/pipeline/inputs/systemd) | Systemd | read logs from Systemd/Journald. |
133-
| [tail](https://docs.fluentbit.io/manual/pipeline/inputs/tail) | Tail | Tail log files. |
134-
| [tcp](https://docs.fluentbit.io/manual/pipeline/inputs/tcp) | TCP | Listen for JSON messages over TCP. |
135-
| [thermal](https://docs.fluentbit.io/manual/pipeline/inputs/thermal) | Thermal | measure system temperature(s). |
136-
137-
#### Filter Plugins
138-
139-
| name | title | description |
140-
| :--- | :--- | :--- |
141-
| [aws](https://docs.fluentbit.io/manual/pipeline/filters/aws-metadata) | AWS Metadata | Enrich logs with AWS Metadata. |
142-
| [expect](https://docs.fluentbit.io/manual/pipeline/filters/expect) | Expect | Validate records match certain criteria in structure. |
143-
| [grep](https://docs.fluentbit.io/manual/pipeline/filters/grep) | Grep | Match or exclude specific records by patterns. |
144-
| [kubernetes](https://docs.fluentbit.io/manual/pipeline/filters/kubernetes) | Kubernetes | Enrich logs with Kubernetes Metadata. |
145-
| [lua](https://docs.fluentbit.io/manual/pipeline/filters/lua) | Lua | Filter records using Lua Scripts. |
146-
| [parser](https://docs.fluentbit.io/manual/pipeline/filters/parser) | Parser | Parse record. |
147-
| [record\_modifier](https://docs.fluentbit.io/manual/pipeline/filters/record-modifier) | Record Modifier | Modify record. |
148-
| [rewrite\_tag](https://docs.fluentbit.io/manual/pipeline/filters/rewrite-tag) | Rewrite Tag | Re-emit records under new tag. |
149-
| [stdout](https://docs.fluentbit.io/manual/pipeline/filters/standard-output) | Stdout | Print records to the standard output interface. |
150-
| [throttle](https://docs.fluentbit.io/manual/pipeline/filters/throttle) | Throttle | Apply rate limit to event flow. |
151-
| [nest](https://docs.fluentbit.io/manual/pipeline/filters/nest) | Nest | Nest records under a specified key |
152-
| [modify](https://docs.fluentbit.io/manual/pipeline/filters/modify) | Modify | Modifications to record. |
153-
154-
#### Output Plugins
155-
156-
| name | title | description |
157-
| :--- | :--- | :--- |
158-
| [azure](https://docs.fluentbit.io/manual/pipeline/outputs/azure) | Azure Log Analytics | Ingest records into Azure Log Analytics |
159-
| [bigquery](https://docs.fluentbit.io/manual/pipeline/outputs/bigquery) | BigQuery | Ingest records into Google BigQuery |
160-
| [counter](https://docs.fluentbit.io/manual/pipeline/outputs/counter) | Count Records | Simple records counter. |
161-
| [datadog](https://docs.fluentbit.io/manual/pipeline/outputs/datadog) | Datadog | Ingest logs into Datadog. |
162-
| [es](https://docs.fluentbit.io/manual/pipeline/outputs/elasticsearch) | Elasticsearch | flush records to a Elasticsearch server. |
163-
| [file](https://docs.fluentbit.io/manual/pipeline/outputs/file) | File | Flush records to a file. |
164-
| [flowcounter](https://docs.fluentbit.io/manual/pipeline/outputs/flowcounter) | FlowCounter | Count records. |
165-
| [forward](https://docs.fluentbit.io/manual/pipeline/outputs/forward) | Forward | Fluentd forward protocol. |
166-
| [gelf](https://docs.fluentbit.io/manual/pipeline/outputs/gelf) | GELF | Flush records to Graylog |
167-
| [http](https://docs.fluentbit.io/manual/pipeline/outputs/http) | HTTP | Flush records to an HTTP end point. |
168-
| [influxdb](https://docs.fluentbit.io/manual/pipeline/outputs/influxdb) | InfluxDB | Flush records to InfluxDB time series database. |
169-
| [kafka](https://docs.fluentbit.io/manual/pipeline/outputs/kafka) | Apache Kafka | Flush records to Apache Kafka |
170-
| [kafka-rest](https://docs.fluentbit.io/manual/pipeline/outputs/kafka-rest-proxy) | Kafka REST Proxy | Flush records to a Kafka REST Proxy server. |
171-
| [loki](https://docs.fluentbit.io/manual/pipeline/outputs/loki) | Loki | Flush records to Loki server. |
172-
| [nats](https://docs.fluentbit.io/manual/pipeline/outputs/nats) | NATS | Flush records to a NATS server. |
173-
| [null](https://docs.fluentbit.io/manual/pipeline/outputs/null) | NULL | Throw away events. |
174-
| [s3](https://docs.fluentbit.io/manual/pipeline/outputs/s3) | S3 | Flush records to s3 |
175-
| [stackdriver](https://docs.fluentbit.io/manual/pipeline/outputs/stackdriver) | Google Stackdriver Logging | Flush records to Google Stackdriver Logging service. |
176-
| [stdout](https://docs.fluentbit.io/manual/pipeline/outputs/standard-output) | Standard Output | Flush records to the standard output. |
177-
| [splunk](https://docs.fluentbit.io/manual/pipeline/outputs/splunk) | Splunk | Flush records to a Splunk Enterprise service |
178-
| [tcp](https://docs.fluentbit.io/manual/pipeline/outputs/tcp-and-tls) | TCP & TLS | Flush records to a TCP server. |
179-
| [td](https://docs.fluentbit.io/manual/pipeline/outputs/treasure-data) | [Treasure Data](http://www.treasuredata.com) | Flush records to the [Treasure Data](http://www.treasuredata.com) cloud service for analytics. |
74+
- Flex & Bison
75+
- YAML and OpenSSL headers
76+
77+
---
78+
79+
## Install Fluent Bit
80+
81+
- [Linux packages (Debian, Ubuntu, RHEL, etc.)](https://docs.fluentbit.io/manual/installation/linux)
82+
- [Docker images](https://docs.fluentbit.io/manual/installation/docker)
83+
- [Windows binaries](https://docs.fluentbit.io/manual/installation/windows)
84+
- [IBM Z (s390x)](https://docs.fluentbit.io/manual/installation/linux/s390x)
85+
86+
---
87+
88+
## Plugins: Inputs, Filters, Outputs
89+
90+
Fluent Bit is fully modular. It supports:
91+
92+
- [Input Plugins](https://docs.fluentbit.io/manual/pipeline/inputs): collect logs/metrics/traces
93+
- [Filter Plugins](https://docs.fluentbit.io/manual/pipeline/filters): enrich and transform data
94+
- [Output Plugins](https://docs.fluentbit.io/manual/pipeline/outputs): deliver data to external services
95+
96+
See the full plugin list in our [documentation](https://docs.fluentbit.io/manual/pipeline/inputs).
97+
98+
---
99+
100+
## 🚀 Production Usage
101+
102+
Fluent Bit is deployed **over 10 million times daily** and has surpassed **15 billion downloads**.
103+
104+
Used by companies like:
105+
106+
![users](documentation/fluentbit_users.png)
107+
108+
> Want to add your logo? [Open an issue](https://github.com/fluent/fluent-bit/issues).
109+
110+
---
180111

181112
## Contributing
182113

183-
[Fluent Bit](https://fluentbit.io) is an open project, several individuals and companies contribute in different forms like coding, documenting, testing, spreading the word at events within others. If you want to learn more about contributing opportunities please reach out to us through our [Community Channels](https://fluentbit.io/community/).
114+
Fluent Bit is open to community contributions!
184115

185-
If you are interested in contributing to Fluent bit with bug fixes, new features or coding in general, please refer to the code [CONTRIBUTING](CONTRIBUTING.md) guidelines. You can also refer the Beginners Guide to contributing to Fluent Bit [here.](DEVELOPER_GUIDE.md)
116+
- 🤝 [Join our community](https://fluentbit.io/community/)
117+
- 🛠 [CONTRIBUTING.md](CONTRIBUTING.md)
118+
- 🚀 [Developer Guide](DEVELOPER_GUIDE.md)
119+
120+
---
186121

187122
## Community & Contact
188123

189-
Feel free to join us on our Slack channel, Mailing List or IRC:
124+
- 💬 [Slack](http://slack.fluentd.org) (`#fluent-bit` channel)
125+
- 🐦 [Twitter](https://twitter.com/fluentbit)
190126

191-
- [Slack](http://slack.fluentd.org) (#fluent-bit channel)
192-
- [Twitter](http://twitter.com/fluentbit)
127+
---
193128

194129
## License
195130

196-
This program is under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
131+
[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0)
197132

198-
## Authors
133+
---
199134

200-
[Fluent Bit](http://fluentbit.io) is sponsored and maintained by several companies in the Cloud Native community, including all the major cloud providers.
135+
## Authors
201136

202-
You can see a list of contributors [here](https://github.com/fluent/fluent-bit/graphs/contributors).
137+
Fluent Bit is a CNCF sub-project, sponsored and maintained by major cloud providers and a growing community of contributors and maintainers from across the Cloud Native ecosystem.
203138

139+
👉 [See Contributors](https://github.com/fluent/fluent-bit/graphs/contributors)

0 commit comments

Comments
 (0)