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