Documentation forAppOptics

Memcached

Overview

Memcached is a free, very fast and distributed memory object caching system.

This plugin is currently available for x86_64 Linux and Windows platforms.

Setup

The memcached plugin is included with the SolarWinds Snap Agent by default, please follow the directions below to enable it for a agent instance.

Prerequisites

This plugin requires that Memcached is running and its stats endpoint API is available from the host where the plugin runs. The integration supports connecting via local/remote URI.

Configuration

The agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for your Memcached instance. To enable the plugin:

  1. Make a copy of the memcached example configuration file memcached.yaml.example, renaming it to memcached.yaml:

    On Linux using command line:

    Copy
    $ sudo cp /opt/SolarWinds/Snap/etc/plugins.d/memcached.yaml.example /opt/SolarWinds/Snap/etc/plugins.d/memcached.yaml

    On Windows, using Explorer or PowerShell:

    Copy
    > copy "C:\ProgramData\SolarWinds\Snap\plugins.d\memcached.yaml.example" "C:\ProgramData\SolarWinds\Snap\plugins.d\memcached.yaml"
  2. Update memcached.yaml configuration file with settings specific to your Memcached instance for example:

    Copy
    collector:
      memcached:
        all:
          # List of memcached instances endpoints. By default, text protocol is used.
          # If you want to use binary protocol, prepend address with binary| keyword.
          # Please note, that binary protocol does not support all metrics that text protocol does.
          endpoints: |
            127.0.0.1:11211
            binary|192.168.0.1:11211

    The setting endpoint (required): contains a list of memcached endpoints to monitor. Each endpoint can be connected via text (default) or binary protocol.

  3. Restart the agent:

    On Windows command line:

    Copy
    > net stop swisnapd
    > net start swisnapd

    On Linux command line:

    Copy
    $ sudo service swisnapd restart
  4. Enable the Memcached plugin in the AppOptics UI

    On the Integrations Page you will see the Memcached plugin available if the previous steps were successful. If you do not see the plugin, see Troubleshooting Linux.

    Select the Memcached plugin to open the configuration menu in the UI, and enable the plugin.

    You should soon see the memcached metrics reported to your dashboard.

Metrics and Tags

Memcached plugin can collect most of the metrics that are provided by Memcached. For a full list and descriptions of metrics, please refer to stats command documentation. The plugin provides metrics:

Namespace Description Tags
memcached.<general_purpose_stats> general purpose statistics as defined for stats command endpoint, memcached version
memcached.settings.<settings_stats> settings statistics as defined for stats settings command endpoint, memcached version
memcached.items.<items_stats> items statistics as defined for stats items command endpoint, memcached version, slabclass
memcached.slabs.<stabs_stats> slabs statistics as defined for stats slabs command endpoint, memcached version, slabclass
memcached.connection.<connection_stats> connection statistics as defined for stats conn command endpoint, memcached version, file descriptor, address

The endpoint tag is the endpoint address of Memcached instance. The memcached version tag is version of Memcached instance. The slabclass tag is corresponding slabclass. The file descriptor tag is corresponding connection file descriptor. The address tag is corresponding connection local or remote address.

When the APM Integrated Experience is enabled, AppOptics shares a common navigation and settings with the other integrated experiences' products. How you navigate AppOptics and access its features may vary from these instructions. For more information, go to the APM Integrated Experience documentation.