-
Notifications
You must be signed in to change notification settings - Fork 548
in_prometheus_remote_write: Add documentation for input plugin of prometheus remote write #1363
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
ef3318e
in_prometheus_remote_write: Add documentation for input plugin of pro…
cosmo0920 150b669
Update pipeline/inputs/prometheus-remote-write.md
cosmo0920 3e9a93e
Address comments
cosmo0920 221c190
Use prometheus endpoint like example in a parameter description
cosmo0920 4d01d6d
in_prometheus_remote_write: Use 8080 as a default port number
cosmo0920 684be67
in_prometheus_remote_write: Add example TLS enabled configuration
cosmo0920 aced09e
in_prometheus_remote_write: Add more descriptions for prioritized con…
cosmo0920 609a0e1
Update pipeline/inputs/prometheus-remote-write.md
cosmo0920 0c1b199
transport-security: in_prometheus_remite_write: Add mention for trans…
cosmo0920 ed3089b
Apply suggestions
cosmo0920 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| description: An input plugin to ingest payloads of Prometheus remote write | ||
| --- | ||
|
|
||
| # Prometheus Remote Write | ||
|
|
||
| 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. | ||
|
|
||
| ## Configuration | ||
|
|
||
| | Key | Description | default | | ||
| | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | ||
| | listen | The address to listen on | 0.0.0.0 | | ||
| | port | The port for Fluent Bit to listen on | 8080 | | ||
| | buffer\_max\_size | Specify the maximum buffer size in KB to receive a JSON message. | 4M | | ||
| | buffer\_chunk\_size | This sets the chunk size for incoming incoming JSON messages. These chunks are then stored/managed in the space available by buffer_max_size. | 512K | | ||
| |successful\_response\_code | It allows to set successful response code. `200`, `201` and `204` are supported.| 201 | | ||
| | 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 | | ||
|
|
||
|
|
||
|
|
||
| A sample config file to get started will look something like the following: | ||
|
|
||
|
|
||
| {% tabs %} | ||
| {% tab title="fluent-bit.conf" %} | ||
| ``` | ||
| [INPUT] | ||
| name prometheus_remote_write | ||
| listen 127.0.0.1 | ||
| port 8080 | ||
| uri /api/prom/push | ||
|
|
||
| [OUTPUT] | ||
| name stdout | ||
| match * | ||
| ``` | ||
| {% endtab %} | ||
|
|
||
| {% tab title="fluent-bit.yaml" %} | ||
| ```yaml | ||
| pipeline: | ||
| inputs: | ||
| - name: prometheus_remote_write | ||
| listen: 127.0.0.1 | ||
| port: 8080 | ||
| uri: /api/prom/push | ||
| outputs: | ||
| - name: stdout | ||
| match: '*' | ||
| ``` | ||
| {% endtab %} | ||
| {% endtabs %} | ||
|
|
||
| With the above configuration, Fluent Bit will listen on port `8080` for data. | ||
| You can now send payloads in Prometheus remote write format to the endpoint `/api/prom/push`. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Communicate with TLS | ||
|
|
||
| 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. | ||
|
|
||
| Communicating with TLS, you will need to use the tls related parameters: | ||
cosmo0920 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ``` | ||
| [INPUT] | ||
| Name prometheus_remote_write | ||
| Listen 127.0.0.1 | ||
| Port 8080 | ||
| Uri /api/prom/push | ||
| Tls On | ||
| tls.crt_file /path/to/certificate.crt | ||
| tls.key_file /path/to/certificate.key | ||
| ``` | ||
|
|
||
| Now, you should be able to send data over TLS to the remote write input. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.