Skip to content

Commit 7ad83a6

Browse files
Home, About, Concepts: update titles to sentence case + un-wrap lines
Signed-off-by: Alexa Kreizinger <[email protected]>
1 parent 5d84e2c commit 7ad83a6

15 files changed

+69
-186
lines changed

SUMMARY.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Table of contents
22

3-
* [Fluent Bit Documentation](README.md)
3+
* [Fluent Bit documentation](README.md)
44

55
## About
66

77
* [What is Fluent Bit?](about/what-is-fluent-bit.md)
8-
* [A Brief History of Fluent Bit](about/history.md)
8+
* [A brief history of Fluent Bit](about/history.md)
99
* [Fluentd and Fluent Bit](about/fluentd-and-fluent-bit.md)
1010
* [License](about/license.md)
11-
* [Sandbox and Lab Resources](about/sandbox-and-lab-resources.md)
11+
* [Sandbox and lab resources](about/sandbox-and-lab-resources.md)
1212

1313
## Concepts
1414

15-
* [Key Concepts](concepts/key-concepts.md)
15+
* [Key concepts](concepts/key-concepts.md)
1616
* [Buffering](concepts/buffering.md)
17-
* [Data Pipeline](concepts/data-pipeline/README.md)
17+
* [Data pipeline](concepts/data-pipeline/README.md)
1818
* [Input](concepts/data-pipeline/input.md)
1919
* [Parser](concepts/data-pipeline/parser.md)
2020
* [Filter](concepts/data-pipeline/filter.md)

about/fluentd-and-fluent-bit.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,28 @@ description: The production grade telemetry ecosystem
44

55
# Fluentd and Fluent Bit
66

7-
Telemetry data processing can be complex, especially at scale. That's why
8-
[Fluentd](https://www.fluentd.org) was created. Fluentd is more than a simple tool,
9-
it's grown into a fullscale ecosystem that contains SDKs for different languages
10-
and subprojects like [Fluent Bit](https://fluentbit.io).
7+
Telemetry data processing can be complex, especially at scale. That's why [Fluentd](https://www.fluentd.org) was created. Fluentd is more than a simple tool, it's grown into a fullscale ecosystem that contains SDKs for different languages and subprojects like [Fluent Bit](https://fluentbit.io).
118

12-
Here, we describe the relationship between the [Fluentd](http://fluentd.org)
13-
and [Fluent Bit](http://fluentbit.io) open source projects.
9+
Here, we describe the relationship between the [Fluentd](http://fluentd.org) and [Fluent Bit](http://fluentbit.io) open source projects.
1410

1511
Both projects are:
1612

17-
- Licensed under the terms of Apache License v2.0.
18-
- Graduated hosted projects by the [Cloud Native Computing Foundation (CNCF)](https://cncf.io).
19-
- Production grade solutions: Deployed millions of times every single day.
20-
- Vendor neutral and community driven.
21-
- Widely adopted by the industry: Trusted by major companies like AWS, Microsoft,
22-
Google Cloud, and hundreds of others.
13+
- Licensed under the terms of Apache License v2.0. - Graduated hosted projects by the [Cloud Native Computing Foundation (CNCF)](https://cncf.io). - Production grade solutions: Deployed millions of times every single day. - Vendor neutral and community driven. - Widely adopted by the industry: Trusted by major companies like AWS, Microsoft, Google Cloud, and hundreds of others.
2314

24-
The projects have many similarities: [Fluent Bit](https://fluentbit.io) is
25-
designed and built on top of the best ideas of [Fluentd](https://www.fluentd.org)
26-
architecture and general design. Which one you choose depends on your end-users' needs.
15+
The projects have many similarities: [Fluent Bit](https://fluentbit.io) is designed and built on top of the best ideas of [Fluentd](https://www.fluentd.org) architecture and general design. Which one you choose depends on your end-users' needs.
2716

2817
The following table describes a comparison of different areas of the projects:
2918

3019
| Attribute | Fluentd | Fluent Bit |
3120
| ------------ | --------------------- | --------------------- |
3221
| Scope | Containers / Servers | Embedded Linux / Containers / Servers |
33-
| Language | C & Ruby | C |
22+
| Language | C and Ruby | C |
3423
| Memory | Greater than 60&nbsp;MB | Approximately 1&nbsp;MB |
3524
| Performance | Medium Performance | High Performance |
3625
| Dependencies | Built as a Ruby Gem, depends on other gems. | Zero dependencies, unless required by a plugin. |
3726
| Plugins | Over 1,000 external plugins available. | Over 100 built-in plugins available. |
3827
| License | [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0) | [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0) |
3928

40-
Both [Fluentd](https://www.fluentd.org) and [Fluent Bit](https://fluentbit.io)
41-
can work as Aggregators or Forwarders, and can complement each other or be used
42-
as standalone solutions.
29+
Both [Fluentd](https://www.fluentd.org) and [Fluent Bit](https://fluentbit.io) can work as Aggregators or Forwarders, and can complement each other or be used as standalone solutions.
4330

44-
In the recent years, cloud providers have switched from Fluentd to Fluent Bit for
45-
performance and compatibility. Fluent Bit is now considered the next-generation solution.
31+
In the recent years, cloud providers have switched from Fluentd to Fluent Bit for performance and compatibility. Fluent Bit is now considered the next-generation solution.

about/history.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,6 @@ description: Every project has a story
55

66
# A brief history of Fluent Bit
77

8-
In 2014, the [Fluentd](https://www.fluentd.org/) team at
9-
[Treasure Data](https://www.treasuredata.com/) was forecasting the need for a
10-
lightweight log processor for constraint environments like embedded Linux and
11-
gateways. The project aimed to be part of the Fluentd ecosystem. At that moment,
12-
Eduardo Silva created [Fluent Bit](https://fluentbit.io/), a new open source solution,
13-
written from scratch and available under the terms of the
14-
[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
8+
In 2014, the [Fluentd](https://www.fluentd.org/) team at [Treasure Data](https://www.treasuredata.com/) was forecasting the need for a lightweight log processor for constraint environments like embedded Linux and gateways. The project aimed to be part of the Fluentd ecosystem. At that moment, Eduardo Silva created [Fluent Bit](https://fluentbit.io/), a new open source solution, written from scratch and available under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
159

16-
After the project matured, it gained traction for normal Linux systems. With the
17-
new containerized world, the Cloud Native community asked to extend the
18-
project scope to support more sources, filters, and destinations. Not long after,
19-
Fluent Bit became one of the preferred solutions to solve the logging challenges
20-
in Cloud environments.
10+
After the project matured, it gained traction for normal Linux systems. With the new containerized world, the Cloud Native community asked to extend the project scope to support more sources, filters, and destinations. Not long after, Fluent Bit became one of the preferred solutions to solve the logging challenges in Cloud environments.

about/license.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ description: Fluent Bit license description
55

66
# License
77

8-
[Fluent Bit](http://fluentbit.io), including its core, plugins, and tools are
9-
distributed under the terms of the
10-
[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0):
8+
[Fluent Bit](http://fluentbit.io), including its core, plugins, and tools are distributed under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0):
119

1210
```text
1311
Apache License

about/sandbox-and-lab-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: >-
44
Labs for learning how to best operate, use, and have success with Fluent Bit.
55
---
66

7-
# Sandbox and Lab Resources
7+
# Sandbox and lab resources
88

99
## Fluent Bit Sandbox - sign-up required
1010

about/what-is-fluent-bit.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,11 @@ description: Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
44

55
# What is Fluent Bit?
66

7-
[Fluent Bit](https://fluentbit.io) is an open source telemetry agent specifically
8-
designed to efficiently handle the challenges of collecting and processing telemetry
9-
data across a wide range of environments, from constrained systems to complex cloud
10-
infrastructures. Managing telemetry data from various sources and formats can be a
11-
constant challenge, particularly when performance is a critical factor.
7+
[Fluent Bit](https://fluentbit.io) is an open source telemetry agent specifically designed to efficiently handle the challenges of collecting and processing telemetry data across a wide range of environments, from constrained systems to complex cloud infrastructures. Managing telemetry data from various sources and formats can be a constant challenge, particularly when performance is a critical factor.
128

13-
Rather than serving as a drop-in replacement, Fluent Bit enhances the observability
14-
strategy for your infrastructure by adapting and optimizing your existing logging
15-
layer, and adding metrics and traces processing. Fluent Bit supports a
16-
vendor-neutral approach, seamlessly integrating with other ecosystems such as
17-
Prometheus and OpenTelemetry. Trusted by major cloud providers, banks, and companies
18-
in need of a ready-to-use telemetry agent solution, Fluent Bit effectively manages
19-
diverse data sources and formats while maintaining optimal performance and keeping
20-
resource consumption low.
9+
Rather than serving as a drop-in replacement, Fluent Bit enhances the observability strategy for your infrastructure by adapting and optimizing your existing logging layer, and adding metrics and traces processing. Fluent Bit supports a vendor-neutral approach, seamlessly integrating with other ecosystems such as Prometheus and OpenTelemetry. Trusted by major cloud providers, banks, and companies in need of a ready-to-use telemetry agent solution, Fluent Bit effectively manages diverse data sources and formats while maintaining optimal performance and keeping resource consumption low.
2110

22-
Fluent Bit can be deployed as an edge agent for localized telemetry data handling or
23-
utilized as a central aggregator/collector for managing telemetry data across
24-
multiple sources and environments.
11+
Fluent Bit can be deployed as an edge agent for localized telemetry data handling or utilized as a central aggregator/collector for managing telemetry data across multiple sources and environments.
2512

2613

2714
{% embed url="https://www.youtube.com/watch?v=3ELc1helke4" %}

concepts/buffering.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,14 @@ description: Performance and data safety
44

55
# Buffering
66

7-
When [Fluent Bit](https://fluentbit.io) processes data, it uses the system memory
8-
(heap) as a primary and temporary place to store the record logs before they get
9-
delivered. The records are processed in this private memory area.
7+
When [Fluent Bit](https://fluentbit.io) processes data, it uses the system memory (heap) as a primary and temporary place to store the record logs before they get delivered. The records are processed in this private memory area.
108

11-
Buffering is the ability to store the records, and continue storing incoming data
12-
while previous data is processed and delivered. Buffering in memory is the fastest
13-
mechanism, but there are scenarios requiring special strategies to deal with
14-
[backpressure](../administration/backpressure.md), data safety, or to reduce memory
15-
consumption by the service in constrained environments.
9+
Buffering is the ability to store the records, and continue storing incoming data while previous data is processed and delivered. Buffering in memory is the fastest mechanism, but there are scenarios requiring special strategies to deal with [backpressure](../administration/backpressure.md), data safety, or to reduce memory consumption by the service in constrained environments.
1610

17-
Network failures or latency in third party service is common. When data can't be
18-
delivered fast enough and new data to process arrives, the system can face
19-
backpressure.
11+
Network failures or latency in third party service is common. When data can't be delivered fast enough and new data to process arrives, the system can face backpressure.
2012

21-
Fluent Bit buffering strategies are designed to solve problems associated with
22-
backpressure and general delivery failures. Fluent Bit offers a primary buffering
23-
mechanism in memory and an optional secondary one using the file system. With
24-
this hybrid solution you can accommodate any use case safely and keep a high
25-
performance while processing your data.
13+
Fluent Bit buffering strategies are designed to solve problems associated with backpressure and general delivery failures. Fluent Bit offers a primary buffering mechanism in memory and an optional secondary one using the file system. With this hybrid solution you can accommodate any use case safely and keep a high performance while processing your data.
2614

27-
These mechanisms aren't mutually exclusive. When data is ready to be processed or
28-
delivered it's always be in memory, while other data in the queue might be in
29-
the file system until is ready to be processed and moved up to memory.
15+
These mechanisms aren't mutually exclusive. When data is ready to be processed or delivered it's always be in memory, while other data in the queue might be in the file system until is ready to be processed and moved up to memory.
3016

31-
To learn more about the buffering configuration in Fluent Bit, see
32-
[Buffering & Storage](../administration/buffering-and-storage.md).
17+
To learn more about the buffering configuration in Fluent Bit, see [Buffering & Storage](../administration/buffering-and-storage.md).

concepts/data-pipeline/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# Data Pipeline
2-
1+
# Data pipeline

concepts/data-pipeline/buffer.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@ description: Data processing with reliability
44

55
# Buffer
66

7-
The [`buffer`](../buffering.md) phase in the pipeline aims to provide a unified and
8-
persistent mechanism to store your data, using the primary in-memory model or the
9-
file system-based mode.
7+
The [`buffer`](../buffering.md) phase in the pipeline aims to provide a unified and persistent mechanism to store your data, using the primary in-memory model or the file system-based mode.
108

11-
The `buffer` phase contains the data in an immutable state, meaning that no other
12-
filter can be applied.
9+
The `buffer` phase contains the data in an immutable state, meaning that no other filter can be applied.
1310

1411
```mermaid
1512
graph LR
@@ -27,5 +24,4 @@ graph LR
2724

2825
Buffered data uses the Fluent Bit internal binary representation, which isn't raw text.
2926

30-
Fluent Bit offers a buffering mechanism in the file system that acts as a backup
31-
system to avoid data loss in case of system failures.
27+
Fluent Bit offers a buffering mechanism in the file system that acts as a backup system to avoid data loss in case of system failures.

concepts/data-pipeline/filter.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ description: Modify, enrich or drop your records
44

55
# Filter
66

7-
In production environments you need full control of the data you're collecting.
8-
Filtering lets you alter the collected data before delivering it to a destination.
7+
In production environments you need full control of the data you're collecting. Filtering lets you alter the collected data before delivering it to a destination.
98

109
```mermaid
1110
graph LR
@@ -21,14 +20,10 @@ graph LR
2120
style C stroke:darkred,stroke-width:2px;
2221
```
2322

24-
Filtering is implemented through plugins. Each available filter can be used to
25-
match, exclude, or enrich your logs with specific metadata.
23+
Filtering is implemented through plugins. Each available filter can be used to match, exclude, or enrich your logs with specific metadata.
2624

27-
Fluent Bit support many filters. A common use case for filtering is Kubernetes
28-
deployments. Every pod log needs the proper metadata associated with it.
25+
Fluent Bit support many filters. A common use case for filtering is Kubernetes deployments. Every pod log needs the proper metadata associated with it.
2926

30-
Like input plugins, filters run in an instance context, which has its own independent
31-
configuration. Configuration keys are often called _properties_.
27+
Like input plugins, filters run in an instance context, which has its own independent configuration. Configuration keys are often called _properties_.
3228

33-
For more details about the Filters available and their usage, see
34-
[Filters](https://docs.fluentbit.io/manual/pipeline/filters).
29+
For more details about the Filters available and their usage, see [Filters](https://docs.fluentbit.io/manual/pipeline/filters).

0 commit comments

Comments
 (0)