package
2.15.1+incompatible
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.
NewBlacklist creates and returns a new Blacklist object.
NewBlacklistConfig returns the default configuration for a Blacklist.
NewConfig returns a configuration struct fully populated with default values.
NewHTTP creates and returns a new HTTP object.
NewLocal creates and returns a new Local aggregator.
NewPrometheus creates and returns a new Prometheus object.
NewPrometheusConfig creates an PrometheusConfig struct 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.
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.
WrapFlat creates a Type around a Flat implementation.
# Constants
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.
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.
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.
PromGauge is a representation of a single metric stat.
PromGaugeVec creates StatGauges with dynamic labels.
PromTiming is a representation of a single metric stat.
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.
StatsdStat is a representation of a single metric stat.
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.