Skip to content

Commit 21ec3cd

Browse files
DebanitrklDebanitrkl
committed
Add Parseable output plugin documentation
- Add comprehensive documentation for Parseable integration using OpenTelemetry plugin - Include configuration parameters table with required headers (X-P-Stream, X-P-Log-Source) - Provide examples for logs, metrics, and traces in both YAML and classic config formats - Document stream configuration and authentication setup - Add references to Parseable documentation and Fluent Bit integration guide Signed-off-by: Debanitrkl <[email protected]>
1 parent bf69b7e commit 21ec3cd

File tree

1 file changed

+156
-0
lines changed

1 file changed

+156
-0
lines changed

‎pipeline/outputs/parseable.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
description: Send logs, metrics, and traces to Parseable
3+
---
4+
5+
# Parseable
6+
7+
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.
8+
9+
## Configuration parameters
10+
11+
| Key | Description | Default |
12+
| -------------------------- | ----------- | ------- |
13+
| `host` | Your Parseable Ingestor hostname or IP address. | `parseable` |
14+
| `port` | TCP port of your Parseable Ingestor. | `8000` |
15+
| `http_user` | Username for HTTP basic authentication. | `admin` |
16+
| `http_passwd` | Password for HTTP basic authentication. | `admin` |
17+
| `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** |
18+
| `add_label` | Add custom labels to the telemetry data. | None |
19+
| `log_response_payload` | Log the response payload from the server for debugging. | `False` |
20+
| `metrics_uri` | Specify the HTTP URI for the target web server listening for metrics | `/v1/metrics` |
21+
| `logs_uri` | Specify the HTTP URI for the target web server listening for logs | `/v1/logs` |
22+
| `traces_uri` | Specify the HTTP URI for the target web server listening for traces | `/v1/traces` |
23+
| `tls` | Enable or disable TLS/SSL encryption. | `Off` |
24+
25+
### TLS / SSL
26+
27+
The OpenTelemetry output plugin supports TLS/SSL. For more details about the properties available and general configuration, see [TLS/SSL](../../administration/transport-security.md).
28+
29+
## Get started
30+
31+
To get started with sending telemetry data to Parseable:
32+
33+
1. Ensure your Parseable Ingestor is running and accessible.
34+
2. Configure authentication credentials (username/password).
35+
3. In your main Fluent Bit configuration file append the following:
36+
37+
{% tabs %}
38+
{% tab title="fluent-bit.yaml" %}
39+
40+
```yaml
41+
pipeline:
42+
outputs:
43+
# Send logs to Parseable
44+
- name: opentelemetry
45+
match: v1_logs
46+
host: parseable
47+
port: 8000
48+
logs_uri: /v1/logs
49+
log_response_payload: true
50+
tls: off
51+
http_user: admin
52+
http_passwd: admin
53+
header: X-P-Stream otellogs
54+
header: X-P-Log-Source otel-logs
55+
add_label: app fluent-bit
56+
57+
# Send metrics to Parseable
58+
- name: opentelemetry
59+
match: v1_metrics
60+
host: parseable
61+
port: 8000
62+
metrics_uri: /v1/metrics
63+
log_response_payload: true
64+
tls: off
65+
http_user: admin
66+
http_passwd: admin
67+
header: X-P-Stream otelmetrics
68+
header: X-P-Log-Source otel-metrics
69+
add_label: app fluent-bit
70+
71+
# Send traces to Parseable
72+
- name: opentelemetry
73+
match: v1_traces
74+
host: parseable
75+
port: 8000
76+
traces_uri: /v1/traces
77+
log_response_payload: true
78+
tls: off
79+
http_user: admin
80+
http_passwd: admin
81+
header: X-P-Stream oteltraces
82+
header: X-P-Log-Source otel-traces
83+
add_label: app fluent-bit
84+
```
85+
86+
{% endtab %}
87+
{% tab title="fluent-bit.conf" %}
88+
89+
```text
90+
# Send logs to Parseable
91+
[OUTPUT]
92+
Name opentelemetry
93+
Match v1_logs
94+
Host parseable
95+
Port 8000
96+
Logs_uri /v1/logs
97+
Log_response_payload True
98+
Tls Off
99+
Http_User admin
100+
Http_Passwd admin
101+
Header X-P-Stream otellogs
102+
Header X-P-Log-Source otel-logs
103+
Add_label app fluent-bit
104+
105+
# Send metrics to Parseable
106+
[OUTPUT]
107+
Name opentelemetry
108+
Match v1_metrics
109+
Host parseable
110+
Port 8000
111+
Metrics_uri /v1/metrics
112+
Log_response_payload True
113+
Tls Off
114+
Http_User admin
115+
Http_Passwd admin
116+
Header X-P-Stream otelmetrics
117+
Header X-P-Log-Source otel-metrics
118+
Add_label app fluent-bit
119+
120+
# Send traces to Parseable
121+
[OUTPUT]
122+
Name opentelemetry
123+
Match v1_traces
124+
Host parseable
125+
Port 8000
126+
Traces_uri /v1/traces
127+
Log_response_payload True
128+
Tls Off
129+
Http_User admin
130+
Http_Passwd admin
131+
Header X-P-Stream oteltraces
132+
Header X-P-Log-Source otel-traces
133+
Add_label app fluent-bit
134+
```
135+
136+
{% endtab %}
137+
{% endtabs %}
138+
139+
## Stream Configuration
140+
141+
Parseable uses streams to organize your telemetry data. The `X-P-Stream` header specifies which stream the data should be sent to:
142+
143+
- **otellogs**: Stream for log data
144+
- **otelmetrics**: Stream for metrics data
145+
- **oteltraces**: Stream for trace data
146+
147+
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.
148+
149+
## Authentication
150+
151+
Parseable supports HTTP basic authentication. Configure the `http_user` and `http_passwd` parameters with your Parseable server credentials.
152+
153+
## References
154+
155+
- [Parseable documentation](https://www.parseable.com/docs)
156+
- [Parseable Fluent-bit integration](https://www.parseable.com/docs/datasource/log-agents/fluent-bit)

0 commit comments

Comments
 (0)