package
3.65.0
Repository: https://github.com/jeffail/benthos.git
Documentation: pkg.go.dev

# Functions

Combine returns a Type implementation that feeds metrics into two underlying Type implementations.
Descriptions returns a formatted string of collated descriptions of each type.
Namespaced embeds an existing metrics aggregator under a new namespace.
New creates a metric output type based on a configuration.
NewAWSCloudWatch creates and returns a new CloudWatch object.
NewBlacklist creates and returns a new Blacklist object.
NewBlacklistConfig returns the default configuration for a Blacklist.
NewCloudWatch creates and returns a new CloudWatch object.
NewCloudWatchConfig creates an CloudWatchConfig struct with default values.
NewConfig returns a configuration struct fully populated with default values.
NewHTTP creates and returns a new HTTP object.
NewHTTPConfig returns a new HTTPConfig with default values.
NewInfluxDB creates and returns a new InfluxDB object.
NewInfluxDBConfig creates an InfluxDBConfig struct with default values.
NewLocal creates and returns a new Local aggregator.
NewPrometheus creates and returns a new Prometheus object.
NewPrometheusConfig creates an PrometheusConfig struct with default values.
NewPrometheusPushBasicAuthConfig creates a new NewPrometheusPushBasicAuthConfig with default values.
NewRename creates and returns a new Rename object.
NewRenameConfig returns a RenameConfig with default values.
NewStatsd creates and returns a new Statsd object.
NewStatsdConfig creates an StatsdConfig struct with default values.
NewStatsdLegacy creates and returns a new StatsdLegacy object.
NewStdout creates and returns a new Stdout metric object.
NewStdoutConfig returns a new StdoutConfig with default values.
NewWhitelist creates and returns a new Whitelist object.
NewWhitelistConfig returns the default configuration for a whitelist.
Noop returns a DudType for discarding metrics.
OptSetLogger sets the logging output to be used by the metrics clients.
SanitiseConfig returns a sanitised version of the Config, meaning sections that aren't relevant to behaviour are removed.
WalkConstructors iterates each component constructor.
WrapFlat creates a Type around a Flat implementation.

# Constants

Tag formats supported by the statsd metric type.
Tag formats supported by the statsd metric type.
Tag formats supported by the statsd metric type.
Tag formats supported by the statsd metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.
String constants representing each metric type.

# Variables

Constructors is a map of all metrics types with their specs.
Errors for the metrics package.
Errors for the HTTP type.

# Structs

Blacklist is a statistics object that wraps a separate statistics object and only permits statistics that pass through the Blacklist to be recorded.
BlacklistConfig allows for the placement of filtering rules to only allow metrics that are not matched to be displayed or retrieved.
CloudWatch is a stats object with capability to hold internal stats as a JSON endpoint.
CloudWatchConfig contains config fields for the CloudWatch metrics type.
Config is the all encompassing configuration struct for all metric output types.
DudStat implements the Stat interface but doesn't actual do anything.
DudType implements the Type interface but doesn't actual do anything.
HTTP is an object with capability to hold internal stats as a JSON endpoint.
HTTPConfig contains configuration parameters for the HTTP metrics aggregator.
InfluxDB is the stats and client holder.
InfluxDBConfig is config for the influx metrics type.
InfluxDBInclude contains configuration parameters for optional metrics to include.
Local is a metrics aggregator that stores metrics locally.
LocalStat is a representation of a single metric stat.
PromCounter is a representation of a single metric stat.
PromCounterVec creates StatCounters with dynamic labels.
Prometheus is a stats object with capability to hold internal stats as a JSON endpoint.
PrometheusConfig is config for the Prometheus metrics type.
PrometheusPushBasicAuthConfig contains parameters for establishing basic authentication against a push service.
PromGauge is a representation of a single metric stat.
PromGaugeVec creates StatGauges with dynamic labels.
PromTiming is a representation of a single metric stat.
PromTimingHistVec creates StatTimers with dynamic labels.
PromTimingVec creates StatTimers with dynamic labels.
Rename is a statistics object that wraps a separate statistics object and only permits statistics that pass through the whitelist to be recorded.
RenameByRegexpConfig contains config fields for a rename by regular expression pattern.
RenameConfig contains config fields for the Rename metric type.
Statsd is a stats object with capability to hold internal stats as a JSON endpoint.
StatsdConfig is config for the Statsd metrics type.
StatsdLegacy is a stats object with capability to hold internal stats as a JSON endpoint.
StatsdLegacyStat is a representation of a single metric stat.
StatsdStat is a representation of a single metric stat.
Stdout is an object with capability to hold internal stats and emit them as individual JSON objects via stdout.
StdoutConfig contains configuration parameters for the Stdout metrics aggregator.
TypeSpec is a constructor and a usage description for each metric output type.
Whitelist is a statistics object that wraps a separate statistics object and only permits statistics that pass through the whitelist to be recorded.
WhitelistConfig allows for the placement of filtering rules to only allow select metrics to be displayed or retrieved.

# Interfaces

Flat is an interface for setting metrics via flat paths.
StatCounter is a representation of a single counter metric stat.
StatCounterVec creates StatCounters with dynamic labels.
StatGauge is a representation of a single gauge metric stat.
StatGaugeVec creates StatGauges with dynamic labels.
StatTimer is a representation of a single timer metric stat.
StatTimerVec creates StatTimers with dynamic labels.
Type is an interface for metrics aggregation.
WithHandlerFunc is an interface for metrics types that can expose their metrics through an HTTP HandlerFunc endpoint.

# Type aliases

ConstructorFunc is a func signature able to construct a metrics output.