You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Built upon [fluent-logger-node](https://github.com/fluent/fluent-logger-node).
13
13
$ npm install @fluent-org/logger
14
14
15
15
## Client
16
-
`@fluent-org/logger` provides a fully functional client that implements the Forward protocol. It supports reconnection, acknowledgements, timeouts, event retries, and more, and exposes its functionality through simple typed Promise interface.
16
+
`@fluent-org/logger` provides a fully functional client that implements the Forward protocol. It supports reconnection, acknowledgements, timeouts, event retries, and more, and exposes its functionality via a simple typed Promise interface.
17
17
18
18
For a full list of the client options and methods, see the [FluentClient docs](https://fluent.github.io/fluent-logger-bulk-node/classes/fluentclient.html)
19
19
@@ -65,7 +65,7 @@ const logger = new FluentClient("tag_prefix", {
@@ -74,8 +74,8 @@ emit(label: string, data: Record<string, any>, timestamp: number | Date | EventT
74
74
75
75
The returned Promise is resolved once the event is written to the socket, or rejected if an error occurs.
76
76
77
-
### Fluentd acknowledgements
78
-
The Fluent forward protocol provides explicit support for acknowledgements, which allow the client to be sure that the event reached its destination.
77
+
### Acknowledgements
78
+
The [Fluent forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1) provides explicit support for acknowledgements, which allow the client to be sure that the event reached its destination.
79
79
80
80
Enabling acknowledgements means that the promise returned by `emit` will be resolved once the client receives an explicit acknowledgement from the server.
81
81
```js
@@ -86,7 +86,7 @@ const logger = new FluentClient("tag_prefix", {
86
86
```
87
87
88
88
### Event modes
89
-
The Fluent forward protocol provides multiple message modes, `Message`, `Forward`, `PackedForward`(default), `CompressedPackedForward`. The Fluent client supports all of them.
89
+
The [Fluent forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1) provides multiple message modes, `Message`, `Forward`, `PackedForward`(default), `CompressedPackedForward`. The Fluent client supports all of them.
0 commit comments