Skip to content

Commit 439d699

Browse files
authored
Added missing config parameter and some general cleanup for http input plugin doc. Fixes #2266. (#2267)
Fixed the following: - missing http2 config parameter - sort config parameter table - standardize example configurations Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 9abf597 commit 439d699

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

pipeline/inputs/http.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ The _HTTP_ input plugin lets Fluent Bit open an HTTP port that you can then rout
77

88
| Key | Description | Default |
99
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|-----------|
10+
| `buffer_chunk_size` | This sets the chunk size for incoming JSON messages. These chunks are then stored and managed in the space available by `buffer_max_size`. | `512K` |
11+
| `buffer_max_size` | Specify the maximum buffer size to receive a JSON message. | `4M` |
12+
| `http2` | Enable HTTP/2 support. | `true` |
1013
| `listen` | The address to listen on. | `0.0.0.0` |
1114
| `port` | The port for Fluent Bit to listen on. | `9880` |
15+
| `success_header` | Add an HTTP header key/value pair on success. Multiple headers can be set. For example, `X-Custom custom-answer`. | _none_ |
16+
| `successful_response_code` | Allows setting successful response code. Supported values: `200`, `201`, and `204`. | `201` |
1217
| `tag_key` | Specify the key name to overwrite a tag. If set, the tag will be overwritten by a value of the key. | _none_ |
13-
| `buffer_max_size` | Specify the maximum buffer size in KB to receive a JSON message. | `4M` |
14-
| `buffer_chunk_size` | This sets the chunk size for incoming JSON messages. These chunks are then stored and managed in the space available by `buffer_max_size`. | `512K` |
15-
| `successful_response_code` | Allows setting successful response code. Supported values: `200`, `201`, and `204` | `201` |
16-
| `success_header` | Add an HTTP header key/value pair on success. Multiple headers can be set. For example, `X-Custom custom-answer` | _none_ |
1718
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1819

1920
### TLS / SSL
@@ -34,7 +35,7 @@ This plugin supports dynamic tags which let you send data with different tags th
3435

3536
The tag for the HTTP input plugin is set by adding the tag to the end of the request URL. This tag is then used to route the event through the system.
3637

37-
For example, in the following curl message the tag set is `app.log**. **` because the end path is `/app_log`:
38+
For example, in the following curl message the tag set is `app.log` because the end path is `/app.log`:
3839

3940
```shell
4041
curl -d '{"key1":"value1","key2":"value2"}' -XPOST -H "content-type: application/json" http://localhost:8888/app.log
@@ -62,13 +63,13 @@ pipeline:
6263
6364
```text
6465
[INPUT]
65-
name http
66-
listen 0.0.0.0
67-
port 8888
66+
Name http
67+
Listen 0.0.0.0
68+
Port 8888
6869

6970
[OUTPUT]
70-
name stdout
71-
match app.log
71+
Name stdout
72+
Match app.log
7273
```
7374

7475
{% endtab %}
@@ -102,13 +103,13 @@ pipeline:
102103
103104
```text
104105
[INPUT]
105-
name http
106-
listen 0.0.0.0
107-
port 8888
106+
Name http
107+
Listen 0.0.0.0
108+
Port 8888
108109

109110
[OUTPUT]
110-
name stdout
111-
match http.0
111+
Name stdout
112+
Match http.0
112113
```
113114

114115
{% endtab %}
@@ -147,14 +148,14 @@ pipeline:
147148
148149
```text
149150
[INPUT]
150-
name http
151-
listen 0.0.0.0
152-
port 8888
153-
tag_key key1
151+
Name http
152+
Listen 0.0.0.0
153+
Port 8888
154+
Tag_Key key1
154155

155156
[OUTPUT]
156-
name stdout
157-
match value1
157+
Name stdout
158+
Match value1
158159
```
159160

160161
{% endtab %}
@@ -181,9 +182,9 @@ pipeline:
181182
182183
```text
183184
[INPUT]
184-
name http
185-
success_header X-Custom custom-answer
186-
success_header X-Another another-answer
185+
Name http
186+
Success_Header X-Custom custom-answer
187+
Success_Header X-Another another-answer
187188
```
188189

189190
{% endtab %}
@@ -217,13 +218,13 @@ pipeline:
217218
218219
```text
219220
[INPUT]
220-
name http
221-
listen 0.0.0.0
222-
port 8888
221+
Name http
222+
Listen 0.0.0.0
223+
Port 8888
223224

224225
[OUTPUT]
225-
name stdout
226-
match *
226+
Name stdout
227+
Match *
227228
```
228229

229230
{% endtab %}
@@ -232,5 +233,5 @@ pipeline:
232233
### Command line
233234

234235
```shell
235-
fluent-bit -i http -p port=8888 -o stdout
236+
fluent-bit -i http -p port=8888 -o stdout
236237
```

0 commit comments

Comments
 (0)