Skip to content

Commit e144fda

Browse files
esmerelesmerel
committed
Pipeline: output: opentelemetry: style
Signed-off-by: Lynette Miles <[email protected]>
1 parent f416a90 commit e144fda

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

‎pipeline/outputs/opentelemetry.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,42 @@ description: An output plugin to submit Logs, Metrics, or Traces to an OpenTelem
44

55
# OpenTelemetry
66

7-
The OpenTelemetry plugin allows you to take logs, metrics, and traces from Fluent Bit and submit them to an OpenTelemetry HTTP endpoint.
8-
9-
Important Note: At the moment only HTTP endpoints are supported.
10-
11-
| Key | Description | Default |
12-
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
13-
| host | IP address or hostname of the target HTTP Server | 127.0.0.1 |
14-
| http_user | Basic Auth Username | |
15-
| http_passwd | Basic Auth Password. Requires HTTP_user to be set | |
16-
| port | TCP port of the target HTTP Server | 80 |
17-
| proxy | Specify an HTTP Proxy. The expected format of this value is `http://HOST:PORT`. Note that HTTPS is **not** currently supported. It is recommended not to set this and to configure the [HTTP proxy environment variables](https://docs.fluentbit.io/manual/administration/http-proxy) instead as they support both HTTP and HTTPS. | |
18-
| http2 | Defines whether HTTP/2 protocol is enabled. This setting also supports the `force` option, which forces HTTP/2 over a plaintext connection. | On |
19-
| grpc | Enables gRPC over an HTTP/2 connection. This setting applies to HTTP/2 only. | off |
20-
| metrics_uri | Specify an optional HTTP URI for the target web server listening for metrics, e.g: /v1/metrics | / |
21-
| logs_uri | Specify an optional HTTP URI for the target web server listening for logs, e.g: /v1/logs | / |
22-
| traces_uri | Specify an optional HTTP URI for the target web server listening for traces, e.g: /v1/traces | / |
23-
| header | Add a HTTP header key/value pair. Multiple headers can be set. | |
24-
| log_response_payload | Log the response payload within the Fluent Bit log | false |
25-
| logs_body_key | The log body key to look up in the log events body/message. Sets the Body field of the opentelemtry logs data model. | message |
26-
| logs_trace_id_message_key | The trace id key to look up in the log events body/message. Sets the TraceId field of the opentelemtry logs data model. | traceId |
27-
| logs_span_id_message_key | The span id key to look up in the log events body/message. Sets the SpanId field of the opentelemtry logs data model. | spanId |
28-
| logs_severity_text_message_key | The severity text id key to look up in the log events body/message. Sets the SeverityText field of the opentelemtry logs data model. | severityText |
29-
| logs_severity_number_message_key | The severity number id key to look up in the log events body/message. Sets the SeverityNumber field of the opentelemtry logs data model. | severityNumber |
30-
| add_label | This allows you to add custom labels to all metrics exposed through the OpenTelemetry exporter. You may have multiple of these fields | |
31-
| compress | Set payload compression mechanism. Option available is 'gzip' | |
32-
| logs_observed_timestamp_metadata_key | Specify an ObservedTimestamp key to look up in the metadata. | $ObservedKey |
33-
| logs_timestamp_metadata_key | Specify a Timestamp key to look up in the metadata. | $Timestamp |
34-
| logs_severity_key_metadata_key | Specify a SeverityText key to look up in the metadata. | $SeverityText |
35-
| logs_severity_number_metadata_key | Specify a SeverityNumber key to look up in the metadata. | $SeverityNumber |
36-
| logs_trace_flags_metadata_key | Specify a Flags key to look up in the metadata. | $Flags |
37-
| logs_span_id_metadata_key | Specify a SpanId key to look up in the metadata. | $SpanId |
38-
| logs_trace_id_metadata_key | Specify a TraceId key to look up in the metadata. | $TraceId |
39-
| logs_attributes_metadata_key | Specify an Attributes key to look up in the metadata. | $Attributes |
40-
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
41-
42-
## Getting Started
7+
The OpenTelemetry plugin lets you take logs, metrics, and traces from Fluent Bit and submit them to an OpenTelemetry HTTP endpoint.
8+
9+
Only HTTP endpoints are supported.
10+
11+
| Key | Description | Default |
12+
|-----|-------------|---------|
13+
| `host`| IP address or hostname of the target HTTP server. | `127.0.0.1` |
14+
| `http_user` | Basic Auth username. | _none_ |
15+
| `http_passwd` | Basic Auth password. Requires `HTTP_user` to be set. | _none_ |
16+
| `port` | TCP port of the target HTTP server. | `80` |
17+
| `proxy` | Specify an HTTP Proxy. The expected format value is `http://HOST:PORT`. HTTPS isn't supported. It's recommended to configure the [HTTP proxy environment variables](https://docs.fluentbit.io/manual/administration/http-proxy) instead as they support both HTTP and HTTPS. | _none_ |
18+
| `http2` | Defines whether HTTP/2 protocol is enabled. This setting also supports the `force` option, which forces HTTP/2 over a plain text connection. | `On` |
19+
| `grpc` | Enables gRPC over an HTTP/2 connection. This setting applies to HTTP/2 only. | `off` |
20+
| `metrics_uri` | Specify an optional HTTP URI for the target web server listening for metrics. For example, `/v1/metrics`. | `/` |
21+
| `logs_uri` | Specify an optional HTTP URI for the target web server listening for logs, For example, `/v1/logs`. | `/` |
22+
| `traces_uri` | Specify an optional HTTP URI for the target web server listening for traces, For example, `/v1/traces`. | `/` |
23+
| `header` | Add a HTTP header key/value pair. Multiple headers can be set. | _none_ |
24+
| `log_response_payload` | Log the response payload within the Fluent Bit log. | `false` |
25+
| `logs_body_key` | The log body key to look up in the log events body/message. Sets the `Body` field of the OpenTelemetry logs data model. | `message` |
26+
| `logs_trace_id_message_key` | The trace id key to look up in the log events body/message. Sets the `TraceId` field of the OpenTelemetry logs data model. | `traceId` |
27+
| `logs_span_id_message_key` | The span id key to look up in the log events body/message. Sets the `SpanId` field of the OpenTelemetry logs data model. | `spanId` |
28+
| `logs_severity_text_message_key` | The severity text id key to look up in the log events body/message. Sets the `SeverityText` field of the OpenTelemetry logs data model. | `severityText` |
29+
| `logs_severity_number_message_key` | The severity number id key to look up in the log events body/message. Sets the `SeverityNumber` field of the OpenTelemetry logs data model. | `severityNumber` |
30+
| `add_label` | Lets you add custom labels to all metrics exposed through the OpenTelemetry exporter. You can have multiple of these fields. | _none_ |
31+
| `compress` | Set payload compression mechanism. Allowed value: 'gzip'. | _none_ |
32+
| `logs_observed_timestamp_metadata_key` | Specify an `ObservedTimestamp` key to look up in the metadata. | `$ObservedKey` |
33+
| `logs_timestamp_metadata_key` | Specify a `Timestamp` key to look up in the metadata. | `$Timestamp` |
34+
| `logs_severity_key_metadata_key` | Specify a `SeverityText` key to look up in the metadata. | `$SeverityText` |
35+
| `logs_severity_number_metadata_key` | Specify a `SeverityNumber` key to look up in the metadata. | `$SeverityNumber` |
36+
| `logs_trace_flags_metadata_key` | Specify a `Flags` key to look up in the metadata. | `$Flags` |
37+
| `logs_span_id_metadata_key` | Specify a `SpanId` key` to look up in the metadata. | `$SpanId` |
38+
| `logs_trace_id_metadata_key` | Specify a `TraceId` key to look up in the metadata. | `$TraceId` |
39+
| `logs_attributes_metadata_key` | Specify an `Attributes` key to look up in the metadata. | `$Attributes` |
40+
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
41+
42+
## Get started
4343

4444
The OpenTelemetry plugin works with logs and only the metrics collected from one of the metric input plugins. In the following example, log records generated by the dummy plugin and the host metrics collected by the node exporter metrics plugin are exported by the OpenTelemetry output plugin.
4545

@@ -55,17 +55,17 @@ The OpenTelemetry plugin works with logs and only the metrics collected from one
5555
service:
5656
flush: 1
5757
log_level: info
58-
58+
5959
pipeline:
6060
inputs:
6161
- name: node_exporter_metrics
6262
tag: node_metrics
6363
scrape_interval: 2
64-
64+
6565
- name: dummy
6666
tag: dummy.log
6767
rate: 3
68-
68+
6969
- name: event_type
7070
type: traces
7171

@@ -86,7 +86,7 @@ pipeline:
8686
logs_severity_text_message_key: loglevel
8787
logs_severity_number_message_key: lognum
8888
# add user-defined labels
89-
add_label:
89+
add_label:
9090
- app fluent-bit
9191
- color blue
9292
```
@@ -140,4 +140,4 @@ pipeline:
140140
```
141141

142142
{% endtab %}
143-
{% endtabs %}
143+
{% endtabs %}

0 commit comments

Comments
 (0)