Fluentd tracer (proto)

extensions.tracers.fluentd.v3.FluentdConfig

[extensions.tracers.fluentd.v3.FluentdConfig proto]

Configuration for the Fluentd tracer. This tracer extension will send the emitted traces over a TCP connection to an upstream that is accepting the Fluentd Forward Protocol as described in: Fluentd Forward Protocol Specification.

This extension has the qualified name envoy.tracers.fluentd

Note

This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

envoy.tracers

This extension must be configured with one of the following type URLs:

type.googleapis.com/envoy.extensions.tracers.fluentd.v3.FluentdConfig

{
  "cluster": ...,
  "tag": ...,
  "stat_prefix": ...,
  "buffer_flush_interval": {...},
  "buffer_size_bytes": {...},
  "retry_policy": {...}
}

cluster: (string, REQUIRED) The upstream cluster to connect to for streaming the Fluentd messages.

tag: (string, REQUIRED) A tag is a string separated with . (e.g. log.type) to categorize events. See: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#message-modes

stat_prefix: (string, REQUIRED) The prefix to use when emitting tracer stats.

buffer_flush_interval: (Duration) Interval for flushing traces to the TCP stream. Tracer will flush requests every time this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to 1 second.

buffer_size_bytes: (UInt32Value) Soft size limit in bytes for access log entries buffer. The logger will buffer requests until this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively disables the batching. Defaults to 16384.

retry_policy: (config.core.v3.RetryPolicy) Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied.