Documentation
¶
Index ¶
- Constants
- func NewClientMetrics(component string, reg prometheus.Registerer, enableKafkaHistograms bool) *kprom.Metrics
- func NewReaderClient(component string, kafkaCfg kafka.Config, logger log.Logger, ...) (*kgo.Client, error)
- func NewWriterClient(component string, kafkaCfg kafka.Config, maxInflightProduceRequests int, ...) (*kgo.Client, error)
- func WrapPrometheusRegisterer(component string, reg prometheus.Registerer) prometheus.Registerer
- type Producer
Constants ¶
const (
MetricsPrefix = "loki_kafka_client"
)
Variables ¶
This section is empty.
Functions ¶
func NewClientMetrics ¶ added in v3.6.0
func NewClientMetrics(component string, reg prometheus.Registerer, enableKafkaHistograms bool) *kprom.Metrics
NewClientMetrics returns a new instance of `kprom.Metrics` (used to monitor Kafka interactions), provided the `MetricsPrefix` as the `Namespace` for the default set of Prometheus metrics
func NewReaderClient ¶
func NewReaderClient(component string, kafkaCfg kafka.Config, logger log.Logger, reg prometheus.Registerer, opts ...kgo.Opt) (*kgo.Client, error)
NewReaderClient returns the kgo.Client that should be used by the Reader.
The returned Client utilizes the standard set of *kprom.Metrics, prefixed with `MetricsPrefix`
func NewWriterClient ¶
func NewWriterClient(component string, kafkaCfg kafka.Config, maxInflightProduceRequests int, logger log.Logger, reg prometheus.Registerer) (*kgo.Client, error)
NewWriterClient returns the kgo.Client that should be used by the Writer.
The returned Client collects the standard set of *kprom.Metrics, prefixed with `MetricsPrefix`
func WrapPrometheusRegisterer ¶ added in v3.6.0
func WrapPrometheusRegisterer(component string, reg prometheus.Registerer) prometheus.Registerer
WrapPrometheusRegisterer returns a prometheus.Registerer with labels applied
This Registerer is used internally by the reader/writer Kafka clients to collect *kprom.Metrics (or any custom metrics passed by a calling service)
Types ¶
type Producer ¶
Producer is a kgo.Client wrapper exposing some higher level features and metrics useful for producers.
func NewProducer ¶
func NewProducer(component string, client *kgo.Client, maxBufferedBytes int64, reg prometheus.Registerer) *Producer
NewProducer returns a new KafkaProducer.
The input prometheus.Registerer must be wrapped with a prefix (the names of metrics registered don't have a prefix).
func (*Producer) ProduceSync ¶
ProduceSync produces records to Kafka and returns once all records have been successfully committed, or an error occurred.
This function honors the configure max buffered bytes and refuse to produce a record, returnin kgo.ErrMaxBuffered, if the configured limit is reached.