plugins

README

Plugins

Veneur supports the use of plugins to flush data to multiple destinations. For example, the S3 plugin can be used to archive data to S3 while also flushing to Datadog.

Plugins may not carry the same stability guarantees as the rest of Veneur. For information on a specific plugin, consult the documentation for that particular plugin.

For more information on writing your own flushing plugin for Veneur, see the package documentation.

Documentation

Index

• type Plugin

Types

type Plugin

type Plugin interface {
	Flush(ctx context.Context, metrics []samplers.InterMetric) error
	Name() string
}

Plugin flushes the metrics provided to an arbitrary destination. The metrics slice may be shared between plugins, so the plugin may not write to it or modify any of its components. The name should be a short, lowercase, snake-cased identifier for the plugin. When a plugin is registered, the number of metrics flushed successfully and the number of errors encountered are automatically reported by veneur, using the plugin name.