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: pipeline/inputs/prometheus-remote-write.md
+19-20Lines changed: 19 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,26 +2,26 @@
2
2
description: An input plugin to ingest payloads of Prometheus remote write
3
3
---
4
4
5
-
# Prometheus Remote Write
5
+
# Prometheus remote write
6
6
7
-
This input plugin allows you to ingest a payload in the Prometheus remote-write format, i.e. a remotewrite sender can transmit data to Fluent Bit.
7
+
The _Prometheus remote write_input plugin lets you ingest a payload in the Prometheus remote-write format. A remote-write sender can transmit data to Fluent Bit.
| port| The port for Fluent Bit to listen on|8080|
15
-
|buffer\_max\_size | Specify the maximum buffer size in KB to receive a JSON message. | 4M |
16
-
|buffer\_chunk\_size|This sets the chunk size for incoming JSON messages. These chunks are then stored/managed in the space available by buffer_max_size. |512K|
17
-
|successful\_response\_code | It allows to set successful response code. `200`, `201` and `204` are supported.| 201 |
18
-
|tag\_from\_uri | If true, tag will be created from uri, e.g. api\_prom\_push from /api/prom/push, and any tag specified in the config will be ignored. If false then a tag must be provided in the config for this input. | true|
19
-
| uri| Specify an optional HTTP URI for the target web server listening for prometheus remote write payloads, e.g: /api/prom/push||
20
-
| threaded |Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). |`false`|
11
+
| Key | Description | Default|
12
+
| --- | ----------- | ------- |
13
+
|`listen`| The address to listen on. |`0.0.0.0`|
14
+
|`port`| The port to listen on. |`8080`|
15
+
|`buffer_max_size`| Specifies the maximum buffer size in KB to receive a JSON message. |`4M`|
16
+
|`buffer_chunk_size`|Sets the chunk size for incoming JSON messages. These chunks are then stored and managed in the space specified by `buffer_max_size`. |`512K`|
17
+
|`successful_response_code`| Specifies the success response code. Supported values are `200`, `201`, and `204`.|`201`|
18
+
|`tag_from_uri`| If true, a tag will be created from the `uri` parameter (for example, `api_prom_push`from `/api/prom/push`), and any tag specified in the configuration will be ignored. If false, you must provide a tag in the configuration for this plugin. |`true`|
19
+
|`uri`| Specifies an optional HTTP URI for the target web server listening for Prometheus remote write payloads (for example, `/api/prom/push`). |_none_|
20
+
|`threaded`|Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). |`false`|
21
21
22
+
## Configuration file
22
23
23
-
A sample config file to get started will look something like the following:
24
-
24
+
The following examples are sample configuration files for this input plugin:
25
25
26
26
{% tabs %}
27
27
{% tab title="fluent-bit.conf" %}
@@ -53,16 +53,15 @@ pipeline:
53
53
{% endtab %}
54
54
{% endtabs %}
55
55
56
-
With the above configuration, Fluent Bit will listen on port `8080` for data.
57
-
You can now send payloads in Prometheus remote write format to the endpoint `/api/prom/push`.
56
+
These sample configurations configure Fluent Bit to listen for data on port `8080`. You can send payloads in Prometheus remote-write format to the endpoint `/api/prom/push`.
58
57
59
58
## Examples
60
59
61
60
### Communicate with TLS
62
61
63
-
Prometheus Remote Write input plugin supports TLS/SSL, for more details about the properties available and general configuration, please refer to the [TLS/SSL](../../administration/transport-security.md) section.
62
+
Prometheus Remote Write input plugin supports TLS and SSL. For more details about the properties available and general configuration, refer to the [Transport security](../../administration/transport-security.md) documentation.
64
63
65
-
Communicating with TLS, you will need to use the tls related parameters:
64
+
To communicate with TLS, you must use these TLS-related parameters:
66
65
67
66
```
68
67
[INPUT]
@@ -75,4 +74,4 @@ Communicating with TLS, you will need to use the tls related parameters:
75
74
tls.key_file /path/to/certificate.key
76
75
```
77
76
78
-
Now, you should be able to send data over TLS to the remotewrite input.
77
+
Now, you should be able to send data over TLS to the remote-write input.
0 commit comments