diff --git a/README.md b/README.md
index 3b7730bc8..62070698b 100644
--- a/README.md
+++ b/README.md
@@ -128,6 +128,12 @@ This will build the docker image as `prometheuscommunity/postgres_exporter:${bra
* `[no-]collector.stat_statements`
Enable the `stat_statements` collector (default: disabled).
+* `[no-]collector.stat_statements.include_query`
+ Enable selecting statement query together with queryId. (default: disabled)
+
+* `--collector.stat_statements.query_length`
+ Maximum length of the statement text. Default is 120.
+
* `[no-]collector.stat_user_tables`
Enable the `stat_user_tables` collector (default: enabled).
diff --git a/collector/collector.go b/collector/collector.go
index 121129871..272005656 100644
--- a/collector/collector.go
+++ b/collector/collector.go
@@ -38,8 +38,9 @@ const (
// Namespace for all metrics.
namespace = "pg"
- defaultEnabled = true
- defaultDisabled = false
+ collectorFlagPrefix = "collector."
+ defaultEnabled = true
+ defaultDisabled = false
)
var (
@@ -75,7 +76,7 @@ func registerCollector(name string, isDefaultEnabled bool, createFunc func(colle
}
// Create flag for this collector
- flagName := fmt.Sprintf("collector.%s", name)
+ flagName := fmt.Sprint(collectorFlagPrefix, name)
flagHelp := fmt.Sprintf("Enable the %s collector (default: %s).", name, helpDefaultState)
defaultValue := fmt.Sprintf("%v", isDefaultEnabled)
diff --git a/collector/pg_stat_statements.go b/collector/pg_stat_statements.go
index c03e78b92..70d9efd29 100644
--- a/collector/pg_stat_statements.go
+++ b/collector/pg_stat_statements.go
@@ -16,7 +16,8 @@ package collector
import (
"context"
"database/sql"
-
+ "fmt"
+ "github.com/alecthomas/kingpin/v2"
"github.com/blang/semver/v4"
"github.com/go-kit/log"
"github.com/prometheus/client_golang/prometheus"
@@ -24,19 +25,41 @@ import (
const statStatementsSubsystem = "stat_statements"
+var (
+ includeQueryFlag *bool = nil
+ statementLengthFlag *uint = nil
+)
+
func init() {
// WARNING:
// Disabled by default because this set of metrics can be quite expensive on a busy server
// Every unique query will cause a new timeseries to be created
registerCollector(statStatementsSubsystem, defaultDisabled, NewPGStatStatementsCollector)
+
+ includeQueryFlag = kingpin.Flag(
+ fmt.Sprint(collectorFlagPrefix, statStatementsSubsystem, ".include_query"),
+ "Enable selecting statement query together with queryId. (default: disabled)").
+ Default(fmt.Sprintf("%v", defaultDisabled)).
+ Bool()
+ statementLengthFlag = kingpin.Flag(
+ fmt.Sprint(collectorFlagPrefix, statStatementsSubsystem, ".query_length"),
+ "Maximum length of the statement text.").
+ Default("120").
+ Uint()
}
type PGStatStatementsCollector struct {
- log log.Logger
+ log log.Logger
+ includeQueryStatement bool
+ statementLength uint
}
func NewPGStatStatementsCollector(config collectorConfig) (Collector, error) {
- return &PGStatStatementsCollector{log: config.logger}, nil
+ return &PGStatStatementsCollector{
+ log: config.logger,
+ includeQueryStatement: *includeQueryFlag,
+ statementLength: *statementLengthFlag,
+ }, nil
}
var (
@@ -71,10 +94,22 @@ var (
prometheus.Labels{},
)
+ statStatementsQuery = prometheus.NewDesc(
+ prometheus.BuildFQName(namespace, statStatementsSubsystem, "query_id"),
+ "SQL Query to queryid mapping",
+ []string{"queryid", "query"},
+ prometheus.Labels{},
+ )
+)
+
+const (
+ pgStatStatementQuerySelect = `LEFT(pg_stat_statements.query, %d) as query,`
+
pgStatStatementsQuery = `SELECT
pg_get_userbyid(userid) as user,
pg_database.datname,
pg_stat_statements.queryid,
+ %s
pg_stat_statements.calls as calls_total,
pg_stat_statements.total_time / 1000.0 as seconds_total,
pg_stat_statements.rows as rows_total,
@@ -96,6 +131,7 @@ var (
pg_get_userbyid(userid) as user,
pg_database.datname,
pg_stat_statements.queryid,
+ %s
pg_stat_statements.calls as calls_total,
pg_stat_statements.total_exec_time / 1000.0 as seconds_total,
pg_stat_statements.rows as rows_total,
@@ -114,25 +150,37 @@ var (
LIMIT 100;`
)
-func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance, ch chan<- prometheus.Metric) error {
- query := pgStatStatementsQuery
+func (c PGStatStatementsCollector) Update(ctx context.Context, instance *instance, ch chan<- prometheus.Metric) error {
+ queryTemplate := pgStatStatementsQuery
if instance.version.GE(semver.MustParse("13.0.0")) {
- query = pgStatStatementsNewQuery
+ queryTemplate = pgStatStatementsNewQuery
+ }
+ var querySelect = ""
+ if c.includeQueryStatement {
+ querySelect = fmt.Sprintf(pgStatStatementQuerySelect, c.statementLength)
}
+ query := fmt.Sprintf(queryTemplate, querySelect)
db := instance.getDB()
rows, err := db.QueryContext(ctx, query)
+ var presentQueryIds = make(map[string]struct{})
+
if err != nil {
return err
}
defer rows.Close()
for rows.Next() {
- var user, datname, queryid sql.NullString
+ var user, datname, queryid, statement sql.NullString
var callsTotal, rowsTotal sql.NullInt64
var secondsTotal, blockReadSecondsTotal, blockWriteSecondsTotal sql.NullFloat64
-
- if err := rows.Scan(&user, &datname, &queryid, &callsTotal, &secondsTotal, &rowsTotal, &blockReadSecondsTotal, &blockWriteSecondsTotal); err != nil {
+ var columns []any
+ if c.includeQueryStatement {
+ columns = []any{&user, &datname, &queryid, &statement, &callsTotal, &secondsTotal, &rowsTotal, &blockReadSecondsTotal, &blockWriteSecondsTotal}
+ } else {
+ columns = []any{&user, &datname, &queryid, &callsTotal, &secondsTotal, &rowsTotal, &blockReadSecondsTotal, &blockWriteSecondsTotal}
+ }
+ if err := rows.Scan(columns...); err != nil {
return err
}
@@ -203,6 +251,25 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
blockWriteSecondsTotalMetric,
userLabel, datnameLabel, queryidLabel,
)
+
+ if c.includeQueryStatement {
+ _, ok := presentQueryIds[queryidLabel]
+ if !ok {
+ presentQueryIds[queryidLabel] = struct{}{}
+
+ queryLabel := "unknown"
+ if statement.Valid {
+ queryLabel = statement.String
+ }
+
+ ch <- prometheus.MustNewConstMetric(
+ statStatementsQuery,
+ prometheus.CounterValue,
+ 1,
+ queryidLabel, queryLabel,
+ )
+ }
+ }
}
if err := rows.Err(); err != nil {
return err
diff --git a/collector/pg_stat_statements_test.go b/collector/pg_stat_statements_test.go
index 08aba34c2..eeebaa525 100644
--- a/collector/pg_stat_statements_test.go
+++ b/collector/pg_stat_statements_test.go
@@ -14,6 +14,7 @@ package collector
import (
"context"
+ "fmt"
"testing"
"github.com/DATA-DOG/go-sqlmock"
@@ -35,7 +36,7 @@ func TestPGStateStatementsCollector(t *testing.T) {
columns := []string{"user", "datname", "queryid", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
rows := sqlmock.NewRows(columns).
AddRow("postgres", "postgres", 1500, 5, 0.4, 100, 0.1, 0.2)
- mock.ExpectQuery(sanitizeQuery(pgStatStatementsQuery)).WillReturnRows(rows)
+ mock.ExpectQuery(sanitizeQuery(fmt.Sprintf(pgStatStatementsQuery, ""))).WillReturnRows(rows)
ch := make(chan prometheus.Metric)
go func() {
@@ -66,6 +67,50 @@ func TestPGStateStatementsCollector(t *testing.T) {
}
}
+func TestPGStateStatementsCollectorWithStatement(t *testing.T) {
+ db, mock, err := sqlmock.New()
+ if err != nil {
+ t.Fatalf("Error opening a stub db connection: %s", err)
+ }
+ defer db.Close()
+
+ inst := &instance{db: db, version: semver.MustParse("12.0.0")}
+
+ columns := []string{"user", "datname", "queryid", "LEFT(pg_stat_statements.query, 100) as query", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
+ rows := sqlmock.NewRows(columns).
+ AddRow("postgres", "postgres", 1500, "select 1 from foo", 5, 0.4, 100, 0.1, 0.2)
+ mock.ExpectQuery(sanitizeQuery(fmt.Sprintf(pgStatStatementsQuery, fmt.Sprintf(pgStatStatementQuerySelect, 100)))).WillReturnRows(rows)
+
+ ch := make(chan prometheus.Metric)
+ go func() {
+ defer close(ch)
+ c := PGStatStatementsCollector{includeQueryStatement: true, statementLength: 100}
+
+ if err := c.Update(context.Background(), inst, ch); err != nil {
+ t.Errorf("Error calling PGStatStatementsCollector.Update: %s", err)
+ }
+ }()
+
+ expected := []MetricResult{
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 5},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.4},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 100},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.1},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.2},
+ {labels: labelMap{"queryid": "1500", "query": "select 1 from foo"}, metricType: dto.MetricType_COUNTER, value: 1},
+ }
+
+ convey.Convey("Metrics comparison", t, func() {
+ for _, expect := range expected {
+ m := readMetric(<-ch)
+ convey.So(expect, convey.ShouldResemble, m)
+ }
+ })
+ if err := mock.ExpectationsWereMet(); err != nil {
+ t.Errorf("there were unfulfilled exceptions: %s", err)
+ }
+}
+
func TestPGStateStatementsCollectorNull(t *testing.T) {
db, mock, err := sqlmock.New()
if err != nil {
@@ -78,7 +123,7 @@ func TestPGStateStatementsCollectorNull(t *testing.T) {
columns := []string{"user", "datname", "queryid", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
rows := sqlmock.NewRows(columns).
AddRow(nil, nil, nil, nil, nil, nil, nil, nil)
- mock.ExpectQuery(sanitizeQuery(pgStatStatementsNewQuery)).WillReturnRows(rows)
+ mock.ExpectQuery(sanitizeQuery(fmt.Sprintf(pgStatStatementsNewQuery, ""))).WillReturnRows(rows)
ch := make(chan prometheus.Metric)
go func() {
@@ -109,6 +154,50 @@ func TestPGStateStatementsCollectorNull(t *testing.T) {
}
}
+func TestPGStateStatementsCollectorNullWithStatement(t *testing.T) {
+ db, mock, err := sqlmock.New()
+ if err != nil {
+ t.Fatalf("Error opening a stub db connection: %s", err)
+ }
+ defer db.Close()
+
+ inst := &instance{db: db, version: semver.MustParse("13.3.7")}
+
+ columns := []string{"user", "datname", "queryid", "LEFT(pg_stat_statements.query, 200) as query", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
+ rows := sqlmock.NewRows(columns).
+ AddRow(nil, nil, nil, nil, nil, nil, nil, nil, nil)
+ mock.ExpectQuery(sanitizeQuery(fmt.Sprintf(pgStatStatementsNewQuery, fmt.Sprintf(pgStatStatementQuerySelect, 200)))).WillReturnRows(rows)
+
+ ch := make(chan prometheus.Metric)
+ go func() {
+ defer close(ch)
+ c := PGStatStatementsCollector{includeQueryStatement: true, statementLength: 200}
+
+ if err := c.Update(context.Background(), inst, ch); err != nil {
+ t.Errorf("Error calling PGStatStatementsCollector.Update: %s", err)
+ }
+ }()
+
+ expected := []MetricResult{
+ {labels: labelMap{"user": "unknown", "datname": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
+ {labels: labelMap{"user": "unknown", "datname": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
+ {labels: labelMap{"user": "unknown", "datname": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
+ {labels: labelMap{"user": "unknown", "datname": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
+ {labels: labelMap{"user": "unknown", "datname": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
+ {labels: labelMap{"queryid": "unknown", "query": "unknown"}, metricType: dto.MetricType_COUNTER, value: 1},
+ }
+
+ convey.Convey("Metrics comparison", t, func() {
+ for _, expect := range expected {
+ m := readMetric(<-ch)
+ convey.So(expect, convey.ShouldResemble, m)
+ }
+ })
+ if err := mock.ExpectationsWereMet(); err != nil {
+ t.Errorf("there were unfulfilled exceptions: %s", err)
+ }
+}
+
func TestPGStateStatementsCollectorNewPG(t *testing.T) {
db, mock, err := sqlmock.New()
if err != nil {
@@ -121,7 +210,7 @@ func TestPGStateStatementsCollectorNewPG(t *testing.T) {
columns := []string{"user", "datname", "queryid", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
rows := sqlmock.NewRows(columns).
AddRow("postgres", "postgres", 1500, 5, 0.4, 100, 0.1, 0.2)
- mock.ExpectQuery(sanitizeQuery(pgStatStatementsNewQuery)).WillReturnRows(rows)
+ mock.ExpectQuery(sanitizeQuery(fmt.Sprintf(pgStatStatementsNewQuery, ""))).WillReturnRows(rows)
ch := make(chan prometheus.Metric)
go func() {
@@ -151,3 +240,47 @@ func TestPGStateStatementsCollectorNewPG(t *testing.T) {
t.Errorf("there were unfulfilled exceptions: %s", err)
}
}
+
+func TestPGStateStatementsCollectorNewPGWithStatement(t *testing.T) {
+ db, mock, err := sqlmock.New()
+ if err != nil {
+ t.Fatalf("Error opening a stub db connection: %s", err)
+ }
+ defer db.Close()
+
+ inst := &instance{db: db, version: semver.MustParse("13.3.7")}
+
+ columns := []string{"user", "datname", "queryid", "LEFT(pg_stat_statements.query, 300) as query", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
+ rows := sqlmock.NewRows(columns).
+ AddRow("postgres", "postgres", 1500, "select 1 from foo", 5, 0.4, 100, 0.1, 0.2)
+ mock.ExpectQuery(sanitizeQuery(fmt.Sprintf(pgStatStatementsNewQuery, fmt.Sprintf(pgStatStatementQuerySelect, 300)))).WillReturnRows(rows)
+
+ ch := make(chan prometheus.Metric)
+ go func() {
+ defer close(ch)
+ c := PGStatStatementsCollector{includeQueryStatement: true, statementLength: 300}
+
+ if err := c.Update(context.Background(), inst, ch); err != nil {
+ t.Errorf("Error calling PGStatStatementsCollector.Update: %s", err)
+ }
+ }()
+
+ expected := []MetricResult{
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 5},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.4},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 100},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.1},
+ {labels: labelMap{"user": "postgres", "datname": "postgres", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.2},
+ {labels: labelMap{"queryid": "1500", "query": "select 1 from foo"}, metricType: dto.MetricType_COUNTER, value: 1},
+ }
+
+ convey.Convey("Metrics comparison", t, func() {
+ for _, expect := range expected {
+ m := readMetric(<-ch)
+ convey.So(expect, convey.ShouldResemble, m)
+ }
+ })
+ if err := mock.ExpectationsWereMet(); err != nil {
+ t.Errorf("there were unfulfilled exceptions: %s", err)
+ }
+}