Skip to content

Commit d82033f

Browse files
esmerelTom
authored andcommitted
Vale: fixing errors added post cleanup (fluent#2107)
Signed-off-by: Lynette Miles <[email protected]> Signed-off-by: Tom <[email protected]>
1 parent bcbc9da commit d82033f

File tree

2 files changed

+24
-31
lines changed

2 files changed

+24
-31
lines changed

pipeline/outputs/http.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The plugin supports the following configuration parameters:
2525
| `allow_duplicated_headers` | Specify if duplicated headers are allowed. If a duplicated header is found, the latest key/value set is preserved. | `true` |
2626
| `log_response_payload` | Specify if the response payload should be logged or not. | `true` |
2727
| `header_tag` | Specify an optional HTTP header field for the original message tag. | _none_ |
28-
| `http_method` | Specify POST vs PUT HTTP Method. | `POST` |
28+
| `http_method` | Specify `POST` versus `PUT` HTTP Method. | `POST` |
2929
| `header` | Add a HTTP header key/value pair. Multiple headers can be set. | _none_ |
3030
| `json_date_key` | Specify the name of the time key in the output record. To disable the time key, set the value to `false`. | `date` |
3131
| `json_date_format` | Specify the format of the date. Supported formats: `double`, `epoch`, `iso8601`, `java_sql_timestamp`. | `double` |

pipeline/outputs/output_formats.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,20 @@
1-
# Output Formats
1+
# Output formats
22

3-
Some of the output plugin's has a config field called `formats`, with a limited
4-
amount of options are available (`json`, `json_stream`, `json_lines`, `msgpack`, `gelf`).
3+
Some of the output plugin's has a configuration field called `formats`, with a limited amount of options are available (`json`, `json_stream`, `json_lines`, `msgpack`, `gelf`).
54

6-
The specifications, or reference to external documentation of the formats, is
7-
available in this page.
5+
The specifications, or reference to external documentation of the formats, is available in this page.
86

9-
## JSON Formats
7+
## JSON formats
108

11-
The most custom format options are the JSON types, these are three quite
12-
common variants of sending JSON encoded data over various API's.
9+
The most custom format options are the JSON types. The following are common variants of sending JSON encoded data over various APIs.
1310

14-
The example payloads below, are all "prettified" for readability.
11+
The following example payloads are modified for readability.
1512

16-
_Records shown in example payloads, are the three first commits of the fluent-bit repository_
13+
Records shown in example payloads are the three first commits of the Fluent Bit repository.
1714

18-
### json
15+
### `json`
1916

20-
Queued records encoded as a single JSON array of JSON encoded fluent-bit records.
17+
Queued records encoded as a single JSON array of JSON encoded Fluent Bit records.
2118

2219
#### Example payload
2320

@@ -44,13 +41,13 @@ Queued records encoded as a single JSON array of JSON encoded fluent-bit records
4441
]
4542
```
4643

47-
### json_stream
44+
### `json_stream`
4845

4946
_a.k.a. Concatenated JSON_
5047

51-
Queued JSON-encoded fluent-bit records, with no separator between records.
48+
Queued JSON-encoded Fluent Bit records, with no separator between records.
5249

53-
#### Example payload
50+
#### Example `json_stream` payload
5451

5552
```json
5653
{
@@ -71,13 +68,13 @@ Queued JSON-encoded fluent-bit records, with no separator between records.
7168
}
7269
```
7370

74-
### json_lines
71+
### `json_lines`
7572

76-
_a.k.a. Newline-Delimited JSON_
73+
Also known as newline-delimited JSON.
7774

78-
Queued JSON-encoded fluent-bit records, separated by line-breaks (`\n`).
75+
Queued JSON-encoded Fluent Bit records, separated by line-breaks (`\n`).
7976

80-
#### Example payload
77+
#### Example `json_lines` payload
8178

8279
```json
8380
{
@@ -100,27 +97,23 @@ Queued JSON-encoded fluent-bit records, separated by line-breaks (`\n`).
10097
}
10198
```
10299

103-
## msgpack
100+
## `msgpack`
104101

105102
MessagePack is a binary format for serializing objects.
106103

107-
Please refer to the official MessagePack format specification, found here:
108-
https://github.com/msgpack/msgpack/blob/master/spec.md
104+
Refer to the official [MessagePack format specification](https://github.com/msgpack/msgpack/blob/master/spec.md).
109105

110106
## GELF
111107

112-
**G**raylog **E**xtended **L**og **F**ormat is a JSON based log format which is
113-
designed to avoid the shortcomings of classic plain syslog.
108+
Graylog Extended Log Format (GELF) is a JSON based log format which is designed to avoid the shortcomings of classic plain syslog.
114109

115-
The official documentation for the GELF format can be found here:
116-
https://archivedocs.graylog.org/en/latest/pages/gelf.html
110+
See the official documentation for the [GELF format](https://archivedocs.graylog.org/en/latest/pages/gelf.html).
117111

118-
It uses a fixed set of keys, with the addition of adding custom keys prefixed
119-
by one single underscore character.
112+
It uses a fixed set of keys, with the addition of adding custom keys prefixed by one single underscore character.
120113

121-
### Example payload
114+
### Example GELF payload
122115

123-
Here is an example payload, copied directly from the official docs (linked above)
116+
Here is an example payload, copied directly from the official documentation.
124117

125118
```json
126119
{

0 commit comments

Comments
 (0)