Skip to content

Commit d81cd1a

Browse files
committed
list all supported configuration parameters here
Signed-off-by: TAGOMORI Satoshi <tagomoris@gmail.com>
1 parent 89c0329 commit d81cd1a

File tree

1 file changed

+59
-1
lines changed

1 file changed

+59
-1
lines changed

README.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,59 @@ func main() {
5858
f := fluent.New(fluent.Config{FluentPort: 80, FluentHost: "example.com"})
5959
```
6060

61+
### FluentNetwork
62+
63+
Specify the network protocol, as "tcp" (use `FluentHost` and `FluentPort`) or "unix" (use `FluentSocketPath`).
64+
The default is "tcp".
65+
66+
### FluentHost
67+
68+
Specify a hostname or IP address as a string for the destination of the "tcp" protocol.
69+
The default is "127.0.0.1".
70+
71+
### FluentPort
72+
73+
Specify the TCP port of the destination. The default is 24224.
74+
75+
### FluentSocketPath
76+
77+
Specify the unix socket path when `FluentNetwork` is "unix".
78+
79+
### Timeout
80+
81+
Set the timeout value of `time.Duration` to connect to the destination.
82+
The default is 3 seconds.
83+
6184
### WriteTimeout
6285

63-
Sets the timeout for Write call of logger.Post.
86+
Sets the timeout value of `time.Duration` for Write call of `logger.Post`.
6487
Since the default is zero value, Write will not time out.
6588

89+
### BufferLimit
90+
91+
Sets the number of events buffered on the memory. Records will be stored in memory up to this number. If the buffer is full, the call to record logs will fail.
92+
The default is 8192.
93+
94+
### RetryWait
95+
96+
Set the duration of the initial wait for the first retry, in milliseconds. The actual retry wait will be `r * 1.5^(N-1)` (r: this value, N: the number of retries).
97+
The default is 500.
98+
99+
### MaxRetry
100+
101+
Sets the maximum number of retries. If the number of retries become larger than this value, the write/send operation will fail.
102+
The default is 13.
103+
104+
### MaxRetryWait
105+
106+
The maximum duration of wait between retries, in milliseconds. If the calculated retry wait is larger than this value, the actual retry wait will be this value.
107+
The default is 60,000 (60 seconds).
108+
109+
### TagPrefix
110+
111+
Sets the prefix string of the tag. Prefix will be appended with a dot `.`, like `ppp.tag` (ppp: the value of this parameter, tag: the tag string specified in a call).
112+
The default is blank.
113+
66114
### Async
67115

68116
Enable asynchronous I/O (connect and write) for sending events to Fluentd.
@@ -73,6 +121,16 @@ The default is false.
73121
When Async is enabled, immediately discard the event queue on close() and return (instead of trying MaxRetry times for each event in the queue before returning)
74122
The default is false.
75123

124+
### SubSecondPrecision
125+
126+
Enable time encoding as EventTime, which contains sub-second precision values. The messages encoded with this option can be received only by Fluentd v0.14 or later.
127+
The default is false.
128+
129+
### MarshalAsJson
130+
131+
Enable Json data marshaling to send messages using Json format (instead of the standard MessagePack). It is supported by Fluentd `in_forward` plugin.
132+
The default is false.
133+
76134
### RequestAck
77135

78136
Sets whether to request acknowledgment from Fluentd to increase the reliability

0 commit comments

Comments
 (0)