Skip to content

Commit 205e870

Browse files
committed
1.4: migrating to new structure (wip)
Signed-off-by: Eduardo Silva <[email protected]>
1 parent 7049e9e commit 205e870

File tree

239 files changed

+527
-8078
lines changed

Some content is hidden

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

239 files changed

+527
-8078
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
_book/*
22
node_modules/*
3+
.gitignore
4+
old/*
5+

README.md

+38-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,41 @@
1-
# Introduction
1+
---
2+
description: Next generation Log and Stream processor
3+
---
4+
5+
# Fluent Bit v1.4 Documentation
6+
7+
![](.gitbook/assets/logo_documentation_1.4.png)
8+
9+
[Fluent Bit](http://fluentbit.io) is a Fast and Lightweight Log Processor, Stream Processor and Forwarder for Linux, OSX, Windows and BSD family operating systems. It has been made with a strong focus on performance to allow the collection of events from different sources without complexity.
10+
11+
### Features
12+
13+
* High Performance
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+
* Reliability and Data Integrity
17+
* [Backpressure](administration/backpressure.md) Handling
18+
* [Data Buffering](administration/buffering-and-storage.md) in memory and file system
19+
* Networking
20+
* Security: built-in TLS/SSL support
21+
* Asynchronous I/O
22+
* Pluggable Architecture and [Extensibility](development/library_api.md): Inputs, Filters and Outputs
23+
* More than 50 built-in plugins available
24+
* Extensibility
25+
* Write any input, filter or output plugin in C language
26+
* Bonus: write [Filters in Lua](pipeline/filters/lua.md) or [Output plugins in Golang](development/golang-output-plugins.md)
27+
* [Monitoring](administration/monitoring.md): expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format
28+
* [Stream Processing](stream-processing/untitled.md): Perform data selection and transformation using simple SQL queries
29+
* Create new streams of data using query results
30+
* Aggregation Windows
31+
* Data analysis and prediction: Timeseries forecasting
32+
* Portable: runs on Linux, MacOS, Windows and BSD systems
33+
34+
### Fluent Bit, Fluentd and CNCF
35+
36+
[Fluent Bit](http://fluentbit.io) is a sub-component of the [Fluentd](http://fluentd.org) project ecosystem, it's licensed under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). This project was created by [Treasure Data](https://www.treasuredata.com) and is its current primary sponsor.
37+
38+
Nowadays Fluent Bit get contributions from several companies and individuals and same as [Fluentd](https://www.fluentd.org), it's hosted as a [CNCF](https://cncf.io) subproject.
239

3-
![](imgs/logo_documentation_1.2.png)
440

5-
[Fluent Bit](http://fluentbit.io) is a Fast and Lightweight Log Processor and Forwarder for Linux, OSX and BSD family operating systems. It has been made with a strong focus on performance to allow the collection of events from different sources without complexity.
641

7-
[Fluent Bit](http://fluentbit.io) is part of the [Fluentd](http://fluentd.org) project ecosystem, it's licensed under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). This project is made and sponsored by [Treasure Data](https://www.treasuredata.com).

SUMMARY.md

+131-111
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,133 @@
11
# Table of contents
22

3-
* [Introduction](README.md)
4-
* [About](about/README.md)
5-
* [Why ?](about/why.md)
6-
* [Fluentd & Fluent Bit](about/fluentd_and_fluentbit.md)
7-
* [License](about/license.md)
8-
* [Installation](installation/README.md)
9-
* [Supported Platforms](installation/supported_platforms.md)
10-
* [Requirements](installation/requirements.md)
11-
* [Download Sources](installation/download_sources.md)
12-
* [Upgrade Notes](installation/upgrade_notes.md)
13-
* [Build and Install](installation/build_install.md)
14-
* [Build with Static Configuration](installation/build_static_configuration.md)
15-
* [Docker Images](installation/docker.md)
16-
* [Kubernetes](installation/kubernetes.md)
17-
* [TD Agent Bit](installation/td-agent-bit.md)
18-
* [Debian Packages](installation/debian.md)
19-
* [Ubuntu Packages](installation/ubuntu.md)
20-
* [CentOS Packages](installation/redhat_centos.md)
21-
* [Raspberry Pi](installation/raspberry_pi.md)
22-
* [Yocto Project](installation/yocto.md)
23-
* [Windows](installation/windows.md)
24-
* [Getting Started](getting_started/README.md)
25-
* [Service](getting_started/service.md)
26-
* [Input](getting_started/input.md)
27-
* [Parser](getting_started/parser.md)
28-
* [Filter](getting_started/filter.md)
29-
* [Buffer](getting_started/buffer.md)
30-
* [Routing](getting_started/routing.md)
31-
* [Output](getting_started/output.md)
32-
* [Configuration](configuration/README.md)
33-
* [Configuration Schema](configuration/schema.md)
34-
* [Configuration File](configuration/file.md)
35-
* [Configuration Variables](configuration/variables.md)
36-
* [Configuration Commands](configuration/commands.md)
37-
* [Buffering / Storage](configuration/buffering.md)
38-
* [Monitoring](configuration/monitoring.md)
39-
* [Unit Sizes](configuration/unit_sizes.md)
40-
* [TLS / SSL](configuration/tls_ssl.md)
41-
* [Backpressure](configuration/backpressure.md)
42-
* [Memory Usage](configuration/memory_usage.md)
43-
* [Upstream Servers](configuration/upstream_servers.md)
44-
* [Scheduler](configuration/scheduler.md)
45-
* [Stream Processor](configuration/stream_processor.md)
46-
* [Service](service/README.md)
47-
* [Input Plugins](input/README.md)
48-
* [Collectd](input/collectd.md)
49-
* [CPU Usage](input/cpu.md)
50-
* [Disk Usage](input/disk.md)
51-
* [Docker](input/docker.md)
52-
* [Dummy](input/dummy.md)
53-
* [Exec](input/exec.md)
54-
* [Forward](input/forward.md)
55-
* [Head](input/head.md)
56-
* [Health](input/health.md)
57-
* [Kernel Log Buffer](input/kmsg.md)
58-
* [Memory Usage](input/mem.md)
59-
* [MQTT](input/mqtt.md)
60-
* [Network Traffic](input/netif.md)
61-
* [Process](input/proc.md)
62-
* [Random](input/random.md)
63-
* [Serial Interface](input/serial.md)
64-
* [Standard Input](input/stdin.md)
65-
* [StatsD Input](input/statsd.md)
66-
* [Syslog](input/syslog.md)
67-
* [Systemd](input/systemd.md)
68-
* [Tail](input/tail.md)
69-
* [TCP](input/tcp.md)
70-
* [Thermal](input/thermal.md)
71-
* [Windows Event Log](input/winlog.md)
72-
* [Parsers](parser/README.md)
73-
* [JSON Parser](parser/json.md)
74-
* [Regular Expression Parser](parser/regular_expression.md)
75-
* [LTSV Parser](parser/ltsv.md)
76-
* [Logfmt Parser](parser/logfmt.md)
77-
* [Decoders](parser/decoder.md)
78-
* [Filter Plugins](filter/README.md)
79-
* [AWS](filter/aws.md)
80-
* [Grep](filter/grep.md)
81-
* [Kubernetes](filter/kubernetes.md)
82-
* [Lua](filter/lua.md)
83-
* [Parser](filter/parser.md)
84-
* [Record Modifier](filter/record_modifier.md)
85-
* [Standard Output](filter/stdout.md)
86-
* [Throttle](filter/throttle.md)
87-
* [Nest](filter/nest.md)
88-
* [Modify](filter/modify.md)
89-
* [Output Plugins](output/README.md)
90-
* [Azure](output/azure.md)
91-
* [BigQuery](output/bigquery.md)
92-
* [Counter](output/counter.md)
93-
* [Datadog](output/datadog.md)
94-
* [Elasticsearch](output/elasticsearch.md)
95-
* [File](output/file.md)
96-
* [FlowCounter](output/flowcounter.md)
97-
* [Forward](output/forward.md)
98-
* [GELF](output/gelf.md)
99-
* [HTTP](output/http.md)
100-
* [InfluxDB](output/influxdb.md)
101-
* [Kafka](output/kafka.md)
102-
* [Kafka REST Proxy](output/kafka-rest-proxy.md)
103-
* [NATS](output/nats.md)
104-
* [Null](output/null.md)
105-
* [Stackdriver](output/stackdriver.md)
106-
* [Standard Output](output/stdout.md)
107-
* [Splunk](output/splunk.md)
108-
* [TCP & TLS](output/tcp.md)
109-
* [Treasure Data](output/td.md)
110-
* [Fluent Bit for Developers](development/README.md)
111-
* [Library API](development/library_api.md)
112-
* [Ingest Records Manually](development/ingest_records_manually.md)
113-
* [Fluent Bit and Golang Plugins](development/golang_plugins.md)
3+
* [Fluent Bit v1.4 Documentation](README.md)
4+
5+
## About
6+
7+
* [What is Fluent Bit ?](about/what-is-fluent-bit.md)
8+
* [A Brief History of Fluent Bit](about/history.md)
9+
* [Fluentd & Fluent Bit](about/fluentd-and-fluent-bit.md)
10+
* [License](about/license.md)
11+
12+
## Concepts
13+
14+
* [Key Concepts](concepts/key-concepts.md)
15+
* [Buffering](concepts/buffering.md)
16+
* [Data Pipeline](concepts/data-pipeline/README.md)
17+
* [Input](concepts/data-pipeline/input.md)
18+
* [Parser](concepts/data-pipeline/parser.md)
19+
* [Filter](concepts/data-pipeline/filter.md)
20+
* [Buffer](concepts/data-pipeline/buffer.md)
21+
* [Router](concepts/data-pipeline/router.md)
22+
* [Output](concepts/data-pipeline/output.md)
23+
24+
## Installation
25+
26+
* [Upgrade Notes](installation/upgrade-notes.md)
27+
* [Supported Platforms](installation/untitled.md)
28+
* [Requirements](installation/requirements.md)
29+
* [Sources](installation/sources/README.md)
30+
* [Download Source Code](installation/sources/download-source-code.md)
31+
* [Build and Install](installation/sources/build-and-install.md)
32+
* [Build with Static Configuration](installation/sources/build-with-static-configuration.md)
33+
* [Linux Packages](installation/linux/README.md)
34+
* [Amazon Linux](installation/linux/amazon-linux.md)
35+
* [CentOS](installation/linux/centos.md)
36+
* [Debian](installation/linux/debian.md)
37+
* [Ubuntu](installation/linux/ubuntu.md)
38+
* [Raspbian / Raspberry Pi](installation/linux/raspbian-raspberry-pi.md)
39+
* [Docker](installation/docker.md)
40+
* [Kubernetes](installation/kubernetes.md)
41+
* [Yocto / Embedded Linux](installation/yocto-embedded-linux.md)
42+
* [Windows](installation/windows.md)
43+
44+
## Administration
45+
46+
* [Configuring Fluent Bit](administration/configuring-fluent-bit/README.md)
47+
* [Files Schema / Structure](administration/configuring-fluent-bit/files-schema-structure/README.md)
48+
* [Variables](administration/configuring-fluent-bit/files-schema-structure/variables.md)
49+
* [Commands](administration/configuring-fluent-bit/files-schema-structure/commands.md)
50+
* [Configuration File](administration/configuring-fluent-bit/main-configuration-file.md)
51+
* [Upstream Servers](administration/configuring-fluent-bit/upstream-servers.md)
52+
* [Unit Sizes](administration/configuring-fluent-bit/unit-sizes.md)
53+
* [Security](administration/security.md)
54+
* [Buffering & Storage](administration/buffering-and-storage.md)
55+
* [Backpressure](administration/backpressure.md)
56+
* [Memory Management](administration/memory-management.md)
57+
* [Monitoring](administration/monitoring.md)
58+
* [Scheduling and Retries](administration/scheduling-and-retries.md)
59+
60+
## Data Pipeline <a id="pipeline"></a>
61+
62+
* [Inputs](pipeline/inputs/README.md)
63+
* [Collectd](pipeline/inputs/collectd.md)
64+
* [CPU Metrics](pipeline/inputs/cpu-metrics.md)
65+
* [Disk I/O Metrics](pipeline/inputs/disk-i-o-metrics.md)
66+
* [Dummy](pipeline/inputs/dummy.md)
67+
* [Exec](pipeline/inputs/exec.md)
68+
* [Forward](pipeline/inputs/forward.md)
69+
* [Head](pipeline/inputs/head.md)
70+
* [Health](pipeline/inputs/health.md)
71+
* [Kernel Logs](pipeline/inputs/kernel-logs.md)
72+
* [Memory Metrics](pipeline/inputs/memory-metrics.md)
73+
* [MQTT](pipeline/inputs/mqtt.md)
74+
* [Network I/O Metrics](pipeline/inputs/network-i-o-metrics.md)
75+
* [Process](pipeline/inputs/process.md)
76+
* [Random](pipeline/inputs/random.md)
77+
* [Serial Interface](pipeline/inputs/serial-interface.md)
78+
* [Standard Input](pipeline/inputs/standard-input.md)
79+
* [Syslog](pipeline/inputs/syslog.md)
80+
* [Systemd](pipeline/inputs/systemd.md)
81+
* [Tail](pipeline/inputs/tail.md)
82+
* [TCP](pipeline/inputs/tcp.md)
83+
* [Thermal](pipeline/inputs/thermal.md)
84+
* [Windows Event Log](pipeline/inputs/windows-event-log.md)
85+
* [Parsers](pipeline/parsers/README.md)
86+
* [JSON](pipeline/parsers/json.md)
87+
* [Regular Expression](pipeline/parsers/regular-expression.md)
88+
* [LTSV](pipeline/parsers/ltsv.md)
89+
* [Logfmt](pipeline/parsers/logfmt.md)
90+
* [Decoders](pipeline/parsers/decoders.md)
91+
* [Filters](pipeline/filters/README.md)
92+
* [AWS Metadata](pipeline/filters/aws-metadata.md)
93+
* [Grep](pipeline/filters/grep.md)
94+
* [Kubernetes](pipeline/filters/kubernetes.md)
95+
* [Lua](pipeline/filters/lua.md)
96+
* [Parser](pipeline/filters/parser.md)
97+
* [Record Modifier](pipeline/filters/record-modifier.md)
98+
* [Standard Output](pipeline/filters/standard-output.md)
99+
* [Throttle](pipeline/filters/throttle.md)
100+
* [Nest](pipeline/filters/nest.md)
101+
* [Modify](pipeline/filters/modify.md)
102+
* [Outputs](pipeline/outputs/README.md)
103+
* [Azure](pipeline/outputs/azure.md)
104+
* [BigQuery](pipeline/outputs/bigquery.md)
105+
* [Counter](pipeline/outputs/counter.md)
106+
* [Datadog](pipeline/outputs/datadog.md)
107+
* [Elasticsearch](pipeline/outputs/elasticsearch.md)
108+
* [File](pipeline/outputs/file.md)
109+
* [FlowCounter](pipeline/outputs/flowcounter.md)
110+
* [Forward](pipeline/outputs/forward.md)
111+
* [GELF](pipeline/outputs/gelf.md)
112+
* [HTTP](pipeline/outputs/http.md)
113+
* [InfluxDB](pipeline/outputs/influxdb.md)
114+
* [Kafka](pipeline/outputs/kafka.md)
115+
* [Kafka REST Proxy](pipeline/outputs/kafka-rest-proxy.md)
116+
* [NATS](pipeline/outputs/nats.md)
117+
* [NULL](pipeline/outputs/null.md)
118+
* [Stackdriver](pipeline/outputs/stackdriver.md)
119+
* [Standard Output](pipeline/outputs/standard-output.md)
120+
* [Splunk](pipeline/outputs/splunk.md)
121+
* [TCP & TLS](pipeline/outputs/tcp-and-tls.md)
122+
* [Treasure Data](pipeline/outputs/treasure-data.md)
123+
124+
## Stream Processing
125+
126+
* [FIXME](stream-processing/untitled.md)
127+
128+
## Fluent Bit for Developers <a id="development"></a>
129+
130+
* [C Library API](development/library_api.md)
131+
* [Ingest Records Manually](development/ingest-records-manually.md)
132+
* [Golang Output Plugins](development/golang-output-plugins.md)
133+

about/README.md

-8
This file was deleted.

about/fluentd-and-fluent-bit.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Fluentd & Fluent Bit
2+

about/fluentd_and_fluentbit.md

-25
This file was deleted.

about/history.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
description: Every project has a story
3+
---
4+
5+
# A Brief History of Fluent Bit
6+
7+
On 2014, the [Fluentd](https://fluentd.org) team at [Treasure Data](https://www.treasuredata.com) forecasted the need of a lightweight log processor for constraint environments like Embedded Linux and Gateways, the project aimed to be part of the Fluentd Ecosystem and we called it [Fluent Bit](https://fluentbit.io), fully open source and available under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
8+
9+
After the project was around for some time, it got some traction in the Embedded market but we also started getting requests for several features from the Cloud community like more inputs, filters, and outputs. Not so long after that, Fluent Bit becomes one of the preferred solutions to solve the logging challenges in Cloud environments.
10+

0 commit comments

Comments
 (0)