|
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 remote write 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. |
8 | 8 |
|
9 |
| -## Configuration |
| 9 | +## Configuration parameters |
10 | 10 |
|
11 |
| -| Key | Description | default | |
12 |
| -| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- | |
13 |
| -| listen | The address to listen on | 0.0.0.0 | |
14 |
| -| 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 | 22 | A sample config file to get started will look something like the following:
|
23 | 23 |
|
@@ -55,16 +55,15 @@ pipeline:
|
55 | 55 | {% endtab %}
|
56 | 56 | {% endtabs %}
|
57 | 57 |
|
58 |
| -With the above configuration, Fluent Bit will listen on port `8080` for data. |
59 |
| -You can now send payloads in Prometheus remote write format to the endpoint `/api/prom/push`. |
| 58 | +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`. |
60 | 59 |
|
61 | 60 | ## Examples
|
62 | 61 |
|
63 | 62 | ### Communicate with TLS
|
64 | 63 |
|
65 |
| -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. |
| 64 | +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. |
66 | 65 |
|
67 |
| -Communicating with TLS, you will need to use the tls related parameters: |
| 66 | +To communicate with TLS, you must use these TLS-related parameters: |
68 | 67 |
|
69 | 68 | {% tabs %}
|
70 | 69 | {% tab title="fluent-bit.yaml" %}
|
@@ -98,4 +97,4 @@ pipeline:
|
98 | 97 | {% endtab %}
|
99 | 98 | {% endtabs %}
|
100 | 99 |
|
101 |
| -Now, you should be able to send data over TLS to the remote write input. |
| 100 | +Now, you should be able to send data over TLS to the remote-write input. |
0 commit comments