memcachedreceiver

README

Memcached Receiver

This receiver can fetch stats from a Memcached instance using the stats command. A detailed description of all the stats available is at https://github.com/memcached/memcached/blob/master/doc/protocol.txt#L1159.

🚧 This receiver is currently in BETA.

Details

Configuration

ℹ This receiver is in beta and configuration fields are subject to change.

The following settings are required:

• endpoint (default: localhost:11211): The hostname/IP address and port or, unix socket file path of the memcached instance

The following settings are optional:

• collection_interval (default = 10s): This receiver runs on an interval. Each time it runs, it queries memcached, creates metrics, and sends them to the next consumer. The collection_interval configuration option tells this receiver the duration between runs. This value must be a string readable by Golang's ParseDuration function (example: 1h30m). Valid time units are ns, us (or µs), ms, s, m, h.

Example:

receivers:
  memcached:
    endpoint: "localhost:11211"
    collection_interval: 10s

The full list of settings exposed for this receiver are documented here with detailed sample configurations here.

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a factory for memcached receiver.

Types

type Config

type Config struct {
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	confignet.NetAddr                       `mapstructure:",squash"`

	// Timeout for the memcache stats request
	Timeout time.Duration `mapstructure:"timeout"`

	// Metrics allows customizing scraped metrics representation.
	Metrics metadata.MetricsSettings `mapstructure:"metrics"`
}