netdata/collectors/python.d.plugin/memcached/metadata.yaml

plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: memcached
      monitored_instance:
        name: Memcached
        link: https://memcached.org/
        categories:
          - data-collection.database-servers
        icon_filename: "memcached.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - memcached
        - memcache
        - cache
        - database
      most_popular: false
    overview:
      data_collection:
        metrics_description: "Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching."
        method_description: "It reads server response to stats command ([stats interface](https://github.com/memcached/memcached/wiki/Commands#stats))."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: true
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: |
            If no configuration is given, collector will attempt to connect to memcached instance on `127.0.0.1:11211` address.
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: python.d/memcached.conf
          description: ""
        options:
          description: |
            There are 2 sections:
            
            * Global variables
            * One or more JOBS that can define multiple different instances to monitor.
            
            The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
            
            Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
            
            Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
          folding:
            title: Config options
            enabled: true
          list:
            - name: host
              description: the host to connect to.
              default_value: "127.0.0.1"
              required: false
            - name: port
              description: the port to connect to.
              default_value: "11211"
              required: false
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 10
              required: false
            - name: priority
              description: Controls the order of charts at the netdata dashboard.
              default_value: 60000
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: penalty
              description: Indicates whether to apply penalty to update_every in case of failures.
              default_value: yes
              required: false
            - name: name
              description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
              default_value: ""
              required: false
        examples:
          folding:
            enabled: true
            title: "Config"
          list:
            - name: localhost
              description: An example configuration for localhost.
              folding:
                enabled: false
              config: |
                localhost:
                  name: 'local'
                  host: 'localhost'
                  port: 11211
            - name: localipv4
              description: An example configuration for localipv4.
              folding:
                enabled: true
              config: |
                localhost:
                  name: 'local'
                  host: '127.0.0.1'
                  port: 11211
            - name: localipv6
              description: An example configuration for localipv6.
              folding:
                enabled: true
              config: |
                localhost:
                  name: 'local'
                  host: '::1'
                  port: 11211
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: memcached_cache_memory_usage
        link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
        metric: memcached.cache
        info: cache memory utilization
      - name: memcached_cache_fill_rate
        link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
        metric: memcached.cache
        info: average rate the cache fills up (positive), or frees up (negative) space over the last hour
      - name: memcached_out_of_cache_space_time
        link: https://github.com/netdata/netdata/blob/master/health/health.d/memcached.conf
        metric: memcached.cache
        info: estimated time the cache will run out of space if the system continues to add data at the same rate as the past hour
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: memcached.cache
              description: Cache Size
              unit: "MiB"
              chart_type: stacked
              dimensions:
                - name: available
                - name: used
            - name: memcached.net
              description: Network
              unit: "kilobits/s"
              chart_type: area
              dimensions:
                - name: in
                - name: out
            - name: memcached.connections
              description: Connections
              unit: "connections/s"
              chart_type: line
              dimensions:
                - name: current
                - name: rejected
                - name: total
            - name: memcached.items
              description: Items
              unit: "items"
              chart_type: line
              dimensions:
                - name: current
                - name: total
            - name: memcached.evicted_reclaimed
              description: Evicted and Reclaimed Items
              unit: "items"
              chart_type: line
              dimensions:
                - name: reclaimed
                - name: evicted
            - name: memcached.get
              description: Get Requests
              unit: "requests"
              chart_type: stacked
              dimensions:
                - name: hints
                - name: misses
            - name: memcached.get_rate
              description: Get Request Rate
              unit: "requests/s"
              chart_type: line
              dimensions:
                - name: rate
            - name: memcached.set_rate
              description: Set Request Rate
              unit: "requests/s"
              chart_type: line
              dimensions:
                - name: rate
            - name: memcached.delete
              description: Delete Requests
              unit: "requests"
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
            - name: memcached.cas
              description: Check and Set Requests
              unit: "requests"
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
                - name: bad value
            - name: memcached.increment
              description: Increment Requests
              unit: "requests"
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
            - name: memcached.decrement
              description: Decrement Requests
              unit: "requests"
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
            - name: memcached.touch
              description: Touch Requests
              unit: "requests"
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
            - name: memcached.touch_rate
              description: Touch Request Rate
              unit: "requests/s"
              chart_type: line
              dimensions:
                - name: rate