OpenTelemetry

—

== description: An output plugin to submit Logs, Metrics, or Traces to an OpenTelemetry endpoint

= OpenTelemetry

The OpenTelemetry plugin lets you take logs, metrics, and traces from Fluent Bit and submit them to an OpenTelemetry HTTP endpoint.

Only HTTP endpoints are supported.

Key	Description	Default
add_label	Adds a custom label to the metrics use format: add_label name value.	none
alias	Sets an alias, useful for multiple instances of the same output plugin.	none
aws_auth	Enable AWS SigV4 authentication.	false
aws_external_id	Specify an external ID for the STS API, can be used with the aws_role_arn parameter.	none
aws_profile	AWS Profile name. AWS Profiles can be configured with AWS CLI.	none
aws_region	AWS region of your service.	none
aws_role_arn	ARN of an IAM role to assume (ex. for cross account access).	none
aws_service	AWS destination service code, used by SigV4 authentication.	logs
aws_sts_endpoint	Custom endpoint for the AWS STS API, used with the aws_role_arn option.	none
grpc	Enable, disable or force gRPC usage. Accepted values : on, off, auto.	off
batch_size	Set the maximum number of log records to be flushed at a time.	1000
compress	Set payload compression mechanism. Options available are gzip and zstd.	none
grpc_logs_uri	Specify an optional gRPCß URI for the target OTel endpoint.	/opentelemetry.proto.collector.logs.v1.LogsService/Export
grpc_metrics_uri	Specify an optional gRPC URI for the target OTel endpoint.	/opentelemetry.proto.collector.metrics.v1.MetricsService/Export
grpc_profiles_uri	Specify an optional gRPC URI for profiles OTel endpoint.	/opentelemetry.proto.collector.profiles.v1experimental.ProfilesService/Export
grpc_traces_uri	Specify an optional gRPC URI for the target OTel endpoint.	/opentelemetry.proto.collector.trace.v1.TraceService/Export
header	Add a HTTP header key/value pair. Multiple headers can be set.	none
host	IP address or hostname of the target HTTP server.	127.0.0.1
http2	Enable, disable or force HTTP/2 usage. Accepted values : on, off, or force.	off
http_passwd	Set HTTP auth password.	none
http_user	Set HTTP auth user.	none
log_level	Specifies the log level for output plugin. If not set here, plugin uses global log level in service section.	info
logs_attributes_metadata_key	Specify an Attributes key.	$Attributes
logs_body_key	Specify an optional HTTP URI for the target OTel endpoint.	none
logs_body_key_attributes	If set and it matched a pattern, it includes the remaining fields in the record as attributes.	false
logs_instrumentation_scope_metadata_key	Specify an InstrumentationScope key.	InstrumentationScope
logs_observed_timestamp_metadata_key	Specify an ObservedTimestamp key.	$ObservedTimestamp
logs_max_resources	Set the maximum number of OTLP log resources per export request (0 disables the limit).	0
logs_max_scopes	Set the maximum number of OTLP log scopes per resource (0 disables the limit).	0
logs_metadata_key	Set the key to lookup in the metadata.	otlp
logs_resource_metadata_key	Specify a Resource key.	Resource
log_response_payload	Specify if the response payload should be logged or not.	true
logs_severity_number_message_key	Specify a SeverityNumber key.	$severityNumber
logs_severity_number_metadata_key	Specify a SeverityNumber key.	$SeverityNumber
logs_severity_text_message_key	Specify a SeverityText key.	$SeverityText
log_severity_text_metadata_key	Specify a SeverityText key.	$SeverityText
log_supress_interval	Suppresses log messages from output plugin that appear similar within a specified time interval. 0 no suppression.	0
logs_span_id_message_key	Specify a SpanId key.	$SpanId
logs_span_id_metadata_key	Specify a SpanId key.	$SpanId
logs_timestamp_metadata_key	Specify a Timestamp key.	$Timestamp
logs_trace_flags_metadata_key	Specify a TraceFlags key.	$TraceFlags
logs_trace_id_message_key	Specify a TraceId key.	$TraceId
logs_trace_id_metadata_key	Specify a TraceId key.	$TraceId
logs_uri	Specify an optional HTTP URI for the target OTel endpoint.	/v1/logs
match	Set a tag pattern to match records that output should process. Exact matches or wildcards (for example *).	none
match_regex	Set a regular expression to match tags for output routing. This allows more flexible matching compared to simple wildcards.	none
metrics_uri	Specify an optional HTTP URI for the target OTel endpoint.	/v1/metrics
net.connect_timeout	Set maximum time allowed to establish a connection, this time includes the TLS handshake.	10s
net.connect_timeout_log_error	On connection timeout, specify if it should log an error. When disabled, the timeout is logged as a debug message.	true
net.keepalive_max_recycle	Set maximum number of times a keepalive connection can be used before it is retried.	2000
net.dns.mode	Select the primary DNS connection type (TCP or UDP).	none
net.dns.prefer_ipv4	Select the primary DNS resolver type (LEGACY or ASYNC).	none
net.dns.prefer_ipv6	Prioritize IPv6 DNS results when trying to establish a connection.	none
net.io_timeout	Set maximum time a connection can stay idle while assigned.	0s
net.max_worker_connections	Set the maximum number of active TCP connections that can be used per worker thread.	0
net.proxy_env_ignore	Ignore the environment variables HTTP_PROXY, HTTPS_PROXY and NO_PROXY when set.	false
net.source_address	Specify network address to bind for data traffic.	none
net.tcp_keepalive	Enable or disable Keepalive support.	off
net.tcp_keepalive_time	Interval between the last data packet sent and the first TCP keepalive probe.	-1
net.tcp_keepalive_interval	Interval between TCP keepalive probes when no response is received on a keepidle probe.	-1
net.tcp_keepalive_probes	Number of unacknowledged probes to consider a connection dead.	-1
port	TCP port of the target HTTP server.	80
profiles_uri	Specify an optional HTTP URI for the profiles OTel endpoint.	/v1development/profiles
proxy	Specify an HTTP Proxy. The expected format of this value is http://host:port.	none
retry_limit	Set retry limit for output plugin when delivery fails. Integer, no_limits, false, or off to disable, or no_retries to disable retries entirely.	1
tls	Enable or disable TLS/SSL support.	off
tls.ca_file	Absolute path to CA certificate file.	none
tls.ca_path	Absolute path to scan for certificate files.	none
tls.cert_file	Absolute path to Certificate file.	none
tls.ciphers	Specify TLS ciphers up to TLSv1.2.	none
tls.debug	Set TLS debug level. Accepts 0 (No debug), 1(Error), 2 (State change), 3 (Informational) and 4 (Verbose).	1
tls.key_file	Absolute path to private Key file.	none
tls.key_passwd	Optional password for tls.key_file file.	none
tls.max_version	Specify the maximum version of TLS.	none
tls.min_version	Specify the minimum version of TLS.	none
tls.verify_hostname	Enable or disable to verify hostname.	off
tls.vhost	Hostname to be used for TLS SNI extension.	none
tls.verify	Force certificate validation.	on
tls.windows.certstore_name	Sets the certstore name on an output (Windows).	none
tls.windows.use_enterprise_store	Sets whether using enterprise certstore or not on an output (Windows).	none
traces_uri	Specify an optional HTTP URI for the target OTel endpoint.	/v1/traces

== Get started

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.

fluent-bit.yaml

[source,yaml]

Dummy Logs and traces with Node Exporter Metrics export using OpenTelemetry output plugin

-------------------------------------------

The following example collects host metrics on Linux and dummy logs and traces and delivers

them through the OpenTelemetry plugin to a local collector :

service: flush: 1 log_level: info

pipeline: inputs: - name: node_exporter_metrics tag: node_metrics scrape_interval: 2

- name: dummy
  tag: dummy.log
  rate: 3

- name: event_type
  type: traces

outputs: - name: opentelemetry match: "*" host: localhost port: 443 metrics_uri: /v1/metrics logs_uri: /v1/logs traces_uri: /v1/traces log_response_payload: true tls: on tls.verify: off logs_body_key: $message logs_span_id_message_key: span_id logs_trace_id_message_key: trace_id logs_severity_text_message_key: loglevel logs_severity_number_message_key: lognum # add user-defined labels add_label: - app fluent-bit - color blue

fluent-bit.conf