Skip to content
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

Jump to bottom

Feature. Append query label #923

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Feature. Append query label #923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
37384c7
Append new query label
Sep 25, 2023
22418d0
Add limit
fireflg Sep 25, 2023
d6229af
add left in new query
Sep 29, 2023
693bd7d
Add labels SELECT|INSERT|UPDATE|DELETE|OTHER
Nov 27, 2023
3854450
Merge branch 'master' into feature/add-query-in-labels
fireflg Nov 28, 2023
52cfcfc
Merge branch 'master' into feature/add-query-in-labels
fireflg Jan 7, 2024
8973a40
Merge branch 'master' into feature/add-query-in-labels
fireflg Jun 16, 2024
0d3f568
Merge branch 'master' into feature/add-query-in-labels
fireflg Jul 9, 2024
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
53 changes: 38 additions & 15 deletions collector/pg_stat_statements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,41 +40,49 @@ func NewPGStatStatementsCollector(config collectorConfig) (Collector, error) {
}

var (
statSTatementsCallsTotal = prometheus.NewDesc(
statStatementsCallsTotal = prometheus.NewDesc(
prometheus.BuildFQName(namespace, statStatementsSubsystem, "calls_total"),
"Number of times executed",
[]string{"user", "datname", "queryid"},
[]string{"user", "datname", "queryid", "query", "stmt_type"},
prometheus.Labels{},
)
statStatementsSecondsTotal = prometheus.NewDesc(
prometheus.BuildFQName(namespace, statStatementsSubsystem, "seconds_total"),
"Total time spent in the statement, in seconds",
[]string{"user", "datname", "queryid"},
[]string{"user", "datname", "queryid", "query", "stmt_type"},
prometheus.Labels{},
)
statStatementsRowsTotal = prometheus.NewDesc(
prometheus.BuildFQName(namespace, statStatementsSubsystem, "rows_total"),
"Total number of rows retrieved or affected by the statement",
[]string{"user", "datname", "queryid"},
[]string{"user", "datname", "queryid", "query", "stmt_type"},
prometheus.Labels{},
)
statStatementsBlockReadSecondsTotal = prometheus.NewDesc(
prometheus.BuildFQName(namespace, statStatementsSubsystem, "block_read_seconds_total"),
"Total time the statement spent reading blocks, in seconds",
[]string{"user", "datname", "queryid"},
[]string{"user", "datname", "queryid", "query", "stmt_type"},
prometheus.Labels{},
)
statStatementsBlockWriteSecondsTotal = prometheus.NewDesc(
prometheus.BuildFQName(namespace, statStatementsSubsystem, "block_write_seconds_total"),
"Total time the statement spent writing blocks, in seconds",
[]string{"user", "datname", "queryid"},
[]string{"user", "datname", "queryid", "query", "stmt_type"},
prometheus.Labels{},
)

pgStatStatementsQuery = `SELECT
pg_get_userbyid(userid) as user,
pg_database.datname,
pg_stat_statements.queryid,
LEFT(pg_stat_statements.query, 120) as query,
CASE
WHEN pg_stat_statements.query ILIKE 'SELECT%' THEN 'SELECT'
WHEN pg_stat_statements.query ILIKE 'INSERT%' THEN 'INSERT'
WHEN pg_stat_statements.query ILIKE 'UPDATE%' THEN 'UPDATE'
WHEN pg_stat_statements.query ILIKE 'DELETE%' THEN 'DELETE'
ELSE 'OTHER'
END AS stmt_type,
pg_stat_statements.calls as calls_total,
pg_stat_statements.total_time / 1000.0 as seconds_total,
pg_stat_statements.rows as rows_total,
Expand All @@ -96,6 +104,14 @@ var (
pg_get_userbyid(userid) as user,
pg_database.datname,
pg_stat_statements.queryid,
LEFT(pg_stat_statements.query, 120) as query,
CASE
WHEN pg_stat_statements.query ILIKE 'SELECT%' THEN 'SELECT'
WHEN pg_stat_statements.query ILIKE 'INSERT%' THEN 'INSERT'
WHEN pg_stat_statements.query ILIKE 'UPDATE%' THEN 'UPDATE'
WHEN pg_stat_statements.query ILIKE 'DELETE%' THEN 'DELETE'
ELSE 'OTHER'
END AS stmt_type,
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,
Expand Down Expand Up @@ -128,11 +144,11 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
}
defer rows.Close()
for rows.Next() {
var user, datname, queryid sql.NullString
var user, datname, queryid, query, stmt_type 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 {
if err := rows.Scan(&user, &datname, &queryid, &query, &stmt_type, &callsTotal, &secondsTotal, &rowsTotal, &blockReadSecondsTotal, &blockWriteSecondsTotal); err != nil {
return err
}

Expand All @@ -148,16 +164,23 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
if queryid.Valid {
queryidLabel = queryid.String
}

queryLabel := "unknown"
if query.Valid {
queryLabel = query.String
}
stmt_typeLabel := "unknown"
if stmt_type.Valid {
stmt_typeLabel = stmt_type.String
}
callsTotalMetric := 0.0
if callsTotal.Valid {
callsTotalMetric = float64(callsTotal.Int64)
}
ch <- prometheus.MustNewConstMetric(
statSTatementsCallsTotal,
statStatementsCallsTotal,
prometheus.CounterValue,
callsTotalMetric,
userLabel, datnameLabel, queryidLabel,
userLabel, datnameLabel, queryidLabel, queryLabel, stmt_typeLabel,
)

secondsTotalMetric := 0.0
Expand All @@ -168,7 +191,7 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
statStatementsSecondsTotal,
prometheus.CounterValue,
secondsTotalMetric,
userLabel, datnameLabel, queryidLabel,
userLabel, datnameLabel, queryidLabel, queryLabel, stmt_typeLabel,
)

rowsTotalMetric := 0.0
Expand All @@ -179,7 +202,7 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
statStatementsRowsTotal,
prometheus.CounterValue,
rowsTotalMetric,
userLabel, datnameLabel, queryidLabel,
userLabel, datnameLabel, queryidLabel, queryLabel, stmt_typeLabel,
)

blockReadSecondsTotalMetric := 0.0
Expand All @@ -190,7 +213,7 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
statStatementsBlockReadSecondsTotal,
prometheus.CounterValue,
blockReadSecondsTotalMetric,
userLabel, datnameLabel, queryidLabel,
userLabel, datnameLabel, queryidLabel, queryLabel, stmt_typeLabel,
)

blockWriteSecondsTotalMetric := 0.0
Expand All @@ -201,7 +224,7 @@ func (PGStatStatementsCollector) Update(ctx context.Context, instance *instance,
statStatementsBlockWriteSecondsTotal,
prometheus.CounterValue,
blockWriteSecondsTotalMetric,
userLabel, datnameLabel, queryidLabel,
userLabel, datnameLabel, queryidLabel, queryLabel, stmt_typeLabel,
)
}
if err := rows.Err(); err != nil {
Expand Down
42 changes: 21 additions & 21 deletions collector/pg_stat_statements_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ func TestPGStateStatementsCollector(t *testing.T) {

inst := &instance{db: db, version: semver.MustParse("12.0.0")}

columns := []string{"user", "datname", "queryid", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
columns := []string{"user", "datname", "queryid", "query", "stmt_type", "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)
AddRow("postgres", "postgres", 1500, "SELECT", "SELECT", 5, 0.4, 100, 0.1, 0.2)
mock.ExpectQuery(sanitizeQuery(pgStatStatementsQuery)).WillReturnRows(rows)

ch := make(chan prometheus.Metric)
Expand All @@ -48,11 +48,11 @@ func TestPGStateStatementsCollector(t *testing.T) {
}()

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{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 5},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.4},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 100},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.1},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.2},
}

convey.Convey("Metrics comparison", t, func() {
Expand All @@ -75,9 +75,9 @@ func TestPGStateStatementsCollectorNull(t *testing.T) {

inst := &instance{db: db, version: semver.MustParse("13.3.7")}

columns := []string{"user", "datname", "queryid", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
columns := []string{"user", "datname", "queryid", "query", "stmt_type", "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)
AddRow(nil, nil, nil, nil, nil, nil, nil, nil, nil, nil)
mock.ExpectQuery(sanitizeQuery(pgStatStatementsNewQuery)).WillReturnRows(rows)

ch := make(chan prometheus.Metric)
Expand All @@ -91,11 +91,11 @@ func TestPGStateStatementsCollectorNull(t *testing.T) {
}()

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{"user": "unknown", "datname": "unknown", "query": "unknown", "stmt_type": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
{labels: labelMap{"user": "unknown", "datname": "unknown", "query": "unknown", "stmt_type": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
{labels: labelMap{"user": "unknown", "datname": "unknown", "query": "unknown", "stmt_type": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
{labels: labelMap{"user": "unknown", "datname": "unknown", "query": "unknown", "stmt_type": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
{labels: labelMap{"user": "unknown", "datname": "unknown", "query": "unknown", "stmt_type": "unknown", "queryid": "unknown"}, metricType: dto.MetricType_COUNTER, value: 0},
}

convey.Convey("Metrics comparison", t, func() {
Expand All @@ -118,9 +118,9 @@ func TestPGStateStatementsCollectorNewPG(t *testing.T) {

inst := &instance{db: db, version: semver.MustParse("13.3.7")}

columns := []string{"user", "datname", "queryid", "calls_total", "seconds_total", "rows_total", "block_read_seconds_total", "block_write_seconds_total"}
columns := []string{"user", "datname", "queryid", "query", "stmt_type", "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)
AddRow("postgres", "postgres", 1500, "SELECT", "SELECT", 5, 0.4, 100, 0.1, 0.2)
mock.ExpectQuery(sanitizeQuery(pgStatStatementsNewQuery)).WillReturnRows(rows)

ch := make(chan prometheus.Metric)
Expand All @@ -134,11 +134,11 @@ func TestPGStateStatementsCollectorNewPG(t *testing.T) {
}()

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{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 5},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.4},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 100},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.1},
{labels: labelMap{"user": "postgres", "datname": "postgres", "query": "SELECT", "stmt_type": "SELECT", "queryid": "1500"}, metricType: dto.MetricType_COUNTER, value: 0.2},
}

convey.Convey("Metrics comparison", t, func() {
Expand Down