Skip to content

Commit 1bc4c59

Browse files
authored
Merge pull request #1454 from fluent/lynettemiles/sc-105687/update-readme-md-fluent-bit-doc
Fluent bit: docs: readme: apply style guide to readme
2 parents 9b39bf8 + 0868a4f commit 1bc4c59

File tree

1 file changed

+36
-27
lines changed

1 file changed

+36
-27
lines changed

README.md

Lines changed: 36 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,51 @@ description: High Performance Telemetry Agent for Logs, Metrics and Traces
66

77
<figure><img src=".gitbook/assets/3.1.png" alt=""><figcaption></figcaption></figure>
88

9-
[Fluent Bit](http://fluentbit.io) is a fast and lightweight **telemetry agent**
9+
[Fluent Bit](http://fluentbit.io) is a fast and lightweight telemetry agent
1010
for logs, metrics, and traces for Linux, macOS, Windows, and BSD family
11-
operating systems. It has been made with a strong focus on performance to allow
11+
operating systems. Fluent Bit has been made with a strong focus on performance to allow
1212
the collection and processing of telemetry data from different sources without
1313
complexity.![](https://static.scarf.sh/a.png?x-pxid=71f0e011-761f-4c6f-9a89-38817887faae)
1414

1515
## Features
1616

17-
* High Performance: High throughput with low resources consumption
18-
* Data Parsing
19-
* Convert your unstructured messages using our parsers: [JSON](pipeline/parsers/json.md), [Regex](pipeline/parsers/regular-expression.md), [LTSV](pipeline/parsers/ltsv.md) and [Logfmt](pipeline/parsers/logfmt.md)
20-
* Metrics Support: Prometheus and OpenTelemetry compatible
21-
* Reliability and Data Integrity
22-
* [Backpressure](administration/backpressure.md) Handling
23-
* [Data Buffering](administration/buffering-and-storage.md) in memory and file system
24-
* Networking
25-
* Security: built-in TLS/SSL support
26-
* Asynchronous I/O
27-
* Pluggable Architecture and [Extensibility](development/library_api.md): Inputs, Filters and Outputs
28-
* Connect nearly any source to nearly any destination using preexisting plugins
29-
* Extensibility
30-
* Write any input, filter or output plugin in C language
31-
* WASM: [WASM Filter Plugins](development/wasm-filter-plugins.md) or [WASM Input Plugins](development/wasm-input-plugins.md)
32-
* Bonus: write [Filters in Lua](pipeline/filters/lua.md) or [Output plugins in Golang](development/golang-output-plugins.md)
33-
* [Monitoring](administration/monitoring.md): expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format
34-
* [Stream Processing](stream-processing/introduction.md): Perform data selection and transformation using simple SQL queries
35-
* Create new streams of data using query results
36-
* Aggregation Windows
37-
* Data analysis and prediction: Timeseries forecasting
38-
* Portable: runs on Linux, macOS, Windows and BSD systems
17+
- High performance: High throughput with low resources consumption
18+
- Data parsing
19+
- Convert your unstructured messages using our parsers:
20+
[JSON](pipeline/parsers/json.md),
21+
[Regex](pipeline/parsers/regular-expression.md),
22+
[LTSV](pipeline/parsers/ltsv.md) and [Logfmt](pipeline/parsers/logfmt.md)
23+
- Metrics support: Prometheus and OpenTelemetry compatible
24+
- Reliability and data integrity
25+
- [Backpressure](administration/backpressure.md) handling
26+
- [Data buffering](administration/buffering-and-storage.md) in memory and file system
27+
- Networking
28+
- Security: Built-in TLS/SSL support
29+
- Asynchronous I/O
30+
- Pluggable architecture and [extensibility](development/library_api.md): Inputs,
31+
Filters and Outputs:
32+
- Connect nearly any source to nearly any destination using preexisting plugins
33+
- Extensibility:
34+
- Write input, filter, or output plugins in the C language
35+
- WASM: [WASM Filter Plugins](development/wasm-filter-plugins.md) or
36+
[WASM Input Plugins](development/wasm-input-plugins.md)
37+
- Write [Filters in Lua](pipeline/filters/lua.md) or
38+
[Output plugins in Golang](development/golang-output-plugins.md)
39+
- [Monitoring](administration/monitoring.md): Expose internal metrics over HTTP
40+
in JSON and [Prometheus](https://prometheus.io/) format
41+
- [Stream Processing](stream-processing/introduction.md): Perform data selection
42+
and transformation using simple SQL queries
43+
- Create new streams of data using query results
44+
- Aggregation windows
45+
- Data analysis and prediction: Timeseries forecasting
46+
- Portable: Runs on Linux, macOS, Windows and BSD systems
3947

4048
## Fluent Bit, Fluentd and CNCF
4149

42-
[Fluent Bit](http://fluentbit.io) is a [CNCF](https://cncf.io) **graduated** sub-project under the umbrella of [Fluentd](http://fluentd.org). Fluent Bit is licensed under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
50+
[Fluent Bit](http://fluentbit.io) is a [CNCF](https://cncf.io) graduated sub-project
51+
under the umbrella of [Fluentd](http://fluentd.org). Fluent Bit is licensed under
52+
the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
4353

4454
Fluent Bit was originally created by [Eduardo Silva](https://www.linkedin.com/in/edsiper/)
4555
and is now sponsored by [Chronosphere](https://chronosphere.io/). As a
46-
CNCF-hosted project, it is a fully **vendor-neutral** and community-driven
47-
project.
56+
CNCF-hosted project, it is a fully vendor-neutral and community-driven project.

0 commit comments

Comments
 (0)