From a401844e673896d0e4cec870a8cee28319b7ff90 Mon Sep 17 00:00:00 2001 From: Felix Yuan Date: Wed, 28 Jun 2023 10:53:55 -0700 Subject: [PATCH] Slow Query Collector and Test Signed-off-by: Felix Yuan --- collector/pg_slow.go | 82 +++++++++++++++++++++++++++++++++++++++ collector/pg_slow_test.go | 61 +++++++++++++++++++++++++++++ 2 files changed, 143 insertions(+) create mode 100644 collector/pg_slow.go create mode 100644 collector/pg_slow_test.go diff --git a/collector/pg_slow.go b/collector/pg_slow.go new file mode 100644 index 00000000..c0b44eb4 --- /dev/null +++ b/collector/pg_slow.go @@ -0,0 +1,82 @@ +// Copyright 2023 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 collector + +import ( + "context" + + "github.com/go-kit/log" + "github.com/prometheus/client_golang/prometheus" +) + +const slowSubsystem = "slow" + +func init() { + registerCollector(slowSubsystem, defaultDisabled, NewPGSlowCollector) +} + +type PGSlowCollector struct { + log log.Logger +} + +func NewPGSlowCollector(config collectorConfig) (Collector, error) { + return &PGSlowCollector{log: config.logger}, nil +} + +var ( + slowQueries = prometheus.NewDesc( + prometheus.BuildFQName(namespace, slowSubsystem, "queries"), + "Current number of slow queries", + []string{}, + prometheus.Labels{}, + ) + + slowQuery = ` + SELECT + COUNT(*) AS queries + FROM + pg_catalog.pg_stat_activity + WHERE + state = 'active' AND (now() - query_start) > '1 seconds'::interval + ` +) + +func (PGSlowCollector) Update(ctx context.Context, instance *instance, ch chan<- prometheus.Metric) error { + db := instance.getDB() + rows, err := db.QueryContext(ctx, + slowQuery) + + if err != nil { + return err + } + defer rows.Close() + + for rows.Next() { + var queries float64 + + if err := rows.Scan(&queries); err != nil { + return err + } + + ch <- prometheus.MustNewConstMetric( + slowQueries, + prometheus.GaugeValue, + queries, + ) + } + if err := rows.Err(); err != nil { + return err + } + return nil +} diff --git a/collector/pg_slow_test.go b/collector/pg_slow_test.go new file mode 100644 index 00000000..eece77c2 --- /dev/null +++ b/collector/pg_slow_test.go @@ -0,0 +1,61 @@ +// Copyright 2023 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 collector + +import ( + "context" + "testing" + + "github.com/DATA-DOG/go-sqlmock" + "github.com/prometheus/client_golang/prometheus" + dto "github.com/prometheus/client_model/go" + "github.com/smartystreets/goconvey/convey" +) + +func TestPGSlowCollector(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} + columns := []string{ + "queries", + } + rows := sqlmock.NewRows(columns). + AddRow(25) + + mock.ExpectQuery(sanitizeQuery(slowQuery)).WillReturnRows(rows) + + ch := make(chan prometheus.Metric) + go func() { + defer close(ch) + c := PGSlowCollector{} + + if err := c.Update(context.Background(), inst, ch); err != nil { + t.Errorf("Error calling PGSlowCollector.Update: %s", err) + } + }() + expected := []MetricResult{ + {labels: labelMap{}, value: 25, metricType: dto.MetricType_GAUGE}, + } + 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) + } +}