-
Notifications
You must be signed in to change notification settings - Fork 0
/
gorm_mysql.go
364 lines (330 loc) · 11.4 KB
/
gorm_mysql.go
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
/*
Copyright © 2022 MicroOps-cn.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package gorm
import (
"context"
"database/sql"
"encoding/json"
"fmt"
"strconv"
"strings"
"sync"
"time"
kitlog "github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/go-sql-driver/mysql"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/common/model"
mysqldriver "gorm.io/driver/mysql"
"gorm.io/gorm"
"gorm.io/gorm/schema"
"github.com/MicroOps-cn/fuck/clients/tls"
g "github.com/MicroOps-cn/fuck/generator"
logs "github.com/MicroOps-cn/fuck/log"
"github.com/MicroOps-cn/fuck/safe"
"github.com/MicroOps-cn/fuck/signals"
w "github.com/MicroOps-cn/fuck/wrapper"
)
type TLSOptions struct {
options *tls.TLSOptions
name string
}
func (o TLSOptions) MarshalJSON() ([]byte, error) {
if o.options == nil {
return []byte(o.name), nil
}
return json.Marshal(o.options)
}
func (o *TLSOptions) UnmarshalJSON(data []byte) (err error) {
if err = json.Unmarshal(data, &o.name); err == nil {
return nil
}
if o.options == nil {
o.options = &tls.TLSOptions{}
}
if err = json.Unmarshal(data, o.options); err != nil {
return err
}
o.name = g.NewId()
tlsConfig, err := tls.NewTLSConfig(o.options)
if err != nil {
return err
}
return mysql.RegisterTLSConfig(o.name, tlsConfig)
}
type MySQLOptions struct {
Host string `json:"host,omitempty"`
Username string `json:"username,omitempty"`
Password safe.String `json:"password,omitempty"`
Schema string `json:"schema,omitempty"`
MaxIdle int32 `json:"max_idle,omitempty"`
MaxIdleConnections int32 `json:"max_idle_connections,omitempty"`
MaxOpenConnections int32 `json:"max_open_connections,omitempty"`
MaxConnectionLifeTime *model.Duration `json:"max_connection_life_time,omitempty"`
Charset string `json:"charset,omitempty"`
Collation string `json:"collation,omitempty"`
TablePrefix string `json:"table_prefix,omitempty"`
SlowThreshold *model.Duration `json:"slow_threshold,omitempty"`
TLSConfig *TLSOptions `json:"tls_config" yaml:"tls_config" mapstructure:"tls_config"`
}
func (x *MySQLOptions) GetPeer() (string, int) {
host, port, found := strings.Cut(x.Host, ":")
if found && len(port) > 0 {
portNum, err := strconv.Atoi(port)
if err == nil {
return host, portNum
}
}
return x.Host, 3306
}
func (x *MySQLOptions) GetConnectionString() string {
return fmt.Sprintf("mysql://%s", x.Host)
}
func (x *MySQLOptions) GetDBName() string {
return x.Schema
}
func (x *MySQLOptions) GetUsername() string {
return x.Username
}
func (x *MySQLOptions) GetType() string {
return "mysql"
}
func openMysqlConn(ctx context.Context, slowThreshold time.Duration, options *MySQLOptions, autoCreateSchema bool) (*gorm.DB, error) {
logger := logs.GetContextLogger(ctx)
passwd, err := options.Password.UnsafeString()
if err != nil {
return nil, err
}
db, err := gorm.Open(
mysqldriver.New(mysqldriver.Config{
DSNConfig: &mysql.Config{
User: options.Username,
Passwd: passwd,
Net: "tcp",
Addr: options.Host,
DBName: options.Schema,
Params: map[string]string{"charset": options.Charset},
Collation: options.Collation,
AllowNativePasswords: true,
CheckConnLiveness: true,
ParseTime: true,
},
}), &gorm.Config{
NamingStrategy: schema.NamingStrategy{
TablePrefix: options.TablePrefix,
SingularTable: true,
},
Logger: NewLogAdapter(logger, slowThreshold, nil),
},
)
if err != nil && autoCreateSchema {
if mysqlErr, ok := err.(*mysql.MySQLError); ok {
if mysqlErr.Number == 1049 && autoCreateSchema {
level.Info(logger).Log("msg", fmt.Sprintf("auto create schema: %s", options.Schema))
tmpOpts := *options
tmpOpts.Schema = "mysql"
db, err = openMysqlConn(ctx, slowThreshold, &tmpOpts, false)
if err != nil {
return nil, err
}
err = db.Exec(fmt.Sprintf("CREATE SCHEMA `%s` DEFAULT CHARACTER SET %s COLLATE %s", options.Schema, options.Charset, options.Collation)).Error
if err != nil {
return nil, err
}
if sqlDB, err := db.DB(); err == nil {
defer sqlDB.Close()
}
return openMysqlConn(ctx, slowThreshold, options, false)
}
}
}
return db, err
}
type MySQLStatsCollector struct {
db *gorm.DB
logger kitlog.Logger
name string
stats map[string]prometheus.Gauge
mux sync.Mutex
o MySQLOptions
}
func (m *MySQLStatsCollector) Describe(descs chan<- *prometheus.Desc) {}
func (m *MySQLStatsCollector) setStats(stats sql.DBStats) {
if m.stats == nil {
labels := map[string]string{"host": m.o.Host, "db_name": m.o.Schema}
m.stats = map[string]prometheus.Gauge{
"MaxOpenConnections": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_max_open_connections",
Help: "Maximum number of open connections to the database.",
ConstLabels: labels,
}),
"OpenConnections": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_open_connections",
Help: "The number of established connections both in use and idle.",
ConstLabels: labels,
}),
"InUse": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_in_use",
Help: "The number of connections currently in use.",
ConstLabels: labels,
}),
"Idle": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_idle",
Help: "The number of idle connections.",
ConstLabels: labels,
}),
"WaitCount": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_wait_count",
Help: "The total number of connections waited for.",
ConstLabels: labels,
}),
"WaitDuration": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_wait_duration",
Help: "The total time blocked waiting for a new connection.",
ConstLabels: labels,
}),
"MaxIdleClosed": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_max_idle_closed",
Help: "The total number of connections closed due to SetMaxIdleConns.",
ConstLabels: labels,
}),
"MaxLifetimeClosed": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_max_lifetime_closed",
Help: "The total number of connections closed due to SetConnMaxLifetime.",
ConstLabels: labels,
}),
"MaxIdleTimeClosed": prometheus.NewGauge(prometheus.GaugeOpts{
Name: "gorm_dbstats_max_idletime_closed",
Help: "The total number of connections closed due to SetConnMaxIdleTime.",
ConstLabels: labels,
}),
}
}
m.stats["MaxOpenConnections"].Set(float64(stats.MaxOpenConnections))
m.stats["OpenConnections"].Set(float64(stats.OpenConnections))
m.stats["InUse"].Set(float64(stats.InUse))
m.stats["Idle"].Set(float64(stats.Idle))
m.stats["WaitCount"].Set(float64(stats.WaitCount))
m.stats["WaitDuration"].Set(float64(stats.WaitDuration))
m.stats["MaxIdleClosed"].Set(float64(stats.MaxIdleClosed))
m.stats["MaxIdleTimeClosed"].Set(float64(stats.MaxIdleTimeClosed))
m.stats["MaxLifetimeClosed"].Set(float64(stats.MaxLifetimeClosed))
}
func (m *MySQLStatsCollector) Collect(metrics chan<- prometheus.Metric) {
m.mux.Lock()
defer m.mux.Unlock()
if sqlDB, err := m.db.DB(); err != nil {
level.Warn(m.logger).Log("msg", fmt.Errorf("failed to collect mysql stats: %s", m.name), "err", err)
} else {
m.setStats(sqlDB.Stats())
for _, stat := range m.stats {
metrics <- stat
}
}
}
func NewMySQLClient(ctx context.Context, options MySQLOptions) (clt *Client, err error) {
clt = new(Client)
clt.options = &options
logger := logs.GetContextLogger(ctx)
if options.SlowThreshold != nil {
clt.slowThreshold = time.Duration(*options.SlowThreshold)
if err != nil {
level.Error(logger).Log("msg", fmt.Errorf("failed to connect to mysql server: [%s@%s]", options.Username, options.Host), "err", fmt.Errorf("`slow_threshold` option is invalid: %s", err))
return nil, err
}
}
clt.name = fmt.Sprintf("[MySQL]%s", options.Schema)
level.Debug(logger).Log("msg", "connect to mysql server",
"host", options.Host, "username", options.Username,
"schema", options.Schema,
"charset", options.Charset,
"collation", options.Collation)
db, err := openMysqlConn(ctx, clt.slowThreshold, &options, true)
if err != nil {
level.Error(logger).Log("msg", fmt.Errorf("failed to connect to mysql server: [%s@%s]", options.Username, options.Host), "err", err)
return nil, err
}
{
sqlDB, err := db.DB()
if err != nil {
level.Error(logger).Log("msg", fmt.Errorf("failed to connect to mysql server: [%s@%s]", options.Username, options.Host), "err", err)
return nil, err
}
sqlDB.SetMaxIdleConns(int(options.MaxIdleConnections))
sqlDB.SetConnMaxLifetime(options.GetStdMaxConnectionLifeTime())
sqlDB.SetMaxOpenConns(int(options.MaxOpenConnections))
}
stopCh := signals.SetupSignalHandler(logger)
stopCh.PreStop(signals.LevelDB, func() {
if sqlDB, err := db.DB(); err == nil {
if err = sqlDB.Close(); err != nil {
level.Warn(logger).Log("msg", fmt.Errorf("failed to close mysql connect: [%s@%s]", options.Username, options.Host), "err", err)
}
} else {
level.Warn(logger).Log("msg", fmt.Errorf("failed to close mysql connect: [%s@%s]", options.Username, options.Host), "err", err)
}
level.Debug(logger).Log("msg", "MySQL connect closed")
})
prometheus.MustRegister(&MySQLStatsCollector{db: db, logger: logger, o: options})
level.Info(logger).Log("msg", "connected to mysql server",
"host", options.Host, "username", options.Username,
"schema", options.Schema,
"charset", options.Charset,
"collation", options.Collation)
clt.database = db
return clt, nil
}
func (x *MySQLOptions) GetStdMaxConnectionLifeTime() time.Duration {
if x != nil && x.MaxConnectionLifeTime != nil {
return time.Duration(*x.MaxConnectionLifeTime)
}
return time.Second * 30
}
func NewMySQLOptions() *MySQLOptions {
return &MySQLOptions{
Charset: "utf8",
Collation: "utf8_general_ci",
MaxIdleConnections: 2,
MaxOpenConnections: 100,
MaxConnectionLifeTime: (*model.Duration)(w.P(30 * time.Second)),
TablePrefix: "t_",
Host: "localhost",
Schema: "idas",
Username: "idas",
}
}
type MySQLClient struct {
*Client
options *MySQLOptions
}
func (c MySQLClient) Options() MySQLOptions {
return *c.options
}
func (c *MySQLClient) SetOptions(o *MySQLOptions) {
c.options = o
}
func (c MySQLClient) MarshalJSON() ([]byte, error) {
return json.Marshal(c.options)
}
func (c *MySQLClient) UnmarshalJSON(data []byte) (err error) {
if c.options == nil {
c.options = NewMySQLOptions()
}
if err = json.Unmarshal(data, c.options); err != nil {
return err
}
if c.Client, err = NewMySQLClient(context.Background(), *c.options); err != nil {
return err
}
return
}