Skip to content

Commit 52da3dc

Browse files
committed
development: final style
Signed-off-by: Lynette Miles <[email protected]>
1 parent 48dfbec commit 52da3dc

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

development/library_api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Fluent Bit is written in C and can be used from any C or C++ application.
66

77
Fluent Bit runs as a service, which means that the exposed API provides interfaces to create and manage contexts, specify inputs and outputs, set configuration parameters, and set routing paths for events or records. A typical usage of this library involves:
88

9-
* Creating library instance and contexts and setting their properties.
10-
* Enabling input plugins and setting their properties.
11-
* Enabling output plugins and setting their properties.
12-
* Starting the library runtime.
13-
* Optionally ingesting records manually.
14-
* Stopping the library runtime.
15-
* Destroying library instances and contexts.
9+
- Creating library instance and contexts and setting their properties.
10+
- Enabling input plugins and setting their properties.
11+
- Enabling output plugins and setting their properties.
12+
- Starting the library runtime.
13+
- Optionally ingesting records manually.
14+
- Stopping the library runtime.
15+
- Destroying library instances and contexts.
1616

1717
## Data types
1818

development/msgpack-format.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1-
# Msgpack format
1+
# MessagePack format
22

3-
Fluent Bit **always** handles every Event message as a structured message using a binary serialization data format called [MessagePack](https://msgpack.org/).
3+
Fluent Bit always handles every Event message as a structured message using a binary serialization data format called [MessagePack](https://msgpack.org/).
44

55
## Fluent Bit usage
66

77
MessagePack is a standard and well-defined format, refer to the official documentation for full details.
88
This section provides an overview of the specific types used by Fluent Bit within the format to help anyone consuming it.
99

10-
* The data structure used by Fluent Bit is a 2-length [`fixarray`](https://github.com/msgpack/msgpack/blob/master/spec.md#array-format-family) of the timestamp and the data.
11-
* The timestamp comes from [`flb_time_append_to_msgpack`])(https://github.com/fluent/fluent-bit/blob/2138cee8f4878733956d42d82f6dcf95f0aa9339/src/flb_time.c#L197), so it's either a `uint64`, a `float64`, or a [`fixext`](https://github.com/msgpack/msgpack/blob/master/spec.md#ext-format-family) where the 4 MSBs are the seconds (big-endian `uint32`) and 4 LSBs are nanoseconds.
12-
* The data itself is just a [`msgpack` map](https://github.com/msgpack/msgpack/blob/master/spec.md#map-format-family) with the keys as strings.
10+
- The data structure used by Fluent Bit is a 2-length [`fixarray`](https://github.com/msgpack/msgpack/blob/master/spec.md#array-format-family) of the timestamp and the data.
11+
- The timestamp comes from [`flb_time_append_to_msgpack`](https://github.com/fluent/fluent-bit/blob/2138cee8f4878733956d42d82f6dcf95f0aa9339/src/flb_time.c#L197), so it's either a `uint64`, a `float64`, or a [`fixext`](https://github.com/msgpack/msgpack/blob/master/spec.md#ext-format-family) where the 4 MSBs are the seconds (big-endian `uint32`) and 4 LSBs are nanoseconds.
12+
- The data itself is a [`msgpack` map](https://github.com/msgpack/msgpack/blob/master/spec.md#map-format-family) with the keys as strings.
1313

1414
## Example
1515

1616
Set up Fluent Bit to send in `msgpack` format to a specific port.
1717

1818
```bash
1919
docker run --rm -it --network=host fluent/fluent-bit /fluent-bit/bin/fluent-bit -i cpu -o tcp://127.0.0.1:5170 -p format=msgpack -v
20-
2120
```
2221

23-
We could send this to stdout but as it is a serialized format you would end up with strange output.
24-
As an example we use the [Python msgpack library](https://msgpack.org/#languages) to deal with it:
22+
You could send this to stdout but as it's a serialized format you would end up with strange output.
23+
As an example, use the [Python `msgpack` library](https://msgpack.org/#languages) to handle it:
2524

2625
```python
2726
#Python3

vale-styles/FluentBit/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ exceptions:
5454
- GCP
5555
- GitLab
5656
- GitHub
57+
- Go
5758
- Google
5859
- Google Cloud
5960
- Google Cloud BigQuery

0 commit comments

Comments
 (0)