Skip to content

adding codified functionality for logical replication metrics #747

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.

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 6 commits into from
Feb 7, 2023
Merged
Changes from 1 commit
Commits
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
72 changes: 72 additions & 0 deletions collector/pg_replication_slots.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
// Copyright 2022 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_slot", defaultEnabled, NewPGReplicationSlotCollector)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realized we were drifting from the naming conventions here. This is patterned after the node_exporter, where we make sure collectors are named based on the files. So the filename should be replication_slot.go.

But I'm also somewhat fine with pg_<collector>.go.

What do you think @sysadmind?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know that I have a strong opinion here. The tables inside the database have the pg_ prefix, so I could argue keeping the prefix. I'm not opposed to either direction.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is local to the package, I think we should name them after the collector to keep with the convention. pg_ seems redundant.

}

type PGReplicationSlotCollector struct {
log log.Logger
}

func NewPGReplicationSlotCollector(logger log.Logger) (Collector, error) {
return &PGReplicationSlotCollector{log: logger}, nil
}

var pgReplicationSlot = map[string]*prometheus.Desc{
"lsn_distance": prometheus.NewDesc(
"pg_replication_slot_lsn_distance",
"Disk space used by the database",
[]string{"slot_name"}, nil,
),
}

func (PGReplicationSlotCollector) Update(ctx context.Context, db *sql.DB, ch chan<- prometheus.Metric) error {
rows, err := db.QueryContext(ctx,
`SELECT
slot_name,
(pg_current_wal_lsn() - confirmed_flush_lsn) AS lsn_distance
FROM
pg_replication_slots;`)
if err != nil {
return err
}
defer rows.Close()

for rows.Next() {
var slot_name string
var size int64
if err := rows.Scan(&slot_name, &size); err != nil {
return err
}

ch <- prometheus.MustNewConstMetric(
pgReplicationSlot["size_bytes"],
prometheus.GaugeValue, float64(size), slot_name,
)
}
if err := rows.Err(); err != nil {
return err
}
return nil
}