summaryrefslogtreecommitdiffstats
path: root/fluent-bit/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'fluent-bit/documentation')
-rw-r--r--fluent-bit/documentation/README.md11
-rw-r--r--fluent-bit/documentation/examples/multiline/filter_multiline/fluent-bit.conf19
-rw-r--r--fluent-bit/documentation/examples/multiline/filter_multiline/parsers_multiline.conf15
-rw-r--r--fluent-bit/documentation/examples/multiline/filter_multiline/test.log60
-rw-r--r--fluent-bit/documentation/examples/multiline/regex-001/fluent-bit.conf14
-rw-r--r--fluent-bit/documentation/examples/multiline/regex-001/parsers_multiline.conf16
-rw-r--r--fluent-bit/documentation/examples/multiline/regex-001/test.log9
-rw-r--r--fluent-bit/documentation/fluentbit_ecosystem.pngbin0 -> 260573 bytes
-rw-r--r--fluent-bit/documentation/fluentbit_users.pngbin0 -> 93439 bytes
9 files changed, 144 insertions, 0 deletions
diff --git a/fluent-bit/documentation/README.md b/fluent-bit/documentation/README.md
new file mode 100644
index 000000000..14872813b
--- /dev/null
+++ b/fluent-bit/documentation/README.md
@@ -0,0 +1,11 @@
+# Fluent Bit Documentation
+
+For every [Fluent Bit](https://fluentbit.io) release there is full documentation, the most updated documents can be found in the following link:
+
+[https://docs.fluentbit.io/](https://docs.fluentbit.io/)
+
+## Documentation Sources
+
+If you are interested into provide some documentation contribution, please refer to the following GIT repository for more details:
+
+[http://github.com/fluent/fluent-bit-docs](http://github.com/fluent/fluent-bit-docs)
diff --git a/fluent-bit/documentation/examples/multiline/filter_multiline/fluent-bit.conf b/fluent-bit/documentation/examples/multiline/filter_multiline/fluent-bit.conf
new file mode 100644
index 000000000..7ac6e63a1
--- /dev/null
+++ b/fluent-bit/documentation/examples/multiline/filter_multiline/fluent-bit.conf
@@ -0,0 +1,19 @@
+[SERVICE]
+ flush 1
+ log_level info
+ parsers_file parsers_multiline.conf
+
+[INPUT]
+ name tail
+ path test.log
+ read_from_head true
+
+[FILTER]
+ name multiline
+ match *
+ multiline.key_content log
+ multiline.parser go, multiline-regex-test
+
+[OUTPUT]
+ name stdout
+ match *
diff --git a/fluent-bit/documentation/examples/multiline/filter_multiline/parsers_multiline.conf b/fluent-bit/documentation/examples/multiline/filter_multiline/parsers_multiline.conf
new file mode 100644
index 000000000..6e03892b5
--- /dev/null
+++ b/fluent-bit/documentation/examples/multiline/filter_multiline/parsers_multiline.conf
@@ -0,0 +1,15 @@
+[MULTILINE_PARSER]
+ name multiline-regex-test
+ type regex
+ # Regex rules for multiline parsing
+ # ---------------------------------
+ #
+ # configuration hints:
+ #
+ # - first state always has the name: start_state
+ # - every field in the rule must be inside double quotes
+ #
+ # rules | state name | regex pattern | next state name
+ # --------|----------------|--------------------------------------------------
+ rule "start_state" "/(Dec \d+ \d+\:\d+\:\d+)(.*)/" "cont"
+ rule "cont" "/^\s+at.*/" "cont"
diff --git a/fluent-bit/documentation/examples/multiline/filter_multiline/test.log b/fluent-bit/documentation/examples/multiline/filter_multiline/test.log
new file mode 100644
index 000000000..7b6e6ec7c
--- /dev/null
+++ b/fluent-bit/documentation/examples/multiline/filter_multiline/test.log
@@ -0,0 +1,60 @@
+single line...
+Dec 14 06:41:08 Exception in thread "main" java.lang.RuntimeException: Something has gone wrong, aborting!
+ at com.myproject.module.MyProject.badMethod(MyProject.java:22)
+ at com.myproject.module.MyProject.oneMoreMethod(MyProject.java:18)
+ at com.myproject.module.MyProject.anotherMethod(MyProject.java:14)
+ at com.myproject.module.MyProject.someMethod(MyProject.java:10)
+ at com.myproject.module.MyProject.main(MyProject.java:6)
+another line...
+panic: my panic
+
+goroutine 4 [running]:
+panic(0x45cb40, 0x47ad70)
+ /usr/local/go/src/runtime/panic.go:542 +0x46c fp=0xc42003f7b8 sp=0xc42003f710 pc=0x422f7c
+main.main.func1(0xc420024120)
+ foo.go:6 +0x39 fp=0xc42003f7d8 sp=0xc42003f7b8 pc=0x451339
+runtime.goexit()
+ /usr/local/go/src/runtime/asm_amd64.s:2337 +0x1 fp=0xc42003f7e0 sp=0xc42003f7d8 pc=0x44b4d1
+created by main.main
+ foo.go:5 +0x58
+
+goroutine 1 [chan receive]:
+runtime.gopark(0x4739b8, 0xc420024178, 0x46fcd7, 0xc, 0xc420028e17, 0x3)
+ /usr/local/go/src/runtime/proc.go:280 +0x12c fp=0xc420053e30 sp=0xc420053e00 pc=0x42503c
+runtime.goparkunlock(0xc420024178, 0x46fcd7, 0xc, 0x1000f010040c217, 0x3)
+ /usr/local/go/src/runtime/proc.go:286 +0x5e fp=0xc420053e70 sp=0xc420053e30 pc=0x42512e
+runtime.chanrecv(0xc420024120, 0x0, 0xc420053f01, 0x4512d8)
+ /usr/local/go/src/runtime/chan.go:506 +0x304 fp=0xc420053f20 sp=0xc420053e70 pc=0x4046b4
+runtime.chanrecv1(0xc420024120, 0x0)
+ /usr/local/go/src/runtime/chan.go:388 +0x2b fp=0xc420053f50 sp=0xc420053f20 pc=0x40439b
+main.main()
+ foo.go:9 +0x6f fp=0xc420053f80 sp=0xc420053f50 pc=0x4512ef
+runtime.main()
+ /usr/local/go/src/runtime/proc.go:185 +0x20d fp=0xc420053fe0 sp=0xc420053f80 pc=0x424bad
+runtime.goexit()
+ /usr/local/go/src/runtime/asm_amd64.s:2337 +0x1 fp=0xc420053fe8 sp=0xc420053fe0 pc=0x44b4d1
+
+goroutine 2 [force gc (idle)]:
+runtime.gopark(0x4739b8, 0x4ad720, 0x47001e, 0xf, 0x14, 0x1)
+ /usr/local/go/src/runtime/proc.go:280 +0x12c fp=0xc42003e768 sp=0xc42003e738 pc=0x42503c
+runtime.goparkunlock(0x4ad720, 0x47001e, 0xf, 0xc420000114, 0x1)
+ /usr/local/go/src/runtime/proc.go:286 +0x5e fp=0xc42003e7a8 sp=0xc42003e768 pc=0x42512e
+runtime.forcegchelper()
+ /usr/local/go/src/runtime/proc.go:238 +0xcc fp=0xc42003e7e0 sp=0xc42003e7a8 pc=0x424e5c
+runtime.goexit()
+ /usr/local/go/src/runtime/asm_amd64.s:2337 +0x1 fp=0xc42003e7e8 sp=0xc42003e7e0 pc=0x44b4d1
+created by runtime.init.4
+ /usr/local/go/src/runtime/proc.go:227 +0x35
+
+goroutine 3 [GC sweep wait]:
+runtime.gopark(0x4739b8, 0x4ad7e0, 0x46fdd2, 0xd, 0x419914, 0x1)
+ /usr/local/go/src/runtime/proc.go:280 +0x12c fp=0xc42003ef60 sp=0xc42003ef30 pc=0x42503c
+runtime.goparkunlock(0x4ad7e0, 0x46fdd2, 0xd, 0x14, 0x1)
+ /usr/local/go/src/runtime/proc.go:286 +0x5e fp=0xc42003efa0 sp=0xc42003ef60 pc=0x42512e
+runtime.bgsweep(0xc42001e150)
+ /usr/local/go/src/runtime/mgcsweep.go:52 +0xa3 fp=0xc42003efd8 sp=0xc42003efa0 pc=0x419973
+runtime.goexit()
+ /usr/local/go/src/runtime/asm_amd64.s:2337 +0x1 fp=0xc42003efe0 sp=0xc42003efd8 pc=0x44b4d1
+created by runtime.gcenable
+ /usr/local/go/src/runtime/mgc.go:216 +0x58
+one more line, no multiline
diff --git a/fluent-bit/documentation/examples/multiline/regex-001/fluent-bit.conf b/fluent-bit/documentation/examples/multiline/regex-001/fluent-bit.conf
new file mode 100644
index 000000000..202a9163a
--- /dev/null
+++ b/fluent-bit/documentation/examples/multiline/regex-001/fluent-bit.conf
@@ -0,0 +1,14 @@
+[SERVICE]
+ flush 1
+ log_level info
+ parsers_file parsers_multiline.conf
+
+[INPUT]
+ name tail
+ path test.log
+ read_from_head true
+ multiline.parser multiline-regex-test
+
+[OUTPUT]
+ name stdout
+ match *
diff --git a/fluent-bit/documentation/examples/multiline/regex-001/parsers_multiline.conf b/fluent-bit/documentation/examples/multiline/regex-001/parsers_multiline.conf
new file mode 100644
index 000000000..8a6ae658d
--- /dev/null
+++ b/fluent-bit/documentation/examples/multiline/regex-001/parsers_multiline.conf
@@ -0,0 +1,16 @@
+[MULTILINE_PARSER]
+ name multiline-regex-test
+ type regex
+ flush_timeout 1000
+ # Regex rules for multiline parsing
+ # ---------------------------------
+ #
+ # configuration hints:
+ #
+ # - first state always has the name: start_state
+ # - every field in the rule must be inside double quotes
+ #
+ # rules | state name | regex pattern | next state name
+ # --------|----------------|--------------------------------------------------
+ rule "start_state" "/(Dec \d+ \d+\:\d+\:\d+)(.*)/" "cont"
+ rule "cont" "/^\s+at.*/" "cont"
diff --git a/fluent-bit/documentation/examples/multiline/regex-001/test.log b/fluent-bit/documentation/examples/multiline/regex-001/test.log
new file mode 100644
index 000000000..ae1a2e522
--- /dev/null
+++ b/fluent-bit/documentation/examples/multiline/regex-001/test.log
@@ -0,0 +1,9 @@
+single line...
+Dec 14 06:41:08 Exception in thread "main" java.lang.RuntimeException: Something has gone wrong, aborting!
+ at com.myproject.module.MyProject.badMethod(MyProject.java:22)
+ at com.myproject.module.MyProject.oneMoreMethod(MyProject.java:18)
+ at com.myproject.module.MyProject.anotherMethod(MyProject.java:14)
+ at com.myproject.module.MyProject.someMethod(MyProject.java:10)
+ at com.myproject.module.MyProject.main(MyProject.java:6)
+another line...
+
diff --git a/fluent-bit/documentation/fluentbit_ecosystem.png b/fluent-bit/documentation/fluentbit_ecosystem.png
new file mode 100644
index 000000000..bc0864c03
--- /dev/null
+++ b/fluent-bit/documentation/fluentbit_ecosystem.png
Binary files differ
diff --git a/fluent-bit/documentation/fluentbit_users.png b/fluent-bit/documentation/fluentbit_users.png
new file mode 100644
index 000000000..b5c43dacb
--- /dev/null
+++ b/fluent-bit/documentation/fluentbit_users.png
Binary files differ