github.com/netdata/go.d.plugin@v0.58.1/modules/proxysql/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-proxysql 5 plugin_name: go.d.plugin 6 module_name: proxysql 7 monitored_instance: 8 name: ProxySQL 9 link: https://www.proxysql.com/ 10 icon_filename: proxysql.png 11 categories: 12 - data-collection.database-servers 13 keywords: 14 - proxysql 15 - databases 16 - sql 17 related_resources: 18 integrations: 19 list: [] 20 info_provided_to_referring_integrations: 21 description: "" 22 most_popular: false 23 overview: 24 data_collection: 25 metrics_description: | 26 This collector monitors ProxySQL servers. 27 method_description: "" 28 supported_platforms: 29 include: [] 30 exclude: [] 31 multi_instance: true 32 additional_permissions: 33 description: "" 34 default_behavior: 35 auto_detection: 36 description: "" 37 limits: 38 description: "" 39 performance_impact: 40 description: "" 41 setup: 42 prerequisites: 43 list: [] 44 configuration: 45 file: 46 name: go.d/proxysql.conf 47 options: 48 description: | 49 The following options can be defined globally: update_every, autodetection_retry. 50 folding: 51 title: Config options 52 enabled: true 53 list: 54 - name: update_every 55 description: Data collection frequency. 56 default_value: 5 57 required: false 58 - name: autodetection_retry 59 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 60 default_value: 0 61 required: false 62 - name: dsn 63 description: Data Source Name. See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name). 64 default_value: stats:stats@tcp(127.0.0.1:6032)/ 65 required: true 66 - name: my.cnf 67 description: Specifies my.cnf file to read connection parameters from under the [client] section. 68 default_value: "" 69 required: false 70 - name: timeout 71 description: Query timeout in seconds. 72 default_value: 1 73 required: false 74 examples: 75 folding: 76 title: Config 77 enabled: true 78 list: 79 - name: TCP socket 80 description: An example configuration. 81 config: | 82 jobs: 83 - name: local 84 dsn: stats:stats@tcp(127.0.0.1:6032)/ 85 - name: my.cnf 86 description: An example configuration. 87 config: | 88 jobs: 89 - name: local 90 my.cnf: '/etc/my.cnf' 91 - name: Multi-instance 92 description: | 93 > **Note**: When you define multiple jobs, their names must be unique. 94 95 Local and remote instances. 96 config: | 97 jobs: 98 - name: local 99 dsn: stats:stats@tcp(127.0.0.1:6032)/ 100 101 - name: remote 102 dsn: stats:stats@tcp(203.0.113.0:6032)/ 103 troubleshooting: 104 problems: 105 list: [] 106 alerts: [] 107 metrics: 108 folding: 109 title: Metrics 110 enabled: false 111 description: "" 112 availability: [] 113 scopes: 114 - name: global 115 description: These metrics refer to the entire monitored application. 116 labels: [] 117 metrics: 118 - name: proxysql.client_connections_count 119 description: Client connections 120 unit: connections 121 chart_type: line 122 dimensions: 123 - name: connected 124 - name: non_idle 125 - name: hostgroup_locked 126 - name: proxysql.client_connections_rate 127 description: Client connections rate 128 unit: connections/s 129 chart_type: line 130 dimensions: 131 - name: created 132 - name: aborted 133 - name: proxysql.server_connections_count 134 description: Server connections 135 unit: connections 136 chart_type: line 137 dimensions: 138 - name: connected 139 - name: proxysql.server_connections_rate 140 description: Server connections rate 141 unit: connections/s 142 chart_type: line 143 dimensions: 144 - name: created 145 - name: aborted 146 - name: delayed 147 - name: proxysql.backends_traffic 148 description: Backends traffic 149 unit: B/s 150 chart_type: line 151 dimensions: 152 - name: recv 153 - name: sent 154 - name: proxysql.clients_traffic 155 description: Clients traffic 156 unit: B/s 157 chart_type: line 158 dimensions: 159 - name: recv 160 - name: sent 161 - name: proxysql.active_transactions_count 162 description: Client connections that are currently processing a transaction 163 unit: connections 164 chart_type: line 165 dimensions: 166 - name: client 167 - name: proxysql.questions_rate 168 description: Client requests / statements executed 169 unit: questions/s 170 chart_type: line 171 dimensions: 172 - name: questions 173 - name: proxysql.slow_queries_rate 174 description: Slow queries 175 unit: queries/s 176 chart_type: line 177 dimensions: 178 - name: slow 179 - name: proxysql.queries_rate 180 description: Queries rate 181 unit: queries/s 182 chart_type: stacked 183 dimensions: 184 - name: autocommit 185 - name: autocommit_filtered 186 - name: commit_filtered 187 - name: rollback 188 - name: rollback_filtered 189 - name: backend_change_user 190 - name: backend_init_db 191 - name: backend_set_names 192 - name: frontend_init_db 193 - name: frontend_set_names 194 - name: frontend_use_db 195 - name: proxysql.backend_statements_count 196 description: Statements available across all backend connections 197 unit: statements 198 chart_type: line 199 dimensions: 200 - name: total 201 - name: unique 202 - name: proxysql.backend_statements_rate 203 description: Statements executed against the backends 204 unit: statements/s 205 chart_type: stacked 206 dimensions: 207 - name: prepare 208 - name: execute 209 - name: close 210 - name: proxysql.client_statements_count 211 description: Statements that are in use by clients 212 unit: statements 213 chart_type: line 214 dimensions: 215 - name: total 216 - name: unique 217 - name: proxysql.client_statements_rate 218 description: Statements executed by clients 219 unit: statements/s 220 chart_type: stacked 221 dimensions: 222 - name: prepare 223 - name: execute 224 - name: close 225 - name: proxysql.cached_statements_count 226 description: Global prepared statements 227 unit: statements 228 chart_type: line 229 dimensions: 230 - name: cached 231 - name: proxysql.query_cache_entries_count 232 description: Query Cache entries 233 unit: entries 234 chart_type: line 235 dimensions: 236 - name: entries 237 - name: proxysql.query_cache_memory_used 238 description: Query Cache memory used 239 unit: B 240 chart_type: line 241 dimensions: 242 - name: used 243 - name: proxysql.query_cache_io 244 description: Query Cache I/O 245 unit: B/s 246 chart_type: line 247 dimensions: 248 - name: in 249 - name: out 250 - name: proxysql.query_cache_requests_rate 251 description: Query Cache requests 252 unit: requests/s 253 chart_type: line 254 dimensions: 255 - name: read 256 - name: write 257 - name: read_success 258 - name: proxysql.mysql_monitor_workers_count 259 description: MySQL monitor workers 260 unit: threads 261 chart_type: line 262 dimensions: 263 - name: workers 264 - name: auxiliary 265 - name: proxysql.mysql_monitor_workers_rate 266 description: MySQL monitor workers rate 267 unit: workers/s 268 chart_type: line 269 dimensions: 270 - name: started 271 - name: proxysql.mysql_monitor_connect_checks_rate 272 description: MySQL monitor connect checks 273 unit: checks/s 274 chart_type: line 275 dimensions: 276 - name: succeed 277 - name: failed 278 - name: proxysql.mysql_monitor_ping_checks_rate 279 description: MySQL monitor ping checks 280 unit: checks/s 281 chart_type: line 282 dimensions: 283 - name: succeed 284 - name: failed 285 - name: proxysql.mysql_monitor_read_only_checks_rate 286 description: MySQL monitor read only checks 287 unit: checks/s 288 chart_type: line 289 dimensions: 290 - name: succeed 291 - name: failed 292 - name: proxysql.mysql_monitor_replication_lag_checks_rate 293 description: MySQL monitor replication lag checks 294 unit: checks/s 295 chart_type: line 296 dimensions: 297 - name: succeed 298 - name: failed 299 - name: proxysql.jemalloc_memory_used 300 description: Jemalloc used memory 301 unit: B 302 chart_type: stacked 303 dimensions: 304 - name: active 305 - name: allocated 306 - name: mapped 307 - name: metadata 308 - name: resident 309 - name: retained 310 - name: proxysql.memory_used 311 description: Memory used 312 unit: B 313 chart_type: stacked 314 dimensions: 315 - name: auth 316 - name: sqlite3 317 - name: query_digest 318 - name: query_rules 319 - name: firewall_users_table 320 - name: firewall_users_config 321 - name: firewall_rules_table 322 - name: firewall_rules_config 323 - name: mysql_threads 324 - name: admin_threads 325 - name: cluster_threads 326 - name: proxysql.uptime 327 description: Uptime 328 unit: seconds 329 chart_type: line 330 dimensions: 331 - name: uptime 332 - name: command 333 description: These metrics refer to the SQL command. 334 labels: 335 - name: command 336 description: SQL command. 337 metrics: 338 - name: proxysql.mysql_command_execution_rate 339 description: MySQL command execution 340 unit: seconds 341 chart_type: line 342 dimensions: 343 - name: uptime 344 - name: proxysql.mysql_command_execution_time 345 description: MySQL command execution time 346 unit: microseconds 347 chart_type: line 348 dimensions: 349 - name: time 350 - name: proxysql.mysql_command_execution_duration 351 description: MySQL command execution duration histogram 352 unit: microseconds 353 chart_type: stacked 354 dimensions: 355 - name: 100us 356 - name: 500us 357 - name: 1ms 358 - name: 5ms 359 - name: 10ms 360 - name: 50ms 361 - name: 100ms 362 - name: 500ms 363 - name: 1s 364 - name: 5s 365 - name: 10s 366 - name: +Inf 367 - name: user 368 description: These metrics refer to the user. 369 labels: 370 - name: user 371 description: username from the mysql_users table 372 metrics: 373 - name: proxysql.mysql_user_connections_utilization 374 description: MySQL user connections utilization 375 unit: percentage 376 chart_type: line 377 dimensions: 378 - name: used 379 - name: proxysql.mysql_user_connections_count 380 description: MySQL user connections used 381 unit: connections 382 chart_type: line 383 dimensions: 384 - name: used 385 - name: backend 386 description: These metrics refer to the backend server. 387 labels: 388 - name: host 389 description: backend server host 390 - name: port 391 description: backend server port 392 metrics: 393 - name: proxysql.backend_status 394 description: Backend status 395 unit: status 396 chart_type: line 397 dimensions: 398 - name: online 399 - name: shunned 400 - name: offline_soft 401 - name: offline_hard 402 - name: proxysql.backend_connections_usage 403 description: Backend connections usage 404 unit: connections 405 chart_type: line 406 dimensions: 407 - name: free 408 - name: used 409 - name: proxysql.backend_connections_rate 410 description: Backend connections established 411 unit: connections/s 412 chart_type: line 413 dimensions: 414 - name: succeed 415 - name: failed 416 - name: proxysql.backend_queries_rate 417 description: Backend queries 418 unit: queries/s 419 chart_type: line 420 dimensions: 421 - name: queries 422 - name: proxysql.backend_traffic 423 description: Backend traffic 424 unit: B/s 425 chart_type: line 426 dimensions: 427 - name: recv 428 - name: send 429 - name: proxysql.backend_latency 430 description: Backend latency 431 unit: microseconds 432 chart_type: line 433 dimensions: 434 - name: latency