Skip to content

Latest commit

 

History

History
 
 

memcachedreceiver

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
internal/metadata
internal/metadata
 
 
testdata
testdata
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
client.go
client.go
 
 
client_mock_test.go
client_mock_test.go
 
 
config.go
config.go
 
 
config_test.go
config_test.go
 
 
doc.go
doc.go
 
 
documentation.md
documentation.md
 
 
factory.go
factory.go
 
 
factory_test.go
factory_test.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
integration_test.go
integration_test.go
 
 
metadata.yaml
metadata.yaml
 
 
scraper.go
scraper.go
 
 
scraper_test.go
scraper_test.go
 
 

README.md

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 (open-telemetry/opentelemetry-specification#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.