output

Documentation

Index

• Variables
• func Description(async, batches bool, content string) string
• func GetMaxInFlight(o interface{}) (int, bool)
• func MetadataFields() docs.FieldSpecs
• type Metadata
  • func NewMetadata() Metadata
  • func (m Metadata) Filter() (*MetadataFilter, error)
• type MetadataFilter
  • func (f *MetadataFilter) Iter(m types.Metadata, fn func(k, v string) error) error

Variables

var InjectTracingSpanMappingDocs = docs.FieldBloblang(
	"inject_tracing_map",
	"EXPERIMENTAL: A [Bloblang mapping](/docs/guides/bloblang/about) used to inject an object containing tracing propagation information into outbound messages. The specification of the injected fields will match the format used by the service wide tracer.",
	`meta = meta().merge(this)`,
	`root.meta.span = this`,
).AtVersion("3.45.0").Advanced()

InjectTracingSpanMappingDocs returns a field spec describing an inject tracing span mapping.

Functions

func Description

func Description(async, batches bool, content string) string

Description appends standard feature descriptions to an output description based on various features of the output.

func GetMaxInFlight

func GetMaxInFlight(o interface{}) (int, bool)

GetMaxInFlight attempts to derive a max in flight value from the provided output, and returns the count and a boolean flag indicating whether the output provided that value. This value can be used to determine a sensible value for parent outputs, but should not be relied upon as part of dispatcher logic.

func MetadataFields

func MetadataFields() docs.FieldSpecs

MetadataFields returns a docs spec for the fields within a metadata config struct.

Types

type Metadata

type Metadata struct {
	ExcludePrefixes []string `json:"exclude_prefixes" yaml:"exclude_prefixes"`
}

Metadata describes actions to be performed on message metadata before being sent to an output destination.

func NewMetadata

func NewMetadata() Metadata

NewMetadata returns a Metadata configuration struct with default values.

func (Metadata) Filter

func (m Metadata) Filter() (*MetadataFilter, error)

Filter attempts to construct a metadata filter.

type MetadataFilter

type MetadataFilter struct {
	// contains filtered or unexported fields
}

MetadataFilter provides a way to filter metadata keys based on a Metadata config.

func (*MetadataFilter) Iter

func (f *MetadataFilter) Iter(m types.Metadata, fn func(k, v string) error) error

Iter applies a function to each metadata key value pair that passes the filter.