Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
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 ¶
Description appends standard feature descriptions to an output description based on various features of the output.
Types ¶
type Streamed ¶
type Streamed interface {
// Consume starts the type receiving transactions from a Transactor.
Consume(<-chan message.Transaction) error
// Connected returns a boolean indicating whether this output is currently
// connected to its target.
Connected() bool
// CloseAsync triggers the shut down of this component but should not block
// the calling goroutine.
CloseAsync()
// WaitForClose is a blocking call to wait until the component has finished
// shutting down and cleaning up resources.
WaitForClose(timeout time.Duration) error
}
Streamed is a common interface implemented by outputs and provides channel based streaming APIs.
type Sync ¶
type Sync interface {
// WriteTransaction attempts to write a transaction to an output.
WriteTransaction(context.Context, message.Transaction) error
// Connected returns a boolean indicating whether this output is currently
// connected to its target.
Connected() bool
// CloseAsync triggers the shut down of this component but should not block
// the calling goroutine.
CloseAsync()
// WaitForClose is a blocking call to wait until the component has finished
// shutting down and cleaning up resources.
WaitForClose(timeout time.Duration) error
}
Sync is a common interface implemented by outputs and provides synchronous based writing APIs.
Source Files
Click to show internal directories.
Click to hide internal directories.