Skip to content

Commit 5414969

Browse files
cosmo0920edsiper
authored andcommitted
Add a description for input plugin creation
Signed-off-by: Hiroshi Hatake <[email protected]>
1 parent 03ba2b0 commit 5414969

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
# Fluent Bit Go!
22

3-
This repository contains Go packages that allows to create [Fluent Bit][fluent-bit] plugins. At the moment it only supports the creation of _Output_ plugins.
3+
This repository contains Go packages that allows to create [Fluent Bit][fluent-bit] plugins. At the moment it only supports the creation of _Output_ and _Input_ plugins.
44

55
## Requirements
66

7-
The code of this package is intended to be used with [Fluent Bit v1.4][fluent-bit-1-4] branch or higher.
7+
The code of this package for output plugin is intended to be used with [Fluent Bit v1.4][fluent-bit-1-4] branch or higher.
8+
9+
The code of this package for input plugin is intended to be used with [Fluent Bit v1.9][fluent-bit-1-9] branch or higher.
810

911
## Usage
1012

1113
Fluent Bit Go packages are exposed on this repository:
1214

1315
[github.com/fluent/fluent-bit-go][fluent-bit-go]
1416

17+
### Creating Output Plugin
18+
1519
When creating a Fluent Bit Output plugin, the _output_ package can be used as follows:
1620

1721
```go
@@ -20,6 +24,14 @@ import "github.com/fluent/fluent-bit-go/output"
2024

2125
For a more practical example please refer to the [out\_multiinstance plugin][multiinstance] implementation located at:
2226

27+
### Creating Input Plugin
28+
29+
When creating a Fluent Bit Input plugin, the _input_ package can be used as follows:
30+
31+
```go
32+
import "github.com/fluent/fluent-bit-go/input"
33+
```
34+
2335
## Contact
2436

2537
Feel free to join us on our Slack channel, Mailing List, IRC or Twitter:
@@ -36,6 +48,7 @@ other [contributors][contributors].
3648

3749
[fluent-bit]: http://fluentbit.io/
3850
[fluent-bit-1-4]: https://github.com/fluent/fluent-bit/tree/v1.4.0
51+
[fluent-bit-1-9]: https://github.com/fluent/fluent-bit/tree/1.9
3952
[multiinstance]: https://github.com/fluent/fluent-bit-go/tree/fc386d263885e50387dd0081a77adf4072e8e4b6/examples/out_multiinstance
4053
[fluent-bit-go]: http://github.com/fluent/fluent-bit-go
4154
[treasure-data]: http://treasuredata.com

0 commit comments

Comments
 (0)