Skip to content

Commit a969db2

Browse files
Merge pull request #1842 from fluent/alexakreizinger/sc-136196/update-fluent-bit-docs-pipeline-inputs-prometheus
2 parents c651427 + 8668a50 commit a969db2

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

pipeline/inputs/prometheus-remote-write.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
description: An input plugin to ingest payloads of Prometheus remote write
33
---
44

5-
# Prometheus Remote Write
5+
# Prometheus remote write
66

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.
88

9-
## Configuration
9+
## Configuration parameters
1010

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` |
2121

2222
A sample config file to get started will look something like the following:
2323

@@ -55,16 +55,15 @@ pipeline:
5555
{% endtab %}
5656
{% endtabs %}
5757

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`.
6059

6160
## Examples
6261

6362
### Communicate with TLS
6463

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.
6665

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:
6867

6968
{% tabs %}
7069
{% tab title="fluent-bit.yaml" %}
@@ -98,4 +97,4 @@ pipeline:
9897
{% endtab %}
9998
{% endtabs %}
10099

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

Comments
 (0)