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 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
|
package main
import (
"context"
"fmt"
"net/url"
"regexp"
"strings"
"time"
"github.com/cenkalti/backoff/v4"
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/go-sql-driver/mysql" // register the MySQL driver
"github.com/gobwas/glob"
"github.com/jmoiron/sqlx"
_ "github.com/lib/pq" // register the PostgreSQL driver
"github.com/prometheus/client_golang/prometheus"
sqladmin "google.golang.org/api/sqladmin/v1beta4"
)
var (
// MetricNameRE matches any invalid metric name
// characters, see github.com/prometheus/common/model.MetricNameRE
MetricNameRE = regexp.MustCompile("[^a-zA-Z0-9_:]+")
// CloudSQLPrefix is the prefix which trigger the connection to be done via the cloudsql connection client
CloudSQLPrefix = "cloudsql+"
)
// Init will initialize the metric descriptors
func (j *Job) Init(logger log.Logger, queries map[string]string) error {
j.log = log.With(logger, "job", j.Name)
// register each query as an metric
for _, q := range j.Queries {
if q == nil {
level.Warn(j.log).Log("msg", "Skipping invalid query")
continue
}
q.log = log.With(j.log, "query", q.Name)
q.jobName = j.Name
if q.Query == "" && q.QueryRef != "" {
if qry, found := queries[q.QueryRef]; found {
q.Query = qry
}
}
if q.Query == "" {
level.Warn(q.log).Log("msg", "Skipping empty query")
continue
}
if q.metrics == nil {
// we have no way of knowing how many metrics will be returned by the
// queries, so we just assume that each query returns at least one metric.
// after the each round of collection this will be resized as necessary.
q.metrics = make(map[*connection][]prometheus.Metric, len(j.Queries))
}
// try to satisfy prometheus naming restrictions
name := MetricNameRE.ReplaceAllString("sql_"+q.Name, "")
help := q.Help
// append the iterator label if it is set
if j.Iterator.Label != "" {
q.Labels = append(q.Labels, j.Iterator.Label)
}
// prepare a new metrics descriptor
//
// the tricky part here is that the *order* of labels has to match the
// order of label values supplied to NewConstMetric later
q.desc = prometheus.NewDesc(
name,
help,
append(q.Labels, "driver", "host", "database", "user", "col"),
prometheus.Labels{
"sql_job": j.Name,
},
)
}
j.updateConnections()
return nil
}
func (j *Job) updateConnections() {
// if there are no connection URLs for this job it can't be run
if j.Connections == nil {
level.Error(j.log).Log("msg", "no connections for job", "job_name", j.Name)
}
// make space for the connection objects
if j.conns == nil {
j.conns = make([]*connection, 0, len(j.Connections))
}
// parse the connection URLs and create a connection object for each
if len(j.conns) < len(j.Connections) {
for _, conn := range j.Connections {
// Check if we need to use cloudsql driver
if useCloudSQL, cloudsqlDriver := isValidCloudSQLDriver(conn); useCloudSQL {
// Do CloudSQL stuff
parsedU, err := ParseCloudSQLUrl(conn)
if err != nil {
level.Error(j.log).Log("msg", "could not parse cloudsql conn", "conn", conn)
continue
}
user := ""
if parsedU.User != nil {
user = parsedU.User.Username()
}
database := strings.TrimPrefix(parsedU.Path, "/")
if strings.ContainsRune(parsedU.Instance, '*') {
// We have a glob for the instance.
// List all CloudSQL instance and figure out which ones match
ctx := context.Background()
instanceGlob := glob.MustCompile(parsedU.Instance)
databaseGlob := glob.MustCompile(database)
// Create the Google Cloud SQL service.
service, err := sqladmin.NewService(ctx)
if err != nil {
level.Error(j.log).Log("msg", "could not create sqladmin client", "conn", conn, "err", err)
continue
}
// List instances for the project ID.
instances, err := service.Instances.List(parsedU.Project).Do()
if err != nil {
level.Error(j.log).Log("msg", "could not list cloudsql instances", "conn", conn, "err", err)
continue
}
for _, instance := range instances.Items {
if !instanceGlob.Match(instance.Name) || parsedU.Region != instance.Region {
continue
}
if strings.ContainsRune(database, '*') {
// We have a glob for the database.
// List all databases in instance and figure out which ones match
// List databases for the instance.
databases, err := service.Databases.List(parsedU.Project, instance.Name).Do()
if err != nil {
level.Error(j.log).Log("msg", "could not list cloudsql databases", "instance", instance.Name, "err", err)
continue
}
for _, db := range databases.Items {
if databaseGlob.Match(db.Name) {
connectionURL, err := parsedU.GetConnectionURL(cloudsqlDriver, instance.ConnectionName, db.Name)
if err != nil {
level.Error(j.log).Log("msg", "could not generate connection url", "err", err)
continue
}
newConn := &connection{
conn: nil,
url: connectionURL,
driver: cloudsqlDriver,
host: instance.Name,
database: db.Name,
user: user,
}
j.conns = append(j.conns, newConn)
}
}
} else {
connectionURL, err := parsedU.GetConnectionURL(cloudsqlDriver, instance.ConnectionName, database)
if err != nil {
level.Error(j.log).Log("msg", "could not generate connection url", "err", err)
continue
}
newConn := &connection{
conn: nil,
url: connectionURL,
driver: cloudsqlDriver,
host: instance.Name,
database: database,
user: user,
}
j.conns = append(j.conns, newConn)
}
}
} else {
connectionName := fmt.Sprintf("%s:%s:%s", parsedU.Project, parsedU.Region, parsedU.Instance)
connectionURL, err := parsedU.GetConnectionURL(cloudsqlDriver, connectionName, database)
if err != nil {
level.Error(j.log).Log("msg", "could not generate connection url", "err", err)
continue
}
newConn := &connection{
conn: nil,
url: connectionURL,
driver: cloudsqlDriver,
host: parsedU.Host,
database: database,
user: user,
}
j.conns = append(j.conns, newConn)
}
continue
}
// Handle both RDS MySQL and regular MySQL connections
if strings.HasPrefix(conn, "mysql://") {
var dsn string
var expirationTime time.Time
trimmedConn := strings.TrimPrefix(conn, "mysql://")
config, err := mysql.ParseDSN(trimmedConn)
if err != nil {
level.Error(j.log).Log("msg", "Failed to parse MySQL DSN", "url", conn, "err", err)
continue
}
dsn = config.FormatDSN()
j.conns = append(j.conns, &connection{
conn: nil,
url: dsn,
driver: "mysql",
host: config.Addr,
database: config.DBName,
user: config.User,
tokenExpirationTime: expirationTime,
})
continue
}
if strings.HasPrefix(conn, "postgres://") || strings.HasPrefix(conn, "pg://") {
u, err := url.Parse(conn)
var filteredDBs []string
if err != nil {
level.Error(j.log).Log("msg", "Failed to parse URL", "url", conn, "err", err)
continue
}
if strings.Contains(u.Path, "include") || strings.Contains(u.Path, "exclude") {
if strings.Contains(u.Path, "include") && strings.Contains(u.Path, "exclude") {
level.Error(j.log).Log("msg", "You cannot use exclude and include:", "url", conn, "err", err)
return
} else {
extractedPath := u.Path //save pattern
u.Path = "/postgres"
dsn := u.String()
databases, err := listDatabases(dsn)
if err != nil {
level.Error(j.log).Log("msg", "Error listing databases", "url", conn, "err", err)
continue
}
filteredDBs, err = filterDatabases(databases, extractedPath)
if err != nil {
level.Error(j.log).Log("msg", "Error filtering databases", "url", conn, "err", err)
continue
}
for _, db := range filteredDBs {
u.Path = "/" + db // Set the path to the filtered database name
newUserDSN := u.String()
j.conns = append(j.conns, &connection{
conn: nil,
url: newUserDSN,
driver: u.Scheme,
host: u.Host,
database: db,
user: u.User.Username(),
})
}
continue
}
}
}
u, err := url.Parse(conn)
if err != nil {
level.Error(j.log).Log("msg", "Failed to parse URL", "url", conn, "err", err)
continue
}
user := ""
if u.User != nil {
user = u.User.Username()
}
// For SQL Server connections,
// url.path is reserved for sql server instance not the database name
// database name can be specified in multiple ways:
// 1. Query parameter: database=dbname
// 2. Query parameter: initial catalog=dbname
database := ""
if strings.HasPrefix(conn, "sqlserver://") {
// Check for 'database' parameter first
if dbParam := getQueryStringCaseInsensitive(u.Query(), "database"); dbParam != "" {
database = dbParam
} else if catalogParam := getQueryStringCaseInsensitive(u.Query(), "initial catalog"); catalogParam != "" {
// 'initial catalog' is an alternative to 'database' parameter
database = catalogParam
}
} else {
database = strings.TrimPrefix(u.Path, "/")
}
// we expose some of the connection variables as labels, so we need to
// remember them
newConn := &connection{
conn: nil,
url: conn,
driver: u.Scheme,
host: u.Host,
database: database,
user: user,
}
/*
if newConn.driver == "athena" {
// call go-athena's Open() to ensure conn.db is set,
// otherwise API calls will complain about an empty database field:
// "InvalidParameter: 1 validation error(s) found. - minimum field size of 1, StartQueryExecutionInput.QueryExecutionContext.Database."
newConn.conn, err = sqlx.Open("athena", u.String())
if err != nil {
level.Error(j.log).Log("msg", "Failed to open Athena connection", "connection", conn, "err", err)
continue
}
}
*/
/*
if newConn.driver == "snowflake" {
u, err := url.Parse(conn)
if err != nil {
level.Error(j.log).Log("msg", "Failed to parse Snowflake URL", "url", conn, "err", err)
continue
}
queryParams := u.Query()
privateKeyPath := os.ExpandEnv(queryParams.Get("private_key_file"))
cfg := &gosnowflake.Config{
Account: u.Host,
User: u.User.Username(),
Role: queryParams.Get("role"),
Database: queryParams.Get("database"),
Schema: queryParams.Get("schema"),
}
if privateKeyPath != "" {
// RSA key auth
keyBytes, err := os.ReadFile(privateKeyPath)
if err != nil {
level.Error(j.log).Log("msg", "Failed to read private key file", "path", privateKeyPath, "err", err)
continue
}
keyBlock, _ := pem.Decode(keyBytes)
if keyBlock == nil {
level.Error(j.log).Log("msg", "Failed to decode PEM block", "path", privateKeyPath)
continue
}
var privateKey *rsa.PrivateKey
if parsedKey, err := x509.ParsePKCS8PrivateKey(keyBlock.Bytes); err == nil {
privateKey, _ = parsedKey.(*rsa.PrivateKey)
} else if parsedKey, err := x509.ParsePKCS1PrivateKey(keyBlock.Bytes); err == nil {
privateKey = parsedKey
} else {
level.Error(j.log).Log("msg", "Failed to parse private key", "err", err)
continue
}
cfg.Authenticator = gosnowflake.AuthTypeJwt
cfg.PrivateKey = privateKey
dsn, err := gosnowflake.DSN(cfg)
if err != nil {
level.Error(j.log).Log("msg", "Failed to create Snowflake DSN with RSA", "err", err)
continue
}
newConn.snowflakeConfig = cfg
newConn.snowflakeDSN = dsn
newConn.host = u.Host
newConn.tokenExpirationTime = time.Now().Add(time.Hour)
} else {
// Password auth
if pw, set := u.User.Password(); set {
cfg.Password = pw
}
if u.Port() != "" {
if port, err := strconv.Atoi(u.Port()); err == nil {
cfg.Port = port
}
}
dsn, err := gosnowflake.DSN(cfg)
if err != nil {
level.Error(j.log).Log("msg", "Failed to create Snowflake DSN with password", "err", err)
continue
}
newConn.conn, err = sqlx.Open("snowflake", dsn)
if err != nil {
level.Error(j.log).Log("msg", "Failed to open Snowflake connection", "err", err)
continue
}
}
j.conns = append(j.conns, newConn)
continue
}
*/
j.conns = append(j.conns, newConn)
}
}
}
func (j *Job) ExecutePeriodically() {
level.Debug(j.log).Log("msg", "Starting")
for {
j.Run()
level.Debug(j.log).Log("msg", "Sleeping until next run", "sleep", j.Interval.String())
time.Sleep(j.Interval)
}
}
func (j *Job) runOnceConnection(conn *connection, done chan int) {
updated := 0
defer func() {
done <- updated
}()
// connect to DB if not connected already
if err := conn.connect(j); err != nil {
level.Warn(j.log).Log("msg", "Failed to connect", "err", err, "host", conn.host)
j.markFailed(conn)
// we don't have the query name yet.
failedQueryCounter.WithLabelValues(j.Name, "").Inc()
return
}
// execute iterator SQL
if j.Iterator.SQL != "" {
level.Debug(j.log).Log("msg", "IteratorSQL", "Query:", j.Iterator.SQL)
rows, err := conn.conn.Queryx(j.Iterator.SQL)
if err != nil {
level.Warn(j.log).Log("msg", "Failed to run iterator query", "err", err, "host", conn.host)
j.markFailed(conn)
// we don't have the query name yet.
failedQueryCounter.WithLabelValues(j.Name, "").Inc()
return
}
defer rows.Close()
var ivs []string
for rows.Next() {
var value string
err := rows.Scan(&value)
if err != nil {
level.Warn(j.log).Log("msg", "Failed to read iterator values", "err", err, "host", conn.host)
j.markFailed(conn)
// we don't have the query name yet.
failedQueryCounter.WithLabelValues(j.Name, "").Inc()
return
}
ivs = append(ivs, value)
}
conn.iteratorValues = ivs
}
for _, q := range j.Queries {
if q == nil {
continue
}
if q.desc == nil {
// this may happen if the metric registration failed
level.Warn(q.log).Log("msg", "Skipping query. Collector is nil")
continue
}
// repeat query with iterator values if set and the query has the iterator placeholder
if conn.iteratorValues != nil && q.HasIterator(j.Iterator.Placeholder) {
level.Debug(q.log).Log("msg", "Running Iterator Query")
// execute the query with iterator on the connection
if err := q.RunIterator(conn, j.Iterator.Placeholder, conn.iteratorValues, j.Iterator.Label); err != nil {
level.Warn(q.log).Log("msg", "Failed to run query", "err", err)
continue
}
} else {
level.Debug(q.log).Log("msg", "Running Query")
// execute the query on the connection
if err := q.Run(conn); err != nil {
level.Warn(q.log).Log("msg", "Failed to run query", "err", err)
continue
}
}
level.Debug(q.log).Log("msg", "Query finished")
updated++
}
}
func (j *Job) markFailed(conn *connection) {
for _, q := range j.Queries {
failedScrapes.WithLabelValues(conn.driver, conn.host, conn.database, conn.user, q.jobName, q.Name).Set(1.0)
}
}
// Run the job queries with exponential backoff, implements the cron.Job interface
func (j *Job) Run() {
bo := backoff.NewExponentialBackOff()
bo.MaxElapsedTime = j.Interval
if bo.MaxElapsedTime == 0 {
bo.MaxElapsedTime = time.Minute
}
if err := backoff.Retry(j.runOnce, bo); err != nil {
level.Error(j.log).Log("msg", "Failed to run", "err", err)
}
}
func (j *Job) runOnce() error {
doneChan := make(chan int, len(j.conns))
// execute queries for each connection in parallel
for _, conn := range j.conns {
go j.runOnceConnection(conn, doneChan)
}
// connections now run in parallel, wait for and collect results
updated := 0
for range j.conns {
updated += <-doneChan
}
if updated < 1 {
return fmt.Errorf("zero queries ran")
}
return nil
}
func (c *connection) connect(job *Job) error {
// already connected
if c.conn != nil {
return nil
}
if c.driver == "snowflake" {
if c.snowflakeDSN != "" {
if time.Now().After(c.tokenExpirationTime) {
if c.conn != nil {
c.conn.Close()
c.conn = nil
}
c.tokenExpirationTime = time.Now().Add(time.Hour)
}
db, err := sqlx.Open("snowflake", c.snowflakeDSN)
if err != nil {
return fmt.Errorf("failed to open Snowflake connection: %w (host: %s)", err, c.host)
}
db.SetMaxOpenConns(1)
db.SetMaxIdleConns(0)
db.SetConnMaxLifetime(30 * time.Minute)
if err := db.Ping(); err != nil {
db.Close()
return fmt.Errorf("failed to ping Snowflake: %w (host: %s)", err, c.host)
}
c.conn = db
return nil
}
}
dsn := c.url
switch c.driver {
case "mysql":
dsn = strings.TrimPrefix(dsn, "mysql://")
}
conn, err := sqlx.Connect(c.driver, dsn)
if err != nil {
return err
}
// be nice and don't use up too many connections for mere metrics
conn.SetMaxOpenConns(1)
conn.SetMaxIdleConns(1)
// Disable SetConnMaxLifetime if MSSQL as it is causing issues with the MSSQL driver we are using. See #60
if c.driver != "sqlserver" {
conn.SetConnMaxLifetime(job.Interval * 2)
}
// execute StartupSQL
for _, query := range job.StartupSQL {
level.Debug(job.log).Log("msg", "StartupSQL", "Query:", query)
conn.MustExec(query)
}
c.conn = conn
return nil
}
func getQueryStringCaseInsensitive(values url.Values, key string) string {
key = strings.ToLower(key)
for k, v := range values {
if strings.ToLower(k) == key && len(v) > 0 {
return v[0]
}
}
return ""
}
|