memcachedreceiver

README

Memcached Receiver

Status
Stability	beta
Supported pipeline types	metrics
Distributions	contrib

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.

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.

Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml with further documentation in documentation.md

Feature gate configurations

Transition from metrics with "direction" attribute

Some memcached metrics reported are transitioning from being reported with a direction attribute to being reported with the direction included in the metric name to adhere to the OpenTelemetry specification (https://github.com/open-telemetry/opentelemetry-specification/pull/2617):

• memcached.network will become:
  • memcached.network.sent
  • memcached.network.received

The following feature gates control the transition process:

• receiver.memcachedreceiver.emitMetricsWithoutDirectionAttribute: controls if the new metrics without direction attribute are emitted by the receiver.
• receiver.memcachedreceiver.emitMetricsWithDirectionAttribute: controls if the deprecated metrics with direction attribute are emitted by the receiver.

Transition schedule:

1. v0.56.0, July 2022:

• The new metrics are available for all scrapers, but disabled by default, they can be enabled with the feature gates.
• The old metrics with direction attribute are deprecated with a warning.
• receiver.memcachedreceiver.emitMetricsWithDirectionAttribute is enabled by default.
• receiver.memcachedreceiver.emitMetricsWithoutDirectionAttribute is disabled by default.

1. v0.58.0, August 2022:

• The new metrics are enabled by default, deprecated metrics disabled, they can be enabled with the feature gates.
• receiver.memcachedreceiver.emitMetricsWithDirectionAttribute is disabled by default.
• receiver.memcachedreceiver.emitMetricsWithoutDirectionAttribute is enabled by default.

1. v0.60.0, September 2022:

• The feature gates are removed.
• The new metrics without direction attribute are always emitted.
• The deprecated metrics with direction attribute are no longer available.

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"`
}