-
Notifications
You must be signed in to change notification settings - Fork 536
Add Parseable output plugin documentation #2034
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
Open
Debanitrkl
wants to merge
5
commits into
fluent:master
Choose a base branch
from
Debanitrkl:add-parseable-integration
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+156
−0
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
21ec3cd
Add Parseable output plugin documentation
Debanitrkl 624c7bf
Update pipeline/outputs/parseable.md
Debanitrkl 4bd663f
Update pipeline/outputs/parseable.md
Debanitrkl c04f030
Update pipeline/outputs/parseable.md
Debanitrkl f75b076
Update pipeline/outputs/parseable.md
Debanitrkl 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
--- | ||
description: Send logs, metrics, and traces to Parseable | ||
--- | ||
|
||
# Parseable | ||
|
||
Stream logs, metrics, and traces to [Parseable](https://www.parseable.com) by utilizing the [OpenTelemetry plugin](opentelemetry.md) to send telemetry data to Parseable's OpenTelemetry-compatible Ingestor endpoints. | ||
|
||
## Configuration parameters | ||
|
||
| Key | Description | Default | | ||
| -------------------------- | ----------- | ------- | | ||
| `host` | Your Parseable Ingestor hostname or IP address. | `parseable` | | ||
| `port` | TCP port of your Parseable Ingestor. | `8000` | | ||
| `http_user` | Username for HTTP basic authentication. | `admin` | | ||
| `http_passwd` | Password for HTTP basic authentication. | `admin` | | ||
| `header` | **Required headers for Parseable integration.** Must include `X-P-Stream` (stream name) and `X-P-Log-Source` (telemetry type: `otel-logs`, `otel-metrics`, or `otel-traces`). | **Required** | | ||
| `add_label` | Add custom labels to the telemetry data. | None | | ||
| `log_response_payload` | Log the response payload from the server for debugging. | `False` | | ||
| `metrics_uri` | Specify the HTTP URI for the target web server listening for metrics | `/v1/metrics` | | ||
| `logs_uri` | Specify the HTTP URI for the target web server listening for logs | `/v1/logs` | | ||
| `traces_uri` | Specify the HTTP URI for the target web server listening for traces | `/v1/traces` | | ||
| `tls` | Enable or disable TLS/SSL encryption. | `Off` | | ||
|
||
### TLS / SSL | ||
|
||
The OpenTelemetry output plugin supports TLS/SSL. For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md). | ||
|
||
## Get started | ||
|
||
To get started with sending telemetry data to Parseable: | ||
|
||
1. Ensure your Parseable Ingestor is running and accessible. | ||
2. Configure authentication credentials (username/password). | ||
3. In your main Fluent Bit configuration file append the following: | ||
Debanitrkl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
{% tabs %} | ||
{% tab title="fluent-bit.yaml" %} | ||
|
||
```yaml | ||
pipeline: | ||
outputs: | ||
# Send logs to Parseable | ||
- name: opentelemetry | ||
match: v1_logs | ||
host: parseable | ||
port: 8000 | ||
logs_uri: /v1/logs | ||
log_response_payload: true | ||
tls: off | ||
http_user: admin | ||
http_passwd: admin | ||
header: X-P-Stream otellogs | ||
header: X-P-Log-Source otel-logs | ||
add_label: app fluent-bit | ||
|
||
# Send metrics to Parseable | ||
- name: opentelemetry | ||
match: v1_metrics | ||
host: parseable | ||
port: 8000 | ||
metrics_uri: /v1/metrics | ||
log_response_payload: true | ||
tls: off | ||
http_user: admin | ||
http_passwd: admin | ||
header: X-P-Stream otelmetrics | ||
header: X-P-Log-Source otel-metrics | ||
add_label: app fluent-bit | ||
|
||
# Send traces to Parseable | ||
- name: opentelemetry | ||
match: v1_traces | ||
host: parseable | ||
port: 8000 | ||
traces_uri: /v1/traces | ||
log_response_payload: true | ||
tls: off | ||
http_user: admin | ||
http_passwd: admin | ||
header: X-P-Stream oteltraces | ||
header: X-P-Log-Source otel-traces | ||
add_label: app fluent-bit | ||
``` | ||
|
||
{% endtab %} | ||
{% tab title="fluent-bit.conf" %} | ||
|
||
```text | ||
# Send logs to Parseable | ||
[OUTPUT] | ||
Name opentelemetry | ||
Match v1_logs | ||
Host parseable | ||
Port 8000 | ||
Logs_uri /v1/logs | ||
Log_response_payload True | ||
Tls Off | ||
Http_User admin | ||
Http_Passwd admin | ||
Header X-P-Stream otellogs | ||
Header X-P-Log-Source otel-logs | ||
Add_label app fluent-bit | ||
|
||
# Send metrics to Parseable | ||
[OUTPUT] | ||
Name opentelemetry | ||
Match v1_metrics | ||
Host parseable | ||
Port 8000 | ||
Metrics_uri /v1/metrics | ||
Log_response_payload True | ||
Tls Off | ||
Http_User admin | ||
Http_Passwd admin | ||
Header X-P-Stream otelmetrics | ||
Header X-P-Log-Source otel-metrics | ||
Add_label app fluent-bit | ||
|
||
# Send traces to Parseable | ||
[OUTPUT] | ||
Name opentelemetry | ||
Match v1_traces | ||
Host parseable | ||
Port 8000 | ||
Traces_uri /v1/traces | ||
Log_response_payload True | ||
Tls Off | ||
Http_User admin | ||
Http_Passwd admin | ||
Header X-P-Stream oteltraces | ||
Header X-P-Log-Source otel-traces | ||
Add_label app fluent-bit | ||
``` | ||
|
||
{% endtab %} | ||
{% endtabs %} | ||
|
||
## Stream Configuration | ||
|
||
Parseable uses streams to organize your telemetry data. The `X-P-Stream` header specifies which stream the data should be sent to: | ||
|
||
- **otellogs**: Stream for log data | ||
- **otelmetrics**: Stream for metrics data | ||
- **oteltraces**: Stream for trace data | ||
Debanitrkl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The `X-P-Log-Source` header helps identify the source of the telemetry data for better organization and filtering. And this has to be set to `otel-logs`, `otel-metrics`, or `otel-traces` based on the telemetry type. | ||
Debanitrkl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Authentication | ||
|
||
Parseable supports HTTP basic authentication. Configure the `http_user` and `http_passwd` parameters with your Parseable server credentials. | ||
|
||
## References | ||
|
||
- [Parseable documentation](https://www.parseable.com/docs) | ||
- [Parseable Fluent-bit integration](https://www.parseable.com/docs/datasource/log-agents/fluent-bit) |
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.