Skip to content

Commit 976e04b

Browse files
committed
Merge remote-tracking branch 'upstream/master' into jszwedko/document-dd_hostname
2 parents c4d9263 + 954087e commit 976e04b

File tree

203 files changed

+5212
-1989
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

203 files changed

+5212
-1989
lines changed

.gitbook/assets/3.1.png

1.29 MB
Loading

.gitbook/assets/3.2.png

4.29 MB
Loading

.gitbook/assets/image.png

-162 KB
Binary file not shown.

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ _book/*
22
node_modules/*
33
.gitignore
44
old/*
5-
5+
.DS_Store

.vale.ini

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
StylesPath = vale-styles
2+
MinAlertLevel = suggestion # suggestion, warning or error
3+
4+
[formats]
5+
mdx = md
6+
7+
[*.{md,markdown,txt,htm,html}]
8+
BasedOnStyles = FluentBit
9+
IgnoredScopes = tt, code
10+
11+
FluentBit.Terms = YES
12+
FluentBit.Titles = YES
13+
FluentBit.FutureTense = NO
14+
FluentBit.Headings = NO
15+
FluentBit.Passive = NO
16+
FluentBit.Subjunctive = NO
17+
FluentBit.Colons = NO

CONTRIBUTING.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ the docs library. If you create a new page, you'll also need to update
3232

3333
## Workflow
3434

35-
After you open a pull request in this repo, a Fluent Bit maintainer will review
35+
After you open a pull request in this repository, a Fluent Bit maintainer will review
3636
it, triage it, add comments or suggestions as needed, and then merge it. After
3737
your changes are successfully merged into `master`, the docs site will update
3838
within a few minutes.
@@ -99,9 +99,9 @@ To prevent DCO errors, refer to the following guide about
9999
>
100100
> `git commit -a -s -m "pipeline: outputs: syslog: fix grammar in examples"`
101101
>
102-
> If you're using VS Code, you can also enable the
102+
> If you're using VSCode, you can also enable the
103103
> [**Git: Always Sign Off**](https://github.com/microsoft/vscode/issues/83096#issuecomment-545350047)
104-
> setting, whch automatically appends a `Signed-off-by:` message to your commits.
104+
> setting, which automatically appends a `Signed-off-by:` message to your commits.
105105
106106
## Style guidelines
107107

@@ -111,8 +111,16 @@ for most topics related to grammar, style, and formatting. We don't expect you
111111
to memorize these style rules, but the technical writer who reviews your pull
112112
request may suggest changes accordingly.
113113

114+
### URLs
115+
116+
When cross-linking to a page in this repository, use a full relative path whenever
117+
possible. For example:
118+
119+
```text
120+
[LTSV](pipeline/parsers/ltsv.md) and [Logfmt](pipeline/parsers/logfmt.md)
121+
```
122+
114123
### Vale
115124

116-
The Fluent Bit maintainers are working to add a [Vale](https://vale.sh/docs/) plugin
117-
to this repository, which will automatically lint pull requests and add
118-
suggestions to improve style and clarity.
125+
The Fluent Bit maintainers use the [Vale](https://vale.sh/docs/) plugin, which lints
126+
pull requests and adds suggestions to improve style and clarity.

README.md

Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,55 @@
22
description: High Performance Telemetry Agent for Logs, Metrics and Traces
33
---
44

5-
# Fluent Bit v3.1 Documentation
5+
# Fluent Bit v3.2 Documentation
66

7-
<figure><img src=".gitbook/assets/3.0.png" alt=""><figcaption></figcaption></figure>
7+
<figure><img src=".gitbook/assets/3.2.png" alt=""><figcaption></figcaption></figure>
88

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

1115
## Features
1216

13-
* High Performance: High throughput with low resources consumption
14-
* Data Parsing
15-
* 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)
16-
* Metrics Support: Prometheus and OpenTelemetry compatible
17-
* Reliability and Data Integrity
18-
* [Backpressure](administration/backpressure.md) Handling
19-
* [Data Buffering](administration/buffering-and-storage.md) in memory and file system
20-
* Networking
21-
* Security: built-in TLS/SSL support
22-
* Asynchronous I/O
23-
* Pluggable Architecture and [Extensibility](development/library_api.md): Inputs, Filters and Outputs
24-
* Connect nearly any source to nearly any destination using preexisting plugins
25-
* Extensibility
26-
* Write any input, filter or output plugin in C language
27-
* WASM: [WASM Filter Plugins](development/wasm-filter-plugins.md) or [WASM Input Plugins](development/wasm-input-plugins.md)
28-
* Bonus: write [Filters in Lua](pipeline/filters/lua.md) or [Output plugins in Golang](development/golang-output-plugins.md)
29-
* [Monitoring](administration/monitoring.md): expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format
30-
* [Stream Processing](stream-processing/introduction.md): Perform data selection and transformation using simple SQL queries
31-
* Create new streams of data using query results
32-
* Aggregation Windows
33-
* Data analysis and prediction: Timeseries forecasting
34-
* 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
3547

3648
## Fluent Bit, Fluentd and CNCF
3749

38-
[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).
3953

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

SUMMARY.md

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

3-
* [Fluent Bit v3.1 Documentation](README.md)
3+
* [Fluent Bit v3.2 Documentation](README.md)
44

55
## About
66

@@ -49,15 +49,22 @@
4949
## Administration
5050

5151
* [Configuring Fluent Bit](administration/configuring-fluent-bit/README.md)
52+
* [YAML Configuration](administration/configuring-fluent-bit/yaml/README.md)
53+
* [Service](administration/configuring-fluent-bit/yaml/service-section.md)
54+
* [Parsers](administration/configuring-fluent-bit/yaml/parsers-section.md)
55+
* [Multiline Parsers](administration/configuring-fluent-bit/yaml/multiline-parsers-section.md)
56+
* [Pipeline](administration/configuring-fluent-bit/yaml/pipeline-section.md)
57+
* [Plugins](administration/configuring-fluent-bit/yaml/plugins-section.md)
58+
* [Upstream Servers](administration/configuring-fluent-bit/yaml/upstream-servers-section.md))
59+
* [Environment Variables](administration/configuring-fluent-bit/yaml/environment-variables-section.md)
60+
* [Includes](administration/configuring-fluent-bit/yaml/includes-section.md)
5261
* [Classic mode](administration/configuring-fluent-bit/classic-mode/README.md)
5362
* [Format and Schema](administration/configuring-fluent-bit/classic-mode/format-schema.md)
5463
* [Configuration File](administration/configuring-fluent-bit/classic-mode/configuration-file.md)
5564
* [Variables](administration/configuring-fluent-bit/classic-mode/variables.md)
5665
* [Commands](administration/configuring-fluent-bit/classic-mode/commands.md)
5766
* [Upstream Servers](administration/configuring-fluent-bit/classic-mode/upstream-servers.md)
5867
* [Record Accessor](administration/configuring-fluent-bit/classic-mode/record-accessor.md)
59-
* [YAML Configuration](administration/configuring-fluent-bit/yaml/README.md)
60-
* [Configuration File](administration/configuring-fluent-bit/yaml/configuration-file.md)
6168
* [Unit Sizes](administration/configuring-fluent-bit/unit-sizes.md)
6269
* [Multiline Parsing](administration/configuring-fluent-bit/multiline-parsing.md)
6370
* [Transport Security](administration/transport-security.md)
@@ -67,9 +74,11 @@
6774
* [Networking](administration/networking.md)
6875
* [Memory Management](administration/memory-management.md)
6976
* [Monitoring](administration/monitoring.md)
77+
* [Multithreading](administration/multithreading.md)
7078
* [HTTP Proxy](administration/http-proxy.md)
7179
* [Hot Reload](administration/hot-reload.md)
7280
* [Troubleshooting](administration/troubleshooting.md)
81+
* [Performance Tips](administration/performance.md)
7382

7483
## Local Testing
7584

@@ -83,17 +92,18 @@
8392
* [Collectd](pipeline/inputs/collectd.md)
8493
* [CPU Log Based Metrics](pipeline/inputs/cpu-metrics.md)
8594
* [Disk I/O Log Based Metrics](pipeline/inputs/disk-io-metrics.md)
86-
* [Docker Log Based Metrics](pipeline/inputs/docker-metrics.md)
8795
* [Docker Events](pipeline/inputs/docker-events.md)
96+
* [Docker Log Based Metrics](pipeline/inputs/docker-metrics.md)
8897
* [Dummy](pipeline/inputs/dummy.md)
8998
* [Elasticsearch](pipeline/inputs/elasticsearch.md)
9099
* [Exec](pipeline/inputs/exec.md)
91100
* [Exec Wasi](pipeline/inputs/exec-wasi.md)
101+
* [Ebpf](pipeline/inputs/ebpf.md)
92102
* [Fluent Bit Metrics](pipeline/inputs/fluentbit-metrics.md)
93103
* [Forward](pipeline/inputs/forward.md)
94104
* [Head](pipeline/inputs/head.md)
95-
* [HTTP](pipeline/inputs/http.md)
96105
* [Health](pipeline/inputs/health.md)
106+
* [HTTP](pipeline/inputs/http.md)
97107
* [Kafka](pipeline/inputs/kafka.md)
98108
* [Kernel Logs](pipeline/inputs/kernel-logs.md)
99109
* [Kubernetes Events](pipeline/inputs/kubernetes-events.md)
@@ -102,11 +112,12 @@
102112
* [Network I/O Log Based Metrics](pipeline/inputs/network-io-metrics.md)
103113
* [NGINX Exporter Metrics](pipeline/inputs/nginx.md)
104114
* [Node Exporter Metrics](pipeline/inputs/node-exporter-metrics.md)
115+
* [OpenTelemetry](pipeline/inputs/opentelemetry.md)
105116
* [Podman Metrics](pipeline/inputs/podman-metrics.md)
106-
* [Process Log Based Metrics](pipeline/inputs/process.md)
107117
* [Process Exporter Metrics](pipeline/inputs/process-exporter-metrics.md)
108-
* [Prometheus Scrape Metrics](pipeline/inputs/prometheus-scrape-metrics.md)
118+
* [Process Log Based Metrics](pipeline/inputs/process.md)
109119
* [Prometheus Remote Write](pipeline/inputs/prometheus-remote-write.md)
120+
* [Prometheus Scrape Metrics](pipeline/inputs/prometheus-scrape-metrics.md)
110121
* [Random](pipeline/inputs/random.md)
111122
* [Serial Interface](pipeline/inputs/serial-interface.md)
112123
* [Splunk](pipeline/inputs/splunk.md)
@@ -118,7 +129,6 @@
118129
* [TCP](pipeline/inputs/tcp.md)
119130
* [Thermal](pipeline/inputs/thermal.md)
120131
* [UDP](pipeline/inputs/udp.md)
121-
* [OpenTelemetry](pipeline/inputs/opentelemetry.md)
122132
* [Windows Event Log](pipeline/inputs/windows-event-log.md)
123133
* [Windows Event Log (winevtlog)](pipeline/inputs/windows-event-log-winevtlog.md)
124134
* [Windows Exporter Metrics](pipeline/inputs/windows-exporter-metrics.md)
@@ -131,7 +141,9 @@
131141
* [Decoders](pipeline/parsers/decoders.md)
132142
* [Processors](pipeline/processors/README.md)
133143
* [Content Modifier](pipeline/processors/content-modifier.md)
144+
* [Labels](pipeline/processors/labels.md)
134145
* [Metrics Selector](pipeline/processors/metrics-selector.md)
146+
* [OpenTelemetry Envelope](pipeline/processors/opentelemetry-envelope.md)
135147
* [SQL](pipeline/processors/sql.md)
136148
* [Filters](pipeline/filters/README.md)
137149
* [AWS Metadata](pipeline/filters/aws-metadata.md)
@@ -167,6 +179,7 @@
167179
* [Azure Logs Ingestion API](pipeline/outputs/azure_logs_ingestion.md)
168180
* [Counter](pipeline/outputs/counter.md)
169181
* [Datadog](pipeline/outputs/datadog.md)
182+
* [Dynatrace](pipeline/outputs/dynatrace.md)
170183
* [Elasticsearch](pipeline/outputs/elasticsearch.md)
171184
* [File](pipeline/outputs/file.md)
172185
* [FlowCounter](pipeline/outputs/flowcounter.md)
@@ -185,9 +198,10 @@
185198
* [New Relic](pipeline/outputs/new-relic.md)
186199
* [NULL](pipeline/outputs/null.md)
187200
* [Observe](pipeline/outputs/observe.md)
188-
* [Oracle Log Analytics](pipeline/outputs/oci-logging-analytics.md)
201+
* [OpenObserve](pipeline/inputs/openobserve.md)
189202
* [OpenSearch](pipeline/outputs/opensearch.md)
190203
* [OpenTelemetry](pipeline/outputs/opentelemetry.md)
204+
* [Oracle Log Analytics](pipeline/outputs/oci-logging-analytics.md)
191205
* [PostgreSQL](pipeline/outputs/postgresql.md)
192206
* [Prometheus Exporter](pipeline/outputs/prometheus-exporter.md)
193207
* [Prometheus Remote Write](pipeline/outputs/prometheus-remote-write.md)

about/fluentd-and-fluent-bit.md

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,45 @@
11
---
2-
description: The Production Grade Telemetry Ecosystem
2+
description: The production grade telemetry ecosystem
33
---
44

5-
# Fluentd & Fluent Bit
5+
# Fluentd and Fluent Bit
66

7-
Telemetry data processing in general can be complex, and at scale a bit more, that's why [Fluentd](https://www.fluentd.org) was born. Fluentd has become more than a simple tool, it has grown into a fullscale ecosystem that contains SDKs for different languages and sub-projects like [Fluent Bit](https://fluentbit.io).
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).
811

9-
On this page, we will describe the relationship between the [Fluentd](http://fluentd.org) and [Fluent Bit](http://fluentbit.io) open source projects, as a summary we can say both are:
12+
Here, we describe the relationship between the [Fluentd](http://fluentd.org)
13+
and [Fluent Bit](http://fluentbit.io) open source projects.
1014

11-
* Licensed under the terms of Apache License v2.0
12-
* **Graduated** Hosted projects by the [Cloud Native Computing Foundation (CNCF)](https://cncf.io)
13-
* Production Grade solutions: deployed **million** of times every single day.
14-
* **Vendor neutral** and community driven projects
15-
* Widely Adopted by the Industry: trusted by all major companies like AWS, Microsoft, Google Cloud and hundreds of others.
15+
Both projects are:
1616

17-
Both projects share a lot of similarities, [Fluent Bit](https://fluentbit.io) is fully designed and built on top of the best ideas of [Fluentd](https://www.fluentd.org) architecture and general design. Choosing which one to use depends on the end-user needs.
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.
23+
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.
1827

1928
The following table describes a comparison of different areas of the projects:
2029

21-
| | Fluentd | Fluent Bit |
22-
| ------------ | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
23-
| Scope | Containers / Servers | Embedded Linux / Containers / Servers |
24-
| Language | C & Ruby | C |
25-
| Memory | > 60MB | \~1MB |
26-
| Performance | Medium Performance | High Performance |
27-
| Dependencies | Built as a Ruby Gem, it requires a certain number of gems. | Zero dependencies, unless some special plugin requires them. |
28-
| Plugins | More than 1000 external plugins are available | More than 100 built-in plugins are available |
30+
| Attribute | Fluentd | Fluent Bit |
31+
| ------------ | --------------------- | --------------------- |
32+
| Scope | Containers / Servers | Embedded Linux / Containers / Servers |
33+
| Language | C & Ruby | C |
34+
| Memory | Greater than 60&nbsp;MB | Approximately 1&nbsp;MB |
35+
| Performance | Medium Performance | High Performance |
36+
| Dependencies | Built as a Ruby Gem, depends on other gems. | Zero dependencies, unless required by a plugin. |
37+
| Plugins | Over 1,000 external plugins available. | Over 100 built-in plugins available. |
2938
| 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) |
3039

31-
Both [Fluentd](https://www.fluentd.org) and [Fluent Bit](https://fluentbit.io) can work as Aggregators or Forwarders, they both can complement each other or use them as standalone solutions.\
32-
\
33-
In the recent years, Cloud Providers switched from Fluentd to Fluent Bit for performance and compatibility reasons. Fluent Bit is now considered the **next generation** solution.
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.
43+
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.

0 commit comments

Comments
 (0)