From 97494babdefa2da5d09f720d909bf44becd70d6e Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 10 Sep 2024 12:10:04 -0700 Subject: [PATCH 1/2] Fluent bit: docs: readme: apply style guide to readme Signed-off-by: Lynette Miles --- README.md | 63 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 36 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index e79317a96..1b5b99b1e 100644 --- a/README.md +++ b/README.md @@ -6,42 +6,51 @@ description: High Performance Telemetry Agent for Logs, Metrics and Traces
-[Fluent Bit](http://fluentbit.io) is a fast and lightweight **telemetry agent** +[Fluent Bit](http://fluentbit.io) is a fast and lightweight telemetry agent for logs, metrics, and traces for Linux, macOS, Windows, and BSD family -operating systems. It has been made with a strong focus on performance to allow +operating systems. Fluent Bit has been made with a strong focus on performance to allow the collection and processing of telemetry data from different sources without complexity.![](https://static.scarf.sh/a.png?x-pxid=71f0e011-761f-4c6f-9a89-38817887faae) ## Features -* High Performance: High throughput with low resources consumption -* Data Parsing - * 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) -* Metrics Support: Prometheus and OpenTelemetry compatible -* Reliability and Data Integrity - * [Backpressure](administration/backpressure.md) Handling - * [Data Buffering](administration/buffering-and-storage.md) in memory and file system -* Networking - * Security: built-in TLS/SSL support - * Asynchronous I/O -* Pluggable Architecture and [Extensibility](development/library_api.md): Inputs, Filters and Outputs - * Connect nearly any source to nearly any destination using preexisting plugins - * Extensibility - * Write any input, filter or output plugin in C language - * WASM: [WASM Filter Plugins](development/wasm-filter-plugins.md) or [WASM Input Plugins](development/wasm-input-plugins.md) - * Bonus: write [Filters in Lua](pipeline/filters/lua.md) or [Output plugins in Golang](development/golang-output-plugins.md) -* [Monitoring](administration/monitoring.md): expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format -* [Stream Processing](stream-processing/introduction.md): Perform data selection and transformation using simple SQL queries - * Create new streams of data using query results - * Aggregation Windows - * Data analysis and prediction: Timeseries forecasting -* Portable: runs on Linux, macOS, Windows and BSD systems +- High performance: High throughput with low resources consumption +- Data parsing + - 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) +- Metrics support: Prometheus and OpenTelemetry compatible +- Reliability and data integrity + - [Backpressure](administration/backpressure.md) handling + - [Data buffering](administration/buffering-and-storage.md) in memory and file system +- Networking + - Security: Built-in TLS/SSL support + - Asynchronous I/O +- Pluggable architecture and [extensibility](development/library_api.md): Inputs, + Filters and Outputs: + - Connect nearly any source to nearly any destination using preexisting plugins + - Extensibility: + - Write input, filter, or output plugins in the C language + - WASM: [WASM Filter Plugins](development/wasm-filter-plugins.md) or + [WASM Input Plugins](development/wasm-input-plugins.md) + - Write [Filters in Lua](pipeline/filters/lua.md) or + [Output plugins in Golang](development/golang-output-plugins.md) +- [Monitoring](administration/monitoring.md): Expose internal metrics over HTTP + in JSON and [Prometheus](https://prometheus.io/) format +- [Stream Processing](stream-processing/introduction.md): Perform data selection + and transformation using simple SQL queries + - Create new streams of data using query results + - Aggregation Wwndows + - Data analysis and prediction: Timeseries forecasting +- Portable: Runs on Linux, macOS, Windows and BSD systems ## Fluent Bit, Fluentd and CNCF -[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). +[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). Fluent Bit was originally created by [Eduardo Silva](https://www.linkedin.com/in/edsiper/) and is now sponsored by [Chronosphere](https://chronosphere.io/). As a -CNCF-hosted project, it is a fully **vendor-neutral** and community-driven -project. +CNCF-hosted project, it is a fully vendor-neutral and community-driven project. From 0868a4f9f8bf1d8757aa997de74bd3a56057acb4 Mon Sep 17 00:00:00 2001 From: esmerel <6818907+esmerel@users.noreply.github.com> Date: Tue, 10 Sep 2024 13:58:30 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Alexa Kreizinger Signed-off-by: esmerel <6818907+esmerel@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b5b99b1e..53ccaa989 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ complexity.![](https://static.scarf.sh/a.png?x-pxid=71f0e011-761f-4c6f-9a89-3881 - [Stream Processing](stream-processing/introduction.md): Perform data selection and transformation using simple SQL queries - Create new streams of data using query results - - Aggregation Wwndows + - Aggregation windows - Data analysis and prediction: Timeseries forecasting - Portable: Runs on Linux, macOS, Windows and BSD systems