mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
a6a98d6928
Updates the fluent logger library. Namely this fixes a couple places where the library could panic when closing and writing to channels. see https://github.com/fluent/fluent-logger-golang/pull/93 and https://github.com/fluent/fluent-logger-golang/pull/95 closes #40829 closes #32567 Signed-off-by: Cam <gh@sparr.email>
150 lines
4.2 KiB
Markdown
150 lines
4.2 KiB
Markdown
fluent-logger-golang
|
|
====
|
|
|
|
[](https://travis-ci.org/fluent/fluent-logger-golang)
|
|
[](https://godoc.org/github.com/fluent/fluent-logger-golang/fluent)
|
|
|
|
## A structured event logger for Fluentd (Golang)
|
|
|
|
## How to install
|
|
|
|
```
|
|
go get github.com/fluent/fluent-logger-golang/fluent
|
|
```
|
|
|
|
## Usage
|
|
|
|
Install the package with `go get` and use `import` to include it in your project.
|
|
|
|
```
|
|
import "github.com/fluent/fluent-logger-golang/fluent"
|
|
```
|
|
|
|
## Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/fluent/fluent-logger-golang/fluent"
|
|
"fmt"
|
|
//"time"
|
|
)
|
|
|
|
func main() {
|
|
logger, err := fluent.New(fluent.Config{})
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
}
|
|
defer logger.Close()
|
|
tag := "myapp.access"
|
|
var data = map[string]string{
|
|
"foo": "bar",
|
|
"hoge": "hoge",
|
|
}
|
|
error := logger.Post(tag, data)
|
|
// error := logger.PostWithTime(tag, time.Now(), data)
|
|
if error != nil {
|
|
panic(error)
|
|
}
|
|
}
|
|
```
|
|
|
|
`data` must be a value like `map[string]literal`, `map[string]interface{}`, `struct` or [`msgp.Marshaler`](http://godoc.org/github.com/tinylib/msgp/msgp#Marshaler). Logger refers tags `msg` or `codec` of each fields of structs.
|
|
|
|
## Setting config values
|
|
|
|
```go
|
|
f := fluent.New(fluent.Config{FluentPort: 80, FluentHost: "example.com"})
|
|
```
|
|
|
|
### FluentNetwork
|
|
|
|
Specify the network protocol, as "tcp" (use `FluentHost` and `FluentPort`) or "unix" (use `FluentSocketPath`).
|
|
The default is "tcp".
|
|
|
|
### FluentHost
|
|
|
|
Specify a hostname or IP address as a string for the destination of the "tcp" protocol.
|
|
The default is "127.0.0.1".
|
|
|
|
### FluentPort
|
|
|
|
Specify the TCP port of the destination. The default is 24224.
|
|
|
|
### FluentSocketPath
|
|
|
|
Specify the unix socket path when `FluentNetwork` is "unix".
|
|
|
|
### Timeout
|
|
|
|
Set the timeout value of `time.Duration` to connect to the destination.
|
|
The default is 3 seconds.
|
|
|
|
### WriteTimeout
|
|
|
|
Sets the timeout value of `time.Duration` for Write call of `logger.Post`.
|
|
Since the default is zero value, Write will not time out.
|
|
|
|
### BufferLimit
|
|
|
|
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.
|
|
The default is 8192.
|
|
|
|
### RetryWait
|
|
|
|
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).
|
|
The default is 500.
|
|
|
|
### MaxRetry
|
|
|
|
Sets the maximum number of retries. If the number of retries become larger than this value, the write/send operation will fail.
|
|
The default is 13.
|
|
|
|
### MaxRetryWait
|
|
|
|
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.
|
|
The default is 60,000 (60 seconds).
|
|
|
|
### TagPrefix
|
|
|
|
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).
|
|
The default is blank.
|
|
|
|
### Async
|
|
|
|
Enable asynchronous I/O (connect and write) for sending events to Fluentd.
|
|
The default is false.
|
|
|
|
### ForceStopAsyncSend
|
|
|
|
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)
|
|
The default is false.
|
|
|
|
### SubSecondPrecision
|
|
|
|
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.
|
|
The default is false.
|
|
|
|
### MarshalAsJson
|
|
|
|
Enable Json data marshaling to send messages using Json format (instead of the standard MessagePack). It is supported by Fluentd `in_forward` plugin.
|
|
The default is false.
|
|
|
|
### RequestAck
|
|
|
|
Sets whether to request acknowledgment from Fluentd to increase the reliability
|
|
of the connection. The default is false.
|
|
|
|
## FAQ
|
|
|
|
### Does this logger support the features of Fluentd Forward Protocol v1?
|
|
|
|
"the features" includes heartbeat messages (for TCP keepalive), TLS transport and shared key authentication.
|
|
|
|
This logger doesn't support those features. Patches are welcome!
|
|
|
|
## Tests
|
|
```
|
|
go test
|
|
```
|