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
|
// Copyright 2020 The Prometheus Authors
// 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 main
import (
"database/sql"
"errors"
"fmt"
"log/slog"
"math"
"strconv"
"time"
"unicode/utf8"
"github.com/lib/pq"
"github.com/prometheus/client_golang/prometheus"
)
var (
metricMaps = map[string]map[string]ColumnMapping{
"databases": {
"name": {LABEL, "N/A", 1, "N/A"},
"host": {LABEL, "N/A", 1, "N/A"},
"port": {LABEL, "N/A", 1, "N/A"},
"database": {LABEL, "N/A", 1, "N/A"},
"force_user": {LABEL, "N/A", 1, "N/A"},
"pool_size": {GAUGE, "pool_size", 1, "Maximum number of server connections"},
"reserve_pool": {GAUGE, "reserve_pool", 1, "Maximum number of additional connections for this database"},
"pool_mode": {LABEL, "N/A", 1, "N/A"},
"max_connections": {GAUGE, "max_connections", 1, "Maximum number of allowed connections for this database"},
"current_connections": {GAUGE, "current_connections", 1, "Current number of connections for this database"},
"paused": {GAUGE, "paused", 1, "1 if this database is currently paused, else 0"},
"disabled": {GAUGE, "disabled", 1, "1 if this database is currently disabled, else 0"},
},
"stats_totals": {
"database": {LABEL, "N/A", 1, "N/A"},
"query_count": {COUNTER, "queries_pooled_total", 1, "Total number of SQL queries pooled"},
"query_time": {COUNTER, "queries_duration_seconds_total", 1e-6, "Total number of seconds spent by pgbouncer when actively connected to PostgreSQL, executing queries"},
"bytes_received": {COUNTER, "received_bytes_total", 1, "Total volume in bytes of network traffic received by pgbouncer, shown as bytes"},
"requests": {COUNTER, "queries_total", 1, "Total number of SQL requests pooled by pgbouncer, shown as requests"},
"bytes_sent": {COUNTER, "sent_bytes_total", 1, "Total volume in bytes of network traffic sent by pgbouncer, shown as bytes"},
"wait_time": {COUNTER, "client_wait_seconds_total", 1e-6, "Time spent by clients waiting for a server in seconds"},
"xact_count": {COUNTER, "sql_transactions_pooled_total", 1, "Total number of SQL transactions pooled"},
"xact_time": {COUNTER, "server_in_transaction_seconds_total", 1e-6, "Total number of seconds spent by pgbouncer when connected to PostgreSQL in a transaction, either idle in transaction or executing queries"},
"client_parse_count": {COUNTER, "client_parses_total", 1, "Total number of prepared statement Parse messages received from clients"},
"server_parse_count": {COUNTER, "server_parses_total", 1, "Total number of prepared statement Parse messages sent by pgbouncer to PostgreSQL"},
"bind_count": {COUNTER, "binds_total", 1, "Total number of prepared statements readied for execution with a Bind message"},
"total_server_assignment_count": {COUNTER, "server_assignments_total", 1, "Total number of client connections which have been served since process start"},
},
"pools": {
"database": {LABEL, "N/A", 1, "N/A"},
"user": {LABEL, "N/A", 1, "N/A"},
"cl_active": {GAUGE, "client_active_connections", 1, "Client connections linked to server connection and able to process queries, shown as connection"},
"cl_active_cancel_req": {GAUGE, "client_active_cancel_connections", 1, "Client connections that have forwarded query cancellations to the server and are waiting for the server response"},
"cl_waiting": {GAUGE, "client_waiting_connections", 1, "Client connections waiting on a server connection, shown as connection"},
"cl_waiting_cancel_req": {GAUGE, "client_waiting_cancel_connections", 1, "Client connections that have not forwarded query cancellations to the server yet"},
"sv_active": {GAUGE, "server_active_connections", 1, "Server connections linked to a client connection, shown as connection"},
"sv_active_cancel": {GAUGE, "server_active_cancel_connections", 1, "Server connections that are currently forwarding a cancel request."},
"sv_being_canceled": {GAUGE, "server_being_canceled_connections", 1, "Servers that normally could become idle but are waiting to do so until all in-flight cancel requests have completed that were sent to cancel a query on this server."},
"sv_idle": {GAUGE, "server_idle_connections", 1, "Server connections idle and ready for a client query, shown as connection"},
"sv_used": {GAUGE, "server_used_connections", 1, "Server connections idle more than server_check_delay, needing server_check_query, shown as connection"},
"sv_tested": {GAUGE, "server_testing_connections", 1, "Server connections currently running either server_reset_query or server_check_query, shown as connection"},
"sv_login": {GAUGE, "server_login_connections", 1, "Server connections currently in the process of logging in, shown as connection"},
"maxwait": {GAUGE, "client_maxwait_seconds", 1, "Age of oldest unserved client connection, shown as second"},
},
}
listsMap = map[string]*(prometheus.Desc){
"databases": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "databases"),
"Count of databases", nil, nil),
"users": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "users"),
"Count of users", nil, nil),
"pools": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "pools"),
"Count of pools", nil, nil),
"free_clients": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "free_clients"),
"Count of free clients", nil, nil),
"used_clients": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "used_clients"),
"Count of used clients", nil, nil),
"login_clients": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "login_clients"),
"Count of clients in login state", nil, nil),
"free_servers": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "free_servers"),
"Count of free servers", nil, nil),
"used_servers": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "used_servers"),
"Count of used servers", nil, nil),
"dns_names": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "cached_dns_names"),
"Count of DNS names in the cache", nil, nil),
"dns_zones": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "cached_dns_zones"),
"Count of DNS zones in the cache", nil, nil),
"dns_queries": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "in_flight_dns_queries"),
"Count of in-flight DNS queries", nil, nil),
}
configMap = map[string]*(prometheus.Desc){
"max_client_conn": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "config", "max_client_connections"),
"Config maximum number of client connections", nil, nil),
"max_user_connections": prometheus.NewDesc(
prometheus.BuildFQName(namespace, "config", "max_user_connections"),
"Config maximum number of server connections per user", nil, nil),
}
)
// Metric descriptors.
var (
bouncerVersionDesc = prometheus.NewDesc(
prometheus.BuildFQName(namespace, "version", "info"),
"The pgbouncer version info",
[]string{"version"}, nil,
)
scrapeSuccessDesc = prometheus.NewDesc(
prometheus.BuildFQName(namespace, "", "up"),
"The pgbouncer scrape succeeded",
nil, nil,
)
)
func NewExporter(connectionString string, namespace string, logger *slog.Logger) *Exporter {
conn, err := pq.NewConnector(connectionString)
if err != nil {
logger.Error("failed to create connector", "error", err)
return nil
}
return &Exporter{
conn: conn,
metricMap: makeDescMap(metricMaps, namespace, logger),
logger: logger,
}
}
// Query SHOW LISTS, which has a series of rows, not columns.
func queryShowLists(ch chan<- prometheus.Metric, db *sql.DB, logger *slog.Logger) error {
rows, err := db.Query("SHOW LISTS;")
if err != nil {
return fmt.Errorf("error running SHOW LISTS on database: %w", err)
}
defer rows.Close()
columnNames, err := rows.Columns()
if err != nil || len(columnNames) != 2 {
return fmt.Errorf("error retrieving columns list from SHOW LISTS: %w", err)
}
var list string
var items sql.RawBytes
for rows.Next() {
if err = rows.Scan(&list, &items); err != nil {
return fmt.Errorf("error retrieving SHOW LISTS rows: %w", err)
}
value, err := strconv.ParseFloat(string(items), 64)
if err != nil {
return fmt.Errorf("error parsing SHOW LISTS column: %v, error: %w", list, err)
}
if metric, ok := listsMap[list]; ok {
ch <- prometheus.MustNewConstMetric(metric, prometheus.GaugeValue, value)
} else {
logger.Debug("SHOW LISTS unknown list", "list", list)
}
}
return nil
}
// Query SHOW CONFIG, which has a series of rows, not columns.
func queryShowConfig(ch chan<- prometheus.Metric, db *sql.DB, logger *slog.Logger) error {
rows, err := db.Query("SHOW CONFIG;")
if err != nil {
return fmt.Errorf("error running SHOW CONFIG on database: %w", err)
}
defer rows.Close()
columnNames, err := rows.Columns()
numColumns := len(columnNames)
if err != nil {
return fmt.Errorf("error retrieving columns list from SHOW CONFIG: %w", err)
}
exposedConfig := make(map[string]bool)
for configKey := range configMap {
exposedConfig[configKey] = true
}
var key string
var values sql.RawBytes
var defaultValue sql.RawBytes
var changeable string
for rows.Next() {
switch numColumns {
case 3:
if err = rows.Scan(&key, &values, &changeable); err != nil {
return fmt.Errorf("error retrieving SHOW CONFIG rows: %w", err)
}
case 4:
if err = rows.Scan(&key, &values, &defaultValue, &changeable); err != nil {
return fmt.Errorf("error retrieving SHOW CONFIG rows: %w", err)
}
default:
return fmt.Errorf("invalid number of SHOW CONFIG columns: %d", numColumns)
}
if !exposedConfig[key] {
continue
}
value, err := strconv.ParseFloat(string(values), 64)
if err != nil {
return fmt.Errorf("error parsing SHOW CONFIG column: %v, error: %w ", key, err)
}
if metric, ok := configMap[key]; ok {
ch <- prometheus.MustNewConstMetric(metric, prometheus.GaugeValue, value)
} else {
logger.Debug("SHOW CONFIG unknown config", "config", key)
}
}
return nil
}
// Query within a namespace mapping and emit metrics. Returns fatal errors if
// the scrape fails, and a slice of errors if they were non-fatal.
func queryNamespaceMapping(ch chan<- prometheus.Metric, db *sql.DB, namespace string, mapping MetricMapNamespace, logger *slog.Logger) ([]error, error) {
query := fmt.Sprintf("SHOW %s;", namespace)
// Don't fail on a bad scrape of one metric
rows, err := db.Query(query)
if err != nil {
return []error{}, fmt.Errorf("error running query on database: %v, error: %w", namespace, err)
}
defer rows.Close()
var columnNames []string
columnNames, err = rows.Columns()
if err != nil {
return []error{}, fmt.Errorf("error retrieving column list for: %v, error: %w", namespace, err)
}
// Make a lookup map for the column indices
var columnIdx = make(map[string]int, len(columnNames))
for i, n := range columnNames {
columnIdx[n] = i
}
var columnData = make([]interface{}, len(columnNames))
var scanArgs = make([]interface{}, len(columnNames))
for i := range columnData {
scanArgs[i] = &columnData[i]
}
nonfatalErrors := []error{}
for rows.Next() {
labelValues := make([]string, len(mapping.labels))
err = rows.Scan(scanArgs...)
if err != nil {
return []error{}, fmt.Errorf("error retrieving rows: %v, error: %w", namespace, err)
}
for i, label := range mapping.labels {
for idx, columnName := range columnNames {
if columnName == label {
switch v := columnData[idx].(type) {
case int:
labelValues[i] = strconv.Itoa(columnData[idx].(int))
case int64:
labelValues[i] = strconv.Itoa(int(columnData[idx].(int64)))
case float64:
labelValues[i] = fmt.Sprintf("%f", columnData[idx].(float64))
case string:
labelValues[i] = columnData[idx].(string)
case nil:
labelValues[i] = ""
default:
nonfatalErrors = append(nonfatalErrors, fmt.Errorf("column %s in %s has an unhandled type %v for label: %s ", columnName, namespace, v, columnData[idx]))
labelValues[i] = "<invalid>"
continue
}
// Prometheus will fail hard if the database and usernames are not UTF-8
if !utf8.ValidString(labelValues[i]) {
nonfatalErrors = append(nonfatalErrors, fmt.Errorf("column %s in %s has an invalid UTF-8 for a label: %s ", columnName, namespace, columnData[idx]))
labelValues[i] = "<invalid>"
continue
}
}
}
}
// Loop over column names, and match to scan data. Unknown columns
// will be filled with an untyped metric number *if* they can be
// converted to float64s. NULLs are allowed and treated as NaN.
for idx, columnName := range columnNames {
if metricMapping, ok := mapping.columnMappings[columnName]; ok {
// Is this a metricy metric?
if metricMapping.discard {
continue
}
value, ok := metricMapping.conversion(columnData[idx])
if !ok {
nonfatalErrors = append(nonfatalErrors, fmt.Errorf("unexpected error parsing namespace: %v, column: %v, index: %v", namespace, columnName, columnData[idx]))
continue
}
// Generate the metric
ch <- prometheus.MustNewConstMetric(metricMapping.desc, metricMapping.vtype, value, labelValues...)
}
}
}
if err := rows.Err(); err != nil {
logger.Error("Failed scaning all rows", "err", err.Error())
nonfatalErrors = append(nonfatalErrors, fmt.Errorf("failed to consume all rows due to: %w", err))
}
return nonfatalErrors, nil
}
func getDB(conn *pq.Connector) (*sql.DB, error) {
db := sql.OpenDB(conn)
if db == nil {
return nil, errors.New("error opening DB")
}
rows, err := db.Query("SHOW STATS")
if err != nil {
return nil, fmt.Errorf("error pinging pgbouncer: %w", err)
}
defer rows.Close()
db.SetMaxOpenConns(1)
db.SetMaxIdleConns(1)
return db, nil
}
// Convert database.sql types to float64s for Prometheus consumption. Null types are mapped to NaN. string and []byte
// types are mapped as NaN and !ok
func dbToFloat64(t interface{}, factor float64) (float64, bool) {
switch v := t.(type) {
case int64:
return float64(v) * factor, true
case float64:
return v * factor, true
case time.Time:
return float64(v.Unix()), true
case []byte:
// Try and convert to string and then parse to a float64
strV := string(v)
result, err := strconv.ParseFloat(strV, 64)
if err != nil {
return math.NaN(), false
}
return result * factor, true
case string:
result, err := strconv.ParseFloat(v, 64)
if err != nil {
return math.NaN(), false
}
return result * factor, true
case nil:
return math.NaN(), true
default:
return math.NaN(), false
}
}
// Iterate through all the namespace mappings in the exporter and run their queries.
func queryNamespaceMappings(ch chan<- prometheus.Metric, db *sql.DB, metricMap map[string]MetricMapNamespace, logger *slog.Logger) map[string]error {
// Return a map of namespace -> errors
namespaceErrors := make(map[string]error)
for namespace, mapping := range metricMap {
logger.Debug("Querying namespace", "namespace", namespace)
nonFatalErrors, err := queryNamespaceMapping(ch, db, namespace, mapping, logger)
// Serious error - a namespace disappeared
if err != nil {
namespaceErrors[namespace] = err
logger.Info("namespace disappeared", "err", err.Error())
}
// Non-serious errors - likely version or parsing problems.
if len(nonFatalErrors) > 0 {
for _, err := range nonFatalErrors {
logger.Info("error parsing", "err", err.Error())
}
}
}
return namespaceErrors
}
// Gather the pgbouncer version info.
func queryVersion(ch chan<- prometheus.Metric, db *sql.DB) error {
rows, err := db.Query("SHOW VERSION;")
if err != nil {
return fmt.Errorf("error getting pgbouncer version: %w", err)
}
defer rows.Close()
var columnNames []string
columnNames, err = rows.Columns()
if err != nil {
return fmt.Errorf("error retrieving column list for version: %w", err)
}
if len(columnNames) != 1 || columnNames[0] != "version" {
return errors.New("show version didn't return version column")
}
var bouncerVersion string
for rows.Next() {
err := rows.Scan(&bouncerVersion)
if err != nil {
return err
}
ch <- prometheus.MustNewConstMetric(
bouncerVersionDesc,
prometheus.GaugeValue,
1.0,
bouncerVersion,
)
}
return nil
}
// Describe implements prometheus.Collector.
func (e *Exporter) Describe(ch chan<- *prometheus.Desc) {
// We cannot know in advance what metrics the exporter will generate
// from Postgres. So we use the poor man's describe method: Run a collect
// and send the descriptors of all the collected metrics. The problem
// here is that we need to connect to the Postgres DB. If it is currently
// unavailable, the descriptors will be incomplete. Since this is a
// stand-alone exporter and not used as a library within other code
// implementing additional metrics, the worst that can happen is that we
// don't detect inconsistent metrics created by this exporter
// itself. Also, a change in the monitored Postgres instance may change the
// exported metrics during the runtime of the exporter.
metricCh := make(chan prometheus.Metric)
doneCh := make(chan struct{})
go func() {
for m := range metricCh {
ch <- m.Desc()
}
close(doneCh)
}()
e.Collect(metricCh)
close(metricCh)
<-doneCh
}
// Collect implements prometheus.Collector.
func (e *Exporter) Collect(ch chan<- prometheus.Metric) {
e.logger.Debug("Starting scrape")
var up = 1.0
defer func() {
ch <- prometheus.MustNewConstMetric(scrapeSuccessDesc, prometheus.GaugeValue, up)
}()
db, err := getDB(e.conn)
if err != nil {
e.logger.Warn("error setting up DB connection", "err", err.Error())
up = 0
return
}
defer db.Close()
err = queryVersion(ch, db)
if err != nil {
e.logger.Warn("error getting version", "err", err.Error())
up = 0
}
if err = queryShowLists(ch, db, e.logger); err != nil {
e.logger.Warn("error getting SHOW LISTS", "err", err.Error())
up = 0
}
if err = queryShowConfig(ch, db, e.logger); err != nil {
e.logger.Warn("error getting SHOW CONFIG", "err", err.Error())
up = 0
}
errMap := queryNamespaceMappings(ch, db, e.metricMap, e.logger)
if len(errMap) > 0 {
e.logger.Warn("error querying namespace mappings", "err", errMap)
up = 0
}
if len(errMap) == len(e.metricMap) {
up = 0
}
}
// Turn the MetricMap column mapping into a prometheus descriptor mapping.
func makeDescMap(metricMaps map[string]map[string]ColumnMapping, namespace string, logger *slog.Logger) map[string]MetricMapNamespace {
var metricMap = make(map[string]MetricMapNamespace)
for metricNamespace, mappings := range metricMaps {
thisMap := make(map[string]MetricMap)
var labels = make([]string, 0)
// First collect all the labels since the metrics will need them
for columnName, columnMapping := range mappings {
if columnMapping.usage == LABEL {
logger.Debug("Adding label", "column_name", columnName, "metric_namespace", metricNamespace)
labels = append(labels, columnName)
}
}
for columnName, columnMapping := range mappings {
factor := columnMapping.factor
// Determine how to convert the column based on its usage.
switch columnMapping.usage {
case COUNTER:
thisMap[columnName] = MetricMap{
vtype: prometheus.CounterValue,
desc: prometheus.NewDesc(fmt.Sprintf("%s_%s_%s", namespace, metricNamespace, columnMapping.metric), columnMapping.description, labels, nil),
conversion: func(in interface{}) (float64, bool) {
return dbToFloat64(in, factor)
},
}
case GAUGE:
thisMap[columnName] = MetricMap{
vtype: prometheus.GaugeValue,
desc: prometheus.NewDesc(fmt.Sprintf("%s_%s_%s", namespace, metricNamespace, columnMapping.metric), columnMapping.description, labels, nil),
conversion: func(in interface{}) (float64, bool) {
return dbToFloat64(in, factor)
},
}
}
}
metricMap[metricNamespace] = MetricMapNamespace{thisMap, labels}
}
return metricMap
}
|