Skip to content

feat: allow setting limit in pg_stat_statements #1205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2025
Merged

feat: allow setting limit in pg_stat_statements #1205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions collector/pg_stat_statements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ import (
"github.com/prometheus/client_golang/prometheus"
)

const statStatementsSubsystem = "stat_statements"
const (
statStatementsSubsystem = "stat_statements"
defaultStatementLimit = "100"
)

var (
includeQueryFlag *bool = nil
statementLengthFlag *uint = nil
statementLimitFlag *uint = nil
)

func init() {
Expand All @@ -47,19 +51,26 @@ func init() {
"Maximum length of the statement text.").
Default("120").
Uint()
statementLimitFlag = kingpin.Flag(
fmt.Sprint(collectorFlagPrefix, statStatementsSubsystem, ".limit"),
"Maximum number of statements to return.").
Default(defaultStatementLimit).
Uint()
}

type PGStatStatementsCollector struct {
log *slog.Logger
includeQueryStatement bool
statementLength uint
statementLimit uint
}

func NewPGStatStatementsCollector(config collectorConfig) (Collector, error) {
return &PGStatStatementsCollector{
log: config.logger,
includeQueryStatement: *includeQueryFlag,
statementLength: *statementLengthFlag,
statementLimit: *statementLimitFlag,
}, nil
}

Expand Down Expand Up @@ -126,9 +137,9 @@ const (
FROM pg_stat_statements
)
ORDER BY seconds_total DESC
LIMIT 100;`
LIMIT %s;`

pgStatStatementsNewQuery = `SELECT
pgStatStatementsQuery_PG13 = `SELECT
pg_get_userbyid(userid) as user,
pg_database.datname,
pg_stat_statements.queryid,
Expand All @@ -148,7 +159,7 @@ const (
FROM pg_stat_statements
)
ORDER BY seconds_total DESC
LIMIT 100;`
LIMIT %s;`

pgStatStatementsQuery_PG17 = `SELECT
pg_get_userbyid(userid) as user,
Expand All @@ -170,7 +181,7 @@ const (
FROM pg_stat_statements
)
ORDER BY seconds_total DESC
LIMIT 100;`
LIMIT %s;`
)

func (c PGStatStatementsCollector) Update(ctx context.Context, instance *instance, ch chan<- prometheus.Metric) error {
Expand All @@ -179,20 +190,24 @@ func (c PGStatStatementsCollector) Update(ctx context.Context, instance *instanc
case instance.version.GE(semver.MustParse("17.0.0")):
queryTemplate = pgStatStatementsQuery_PG17
case instance.version.GE(semver.MustParse("13.0.0")):
queryTemplate = pgStatStatementsNewQuery
queryTemplate = pgStatStatementsQuery_PG13
default:
queryTemplate = pgStatStatementsQuery
}
var querySelect = ""
querySelect := ""
if c.includeQueryStatement {
querySelect = fmt.Sprintf(pgStatStatementQuerySelect, c.statementLength)
}
query := fmt.Sprintf(queryTemplate, querySelect)
statementLimit := defaultStatementLimit
if c.statementLimit > 0 {
statementLimit = fmt.Sprintf("%d", c.statementLimit)
}
query := fmt.Sprintf(queryTemplate, querySelect, statementLimit)

db := instance.getDB()
rows, err := db.QueryContext(ctx, query)

var presentQueryIds = make(map[string]struct{})
presentQueryIds := make(map[string]struct{})

if err != nil {
return err
Expand Down
Loading