Add pg statio user queries and fix a test name

Signed-off-by: Felix Yuan <felix.yuan@reddit.com>

Author: Sticksman

collector/pg_stat_user_indexes_test.go

@@ -22,7 +22,7 @@ import (
 "github.com/smartystreets/goconvey/convey"
 )
 
-func TestPgUserIndexesCollector(t *testing.T) {
+func TestPgStatUserIndexesCollector(t *testing.T) {
 db, mock, err := sqlmock.New()
 if err != nil {
 t.Fatalf("Error opening a stub db connection: %s", err)

collector/pg_statio_user_indexes.go

@@ -0,0 +1,95 @@
+// 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"
+"database/sql"
+
+"github.com/go-kit/log"
+"github.com/prometheus/client_golang/prometheus"
+)
+
+func init() {
+registerCollector("replication", defaultEnabled, NewPGStatWalReceiverCollector)
+}
+
+type PGStatioUserIndexesCollector struct {
+log log.Logger
+}
+
+const statioUserIndexesSubsystem = "statio_user_indexes"
+
+func NewPGStatioUserIndexesCollector(collectorConfig) (Collector, error) {
+return &PGStatioUserIndexesCollector{}, nil
+}
+
+var (
+statioUserIndexesIdxBlksRead = prometheus.NewDesc(
+prometheus.BuildFQName(namespace, statioUserIndexesSubsystem, "idx_blks_read"),
+"Number of disk blocks read from this index",
+[]string{"schemaname", "relname", "indexrelname"},
+prometheus.Labels{},
+)
+statioUserIndexesIdxBlksHit = prometheus.NewDesc(
+prometheus.BuildFQName(namespace, statioUserIndexesSubsystem, "idx_blks_hit"),
+"Number of buffer hits in this index",
+[]string{"schemaname", "relname", "indexrelname"},
+prometheus.Labels{},
+)
+
+statioUserIndexesQuery = `
+SELECT
+schemaname,
+relname,
+indexrelname,
+idx_blks_read,
+idx_blks_hit
+FROM pg_statio_user_indexes
+`
+)
+
+func (c *PGStatioUserIndexesCollector) Update(ctx context.Context, db *sql.DB, ch chan<- prometheus.Metric) error {
+rows, err := db.QueryContext(ctx,
+statioUserIndexesQuery)
+
+if err != nil {
+return err
+}
+defer rows.Close()
+for rows.Next() {
+var schemaname, relname, indexrelname string
+var idxBlksRead, idxBlksHit float64
+
+if err := rows.Scan(&schemaname, &relname, &indexrelname, &idxBlksRead, &idxBlksHit); err != nil {
+return err
+}
+
+ch <- prometheus.MustNewConstMetric(
+statioUserIndexesIdxBlksRead,
+prometheus.CounterValue,
+idxBlksRead,
+schemaname, relname, indexrelname,
+)
+ch <- prometheus.MustNewConstMetric(
+statioUserIndexesIdxBlksHit,
+prometheus.CounterValue,
+idxBlksHit,
+schemaname, relname, indexrelname,
+)
+}
+if err := rows.Err(); err != nil {
+return err
+}
+return nil
+}

collector/pg_statio_user_indexes_test.go

@@ -0,0 +1,65 @@
+// 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 TestPgStatioUserIndexesCollector(t *testing.T) {
+db, mock, err := sqlmock.New()
+if err != nil {
+t.Fatalf("Error opening a stub db connection: %s", err)
+}
+defer db.Close()
+columns := []string{
+"schemaname",
+"relname",
+"indexrelname",
+"idx_blks_read",
+"idx_blks_hit",
+}
+rows := sqlmock.NewRows(columns).
+AddRow("public", "pgtest_accounts", "pgtest_accounts_pkey", 8, 9)
+
+mock.ExpectQuery(sanitizeQuery(statioUserIndexesQuery)).WillReturnRows(rows)
+
+ch := make(chan prometheus.Metric)
+go func() {
+defer close(ch)
+c := PGStatioUserIndexesCollector{}
+
+if err := c.Update(context.Background(), db, ch); err != nil {
+t.Errorf("Error calling PGStatioUserIndexesCollector.Update: %s", err)
+}
+}()
+expected := []MetricResult{
+{labels: labelMap{"schemaname": "public", "relname": "pgtest_accounts", "indexrelname": "pgtest_accounts_pkey"}, value: 8, metricType: dto.MetricType_COUNTER},
+{labels: labelMap{"schemaname": "public", "relname": "pgtest_accounts", "indexrelname": "pgtest_accounts_pkey"}, value: 9, metricType: dto.MetricType_COUNTER},
+}
+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)
+}
+}