| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-memcached |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: memcached |
| 7 | monitored_instance: |
| 8 | name: Memcached |
| 9 | link: https://memcached.org/ |
| 10 | categories: |
| 11 | - data-collection.databases |
| 12 | icon_filename: "memcached.svg" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | keywords: |
| 19 | - memcached |
| 20 | - memcache |
| 21 | - cache |
| 22 | - database |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: "Monitor Memcached metrics for proficient in-memory key-value store operations. Track cache hits, misses, and memory usage for efficient data caching." |
| 26 | method_description: "It reads the server's response to the `stats` command." |
| 27 | supported_platforms: |
| 28 | include: [] |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: | |
| 36 | If no configuration is given, collector will attempt to connect to memcached instance on `127.0.0.1:11211` address. |
| 37 | limits: |
| 38 | description: "" |
| 39 | performance_impact: |
| 40 | description: "" |
| 41 | setup: |
| 42 | prerequisites: |
| 43 | list: |
| 44 | - title: UNIX socket access |
| 45 | description: | |
| 46 | If you are connecting to Memcached via its UNIX socket, ensure that the `netdata` user |
| 47 | has permission to access it. You can do this by: |
| 48 | |
| 49 | 1. Adding the `netdata` user to the `memcache` group. |
| 50 | ```bash |
| 51 | sudo gpasswd -a netdata memcache |
| 52 | ``` |
| 53 | 2. Configuring the socket permissions in `/etc/memcached.conf` so the group has access (e.g. `-a 770`). |
| 54 | |
| 55 | **Note**: You may need to restart Memcached after making these changes for them to take effect. |
| 56 | configuration: |
| 57 | file: |
| 58 | name: go.d/memcached.conf |
| 59 | options: |
| 60 | description: | |
| 61 | The following options can be defined globally: update_every, autodetection_retry. |
| 62 | folding: |
| 63 | title: Config options |
| 64 | enabled: true |
| 65 | list: |
| 66 | - name: update_every |
| 67 | description: Data collection interval (seconds). |
| 68 | default_value: 1 |
| 69 | required: false |
| 70 | group: Collection |
| 71 | - name: autodetection_retry |
| 72 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 73 | default_value: 0 |
| 74 | required: false |
| 75 | group: Collection |
| 76 | |
| 77 | - name: address |
| 78 | description: Memcached server address (`IP:PORT`). |
| 79 | default_value: 127.0.0.1:11211 |
| 80 | required: true |
| 81 | group: Target |
| 82 | - name: timeout |
| 83 | description: Connection, read, write, and name resolution timeout (seconds). |
| 84 | default_value: 1 |
| 85 | required: false |
| 86 | group: Target |
| 87 | |
| 88 | - name: vnode |
| 89 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 90 | default_value: "" |
| 91 | required: false |
| 92 | group: Virtual Node |
| 93 | examples: |
| 94 | folding: |
| 95 | title: Config |
| 96 | enabled: true |
| 97 | list: |
| 98 | - name: Basic |
| 99 | description: A basic example configuration. |
| 100 | config: | |
| 101 | jobs: |
| 102 | - name: local |
| 103 | address: 127.0.0.1:11211 |
| 104 | - name: Multi-instance |
| 105 | description: | |
| 106 | > **Note**: When you define multiple jobs, their names must be unique. |
| 107 | |
| 108 | Collecting metrics from local and remote instances. |
| 109 | config: | |
| 110 | jobs: |
| 111 | - name: local |
| 112 | address: 127.0.0.1:11211 |
| 113 | |
| 114 | - name: remote |
| 115 | address: 203.0.113.0:11211 |
| 116 | troubleshooting: |
| 117 | problems: |
| 118 | list: [] |
| 119 | alerts: |
| 120 | - name: memcached_cache_memory_usage |
| 121 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/memcached.conf |
| 122 | metric: memcached.cache |
| 123 | info: cache memory utilization |
| 124 | - name: memcached_cache_fill_rate |
| 125 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/memcached.conf |
| 126 | metric: memcached.cache |
| 127 | info: average rate the cache fills up (positive), or frees up (negative) space over the last hour |
| 128 | - name: memcached_out_of_cache_space_time |
| 129 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/memcached.conf |
| 130 | metric: memcached.cache |
| 131 | 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 |
| 132 | metrics: |
| 133 | folding: |
| 134 | title: Metrics |
| 135 | enabled: false |
| 136 | description: "" |
| 137 | availability: [] |
| 138 | scopes: |
| 139 | - name: global |
| 140 | description: "These metrics refer to the entire monitored application." |
| 141 | labels: [] |
| 142 | metrics: |
| 143 | - name: memcached.cache |
| 144 | description: Cache Size |
| 145 | unit: "MiB" |
| 146 | chart_type: stacked |
| 147 | dimensions: |
| 148 | - name: available |
| 149 | - name: used |
| 150 | - name: memcached.net |
| 151 | description: Network |
| 152 | unit: "kilobits/s" |
| 153 | chart_type: area |
| 154 | dimensions: |
| 155 | - name: in |
| 156 | - name: out |
| 157 | - name: memcached.connections |
| 158 | description: Connections |
| 159 | unit: "connections/s" |
| 160 | chart_type: line |
| 161 | dimensions: |
| 162 | - name: current |
| 163 | - name: rejected |
| 164 | - name: total |
| 165 | - name: memcached.items |
| 166 | description: Items |
| 167 | unit: "items" |
| 168 | chart_type: line |
| 169 | dimensions: |
| 170 | - name: current |
| 171 | - name: total |
| 172 | - name: memcached.evicted_reclaimed |
| 173 | description: Evicted and Reclaimed Items |
| 174 | unit: "items" |
| 175 | chart_type: line |
| 176 | dimensions: |
| 177 | - name: reclaimed |
| 178 | - name: evicted |
| 179 | - name: memcached.get |
| 180 | description: Get Requests |
| 181 | unit: "requests" |
| 182 | chart_type: stacked |
| 183 | dimensions: |
| 184 | - name: hints |
| 185 | - name: misses |
| 186 | - name: memcached.get_rate |
| 187 | description: Get Request Rate |
| 188 | unit: "requests/s" |
| 189 | chart_type: line |
| 190 | dimensions: |
| 191 | - name: rate |
| 192 | - name: memcached.set_rate |
| 193 | description: Set Request Rate |
| 194 | unit: "requests/s" |
| 195 | chart_type: line |
| 196 | dimensions: |
| 197 | - name: rate |
| 198 | - name: memcached.delete |
| 199 | description: Delete Requests |
| 200 | unit: "requests" |
| 201 | chart_type: stacked |
| 202 | dimensions: |
| 203 | - name: hits |
| 204 | - name: misses |
| 205 | - name: memcached.cas |
| 206 | description: Check and Set Requests |
| 207 | unit: "requests" |
| 208 | chart_type: stacked |
| 209 | dimensions: |
| 210 | - name: hits |
| 211 | - name: misses |
| 212 | - name: bad value |
| 213 | - name: memcached.increment |
| 214 | description: Increment Requests |
| 215 | unit: "requests" |
| 216 | chart_type: stacked |
| 217 | dimensions: |
| 218 | - name: hits |
| 219 | - name: misses |
| 220 | - name: memcached.decrement |
| 221 | description: Decrement Requests |
| 222 | unit: "requests" |
| 223 | chart_type: stacked |
| 224 | dimensions: |
| 225 | - name: hits |
| 226 | - name: misses |
| 227 | - name: memcached.touch |
| 228 | description: Touch Requests |
| 229 | unit: "requests" |
| 230 | chart_type: stacked |
| 231 | dimensions: |
| 232 | - name: hits |
| 233 | - name: misses |
| 234 | - name: memcached.touch_rate |
| 235 | description: Touch Request Rate |
| 236 | unit: "requests/s" |
| 237 | chart_type: line |
| 238 | dimensions: |
| 239 | - name: rate |