| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-pika |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: pika |
| 7 | monitored_instance: |
| 8 | name: Pika |
| 9 | link: https://github.com/OpenAtomFoundation/pika |
| 10 | icon_filename: pika.svg |
| 11 | categories: |
| 12 | - data-collection.databases |
| 13 | keywords: |
| 14 | - pika |
| 15 | - databases |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors Pika servers. |
| 25 | |
| 26 | It collects information and statistics about the server executing the following commands: |
| 27 | |
| 28 | - [`INFO ALL`](https://github.com/OpenAtomFoundation/pika/wiki/pika-info%E4%BF%A1%E6%81%AF%E8%AF%B4%E6%98%8E) |
| 29 | method_description: "" |
| 30 | supported_platforms: |
| 31 | include: [] |
| 32 | exclude: [] |
| 33 | multi_instance: true |
| 34 | additional_permissions: |
| 35 | description: "" |
| 36 | default_behavior: |
| 37 | auto_detection: |
| 38 | description: "" |
| 39 | limits: |
| 40 | description: "" |
| 41 | performance_impact: |
| 42 | description: "" |
| 43 | setup: |
| 44 | prerequisites: |
| 45 | list: [] |
| 46 | configuration: |
| 47 | file: |
| 48 | name: go.d/pika.conf |
| 49 | options: |
| 50 | description: | |
| 51 | The following options can be defined globally: update_every, autodetection_retry. |
| 52 | folding: |
| 53 | title: Config options |
| 54 | enabled: true |
| 55 | list: |
| 56 | - name: update_every |
| 57 | description: Data collection frequency (seconds). |
| 58 | default_value: 5 |
| 59 | required: false |
| 60 | group: Collection |
| 61 | - name: autodetection_retry |
| 62 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 63 | default_value: 0 |
| 64 | required: false |
| 65 | group: Collection |
| 66 | |
| 67 | - name: address |
| 68 | description: Pika server address. |
| 69 | default_value: redis://@localhost:9221 |
| 70 | required: true |
| 71 | group: Target |
| 72 | details: | |
| 73 | There are two connection types: by TCP socket and by Unix socket. |
| 74 | |
| 75 | - TCP connection: `redis://<user>:<password>@<host>:<port>/<db_number>` |
| 76 | - Unix connection: `unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>` |
| 77 | - name: timeout |
| 78 | description: Dial (establishing new connections), read (socket reads), and write (socket writes) timeout (seconds). |
| 79 | default_value: 1 |
| 80 | required: false |
| 81 | group: Target |
| 82 | |
| 83 | - name: username |
| 84 | description: Username for authentication. |
| 85 | default_value: "" |
| 86 | required: false |
| 87 | group: Auth |
| 88 | - name: password |
| 89 | description: Password for authentication. |
| 90 | default_value: "" |
| 91 | required: false |
| 92 | group: Auth |
| 93 | |
| 94 | - name: tls_skip_verify |
| 95 | description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. |
| 96 | default_value: false |
| 97 | required: false |
| 98 | group: TLS |
| 99 | - name: tls_ca |
| 100 | description: Certification authority that the client uses when verifying the server’s certificates. |
| 101 | default_value: "" |
| 102 | required: false |
| 103 | group: TLS |
| 104 | - name: tls_cert |
| 105 | description: Client TLS certificate. |
| 106 | default_value: "" |
| 107 | required: false |
| 108 | group: TLS |
| 109 | - name: tls_key |
| 110 | description: Client TLS key. |
| 111 | default_value: "" |
| 112 | required: false |
| 113 | group: TLS |
| 114 | |
| 115 | - name: vnode |
| 116 | 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). |
| 117 | default_value: "" |
| 118 | required: false |
| 119 | group: Virtual Node |
| 120 | examples: |
| 121 | folding: |
| 122 | title: Config |
| 123 | enabled: true |
| 124 | list: |
| 125 | - name: TCP socket |
| 126 | description: An example configuration. |
| 127 | config: | |
| 128 | jobs: |
| 129 | - name: local |
| 130 | address: 'redis://@localhost:9221' |
| 131 | - name: TCP socket with password |
| 132 | description: An example configuration. |
| 133 | config: | |
| 134 | jobs: |
| 135 | - name: local |
| 136 | address: 'redis://:password@127.0.0.1:9221' |
| 137 | - name: Multi-instance |
| 138 | description: | |
| 139 | > **Note**: When you define multiple jobs, their names must be unique. |
| 140 | |
| 141 | Local and remote instances. |
| 142 | config: | |
| 143 | jobs: |
| 144 | - name: local |
| 145 | address: 'redis://:password@127.0.0.1:9221' |
| 146 | |
| 147 | - name: remote |
| 148 | address: 'redis://user:password@203.0.113.0:9221' |
| 149 | troubleshooting: |
| 150 | problems: |
| 151 | list: [] |
| 152 | alerts: [] |
| 153 | metrics: |
| 154 | folding: |
| 155 | title: Metrics |
| 156 | enabled: false |
| 157 | description: "" |
| 158 | availability: [] |
| 159 | scopes: |
| 160 | - name: global |
| 161 | description: These metrics refer to the entire monitored application. |
| 162 | labels: [] |
| 163 | metrics: |
| 164 | - name: pika.connections |
| 165 | description: Connections |
| 166 | unit: connections |
| 167 | chart_type: line |
| 168 | dimensions: |
| 169 | - name: accepted |
| 170 | - name: pika.clients |
| 171 | description: Clients |
| 172 | unit: clients |
| 173 | chart_type: line |
| 174 | dimensions: |
| 175 | - name: connected |
| 176 | - name: pika.memory |
| 177 | description: Memory usage |
| 178 | unit: bytes |
| 179 | chart_type: area |
| 180 | dimensions: |
| 181 | - name: used |
| 182 | - name: pika.connected_replicas |
| 183 | description: Connected replicas |
| 184 | unit: replicas |
| 185 | chart_type: line |
| 186 | dimensions: |
| 187 | - name: connected |
| 188 | - name: pika.commands |
| 189 | description: Processed commands |
| 190 | unit: commands/s |
| 191 | chart_type: line |
| 192 | dimensions: |
| 193 | - name: processed |
| 194 | - name: pika.commands_calls |
| 195 | description: Calls per command |
| 196 | unit: calls/s |
| 197 | chart_type: stacked |
| 198 | dimensions: |
| 199 | - name: a dimension per command |
| 200 | - name: pika.database_strings_keys |
| 201 | description: Strings type keys per database |
| 202 | unit: keys |
| 203 | chart_type: stacked |
| 204 | dimensions: |
| 205 | - name: a dimension per database |
| 206 | - name: pika.database_strings_expires_keys |
| 207 | description: Strings type expires keys per database |
| 208 | unit: keys |
| 209 | chart_type: stacked |
| 210 | dimensions: |
| 211 | - name: a dimension per database |
| 212 | - name: pika.database_strings_invalid_keys |
| 213 | description: Strings type invalid keys per database |
| 214 | unit: keys |
| 215 | chart_type: stacked |
| 216 | dimensions: |
| 217 | - name: a dimension per database |
| 218 | - name: pika.database_hashes_keys |
| 219 | description: Hashes type keys per database |
| 220 | unit: keys |
| 221 | chart_type: stacked |
| 222 | dimensions: |
| 223 | - name: a dimension per database |
| 224 | - name: pika.database_hashes_expires_keys |
| 225 | description: Hashes type expires keys per database |
| 226 | unit: keys |
| 227 | chart_type: stacked |
| 228 | dimensions: |
| 229 | - name: a dimension per database |
| 230 | - name: pika.database_hashes_invalid_keys |
| 231 | description: Hashes type invalid keys per database |
| 232 | unit: keys |
| 233 | chart_type: stacked |
| 234 | dimensions: |
| 235 | - name: a dimension per database |
| 236 | - name: pika.database_lists_keys |
| 237 | description: Lists type keys per database |
| 238 | unit: keys |
| 239 | chart_type: stacked |
| 240 | dimensions: |
| 241 | - name: a dimension per database |
| 242 | - name: pika.database_lists_expires_keys |
| 243 | description: Lists type expires keys per database |
| 244 | unit: keys |
| 245 | chart_type: stacked |
| 246 | dimensions: |
| 247 | - name: a dimension per database |
| 248 | - name: pika.database_lists_invalid_keys |
| 249 | description: Lists type invalid keys per database |
| 250 | unit: keys |
| 251 | chart_type: stacked |
| 252 | dimensions: |
| 253 | - name: a dimension per database |
| 254 | - name: pika.database_zsets_keys |
| 255 | description: Zsets type keys per database |
| 256 | unit: keys |
| 257 | chart_type: stacked |
| 258 | dimensions: |
| 259 | - name: a dimension per database |
| 260 | - name: pika.database_zsets_expires_keys |
| 261 | description: Zsets type expires keys per database |
| 262 | unit: keys |
| 263 | chart_type: stacked |
| 264 | dimensions: |
| 265 | - name: a dimension per database |
| 266 | - name: pika.database_zsets_invalid_keys |
| 267 | description: Zsets type invalid keys per database |
| 268 | unit: keys |
| 269 | chart_type: stacked |
| 270 | dimensions: |
| 271 | - name: a dimension per database |
| 272 | - name: pika.database_sets_keys |
| 273 | description: Sets type keys per database |
| 274 | unit: keys |
| 275 | chart_type: stacked |
| 276 | dimensions: |
| 277 | - name: a dimension per database |
| 278 | - name: pika.database_sets_expires_keys |
| 279 | description: Sets type expires keys per database |
| 280 | unit: keys |
| 281 | chart_type: stacked |
| 282 | dimensions: |
| 283 | - name: a dimension per database |
| 284 | - name: pika.database_sets_invalid_keys |
| 285 | description: Sets invalid keys per database |
| 286 | unit: keys |
| 287 | chart_type: stacked |
| 288 | dimensions: |
| 289 | - name: a dimension per database |
| 290 | - name: pika.uptime |
| 291 | description: Uptime |
| 292 | unit: seconds |
| 293 | chart_type: line |
| 294 | dimensions: |
| 295 | - name: uptime |