-
Notifications
You must be signed in to change notification settings - Fork 773
Gitlab collector: Database wraparound collector and test #834
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
SuperQ
merged 6 commits into
prometheus-community:master
from
Sticksman:cleanup/gitlab-exporter-wraparound
Jul 14, 2023
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f3762e3
Database wraparound collector and test
Sticksman 88465c0
Update collector/pg_database_wraparound.go
Sticksman 9d7deb5
Add seconds to label
Sticksman aa1075d
Skip if database name is null
Sticksman 0691523
Skip null stats and add debug statements
Sticksman 8c6b541
Merge branch 'master' into cleanup/gitlab-exporter-wraparound
Sticksman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
// 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/go-kit/log/level" | ||
"github.com/prometheus/client_golang/prometheus" | ||
) | ||
|
||
const databaseWraparoundSubsystem = "database_wraparound" | ||
|
||
func init() { | ||
registerCollector(databaseWraparoundSubsystem, defaultDisabled, NewPGDatabaseWraparoundCollector) | ||
} | ||
|
||
type PGDatabaseWraparoundCollector struct { | ||
log log.Logger | ||
} | ||
|
||
func NewPGDatabaseWraparoundCollector(config collectorConfig) (Collector, error) { | ||
return &PGDatabaseWraparoundCollector{log: config.logger}, nil | ||
} | ||
|
||
var ( | ||
databaseWraparoundAgeDatfrozenxid = prometheus.NewDesc( | ||
prometheus.BuildFQName(namespace, databaseWraparoundSubsystem, "age_datfrozenxid_seconds"), | ||
"Age of the oldest transaction ID that has not been frozen.", | ||
[]string{"datname"}, | ||
prometheus.Labels{}, | ||
) | ||
databaseWraparoundAgeDatminmxid = prometheus.NewDesc( | ||
prometheus.BuildFQName(namespace, databaseWraparoundSubsystem, "age_datminmxid_seconds"), | ||
"Age of the oldest multi-transaction ID that has been replaced with a transaction ID.", | ||
[]string{"datname"}, | ||
prometheus.Labels{}, | ||
) | ||
|
||
databaseWraparoundQuery = ` | ||
SELECT | ||
datname, | ||
age(d.datfrozenxid) as age_datfrozenxid, | ||
mxid_age(d.datminmxid) as age_datminmxid | ||
FROM | ||
pg_catalog.pg_database d | ||
WHERE | ||
d.datallowconn | ||
` | ||
) | ||
|
||
func (c *PGDatabaseWraparoundCollector) Update(ctx context.Context, instance *instance, ch chan<- prometheus.Metric) error { | ||
db := instance.getDB() | ||
rows, err := db.QueryContext(ctx, | ||
databaseWraparoundQuery) | ||
|
||
if err != nil { | ||
return err | ||
} | ||
defer rows.Close() | ||
|
||
for rows.Next() { | ||
var datname sql.NullString | ||
var ageDatfrozenxid, ageDatminmxid sql.NullFloat64 | ||
Sticksman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
if err := rows.Scan(&datname, &ageDatfrozenxid, &ageDatminmxid); err != nil { | ||
return err | ||
} | ||
|
||
if !datname.Valid { | ||
level.Debug(c.log).Log("msg", "Skipping database with NULL name") | ||
continue | ||
} | ||
if !ageDatfrozenxid.Valid { | ||
level.Debug(c.log).Log("msg", "Skipping stat emission with NULL age_datfrozenxid") | ||
continue | ||
} | ||
if !ageDatminmxid.Valid { | ||
level.Debug(c.log).Log("msg", "Skipping stat emission with NULL age_datminmxid") | ||
continue | ||
} | ||
|
||
ageDatfrozenxidMetric := ageDatfrozenxid.Float64 | ||
|
||
ch <- prometheus.MustNewConstMetric( | ||
databaseWraparoundAgeDatfrozenxid, | ||
prometheus.GaugeValue, | ||
ageDatfrozenxidMetric, datname.String, | ||
) | ||
|
||
ageDatminmxidMetric := ageDatminmxid.Float64 | ||
ch <- prometheus.MustNewConstMetric( | ||
databaseWraparoundAgeDatminmxid, | ||
prometheus.GaugeValue, | ||
ageDatminmxidMetric, datname.String, | ||
) | ||
} | ||
if err := rows.Err(); err != nil { | ||
return err | ||
} | ||
return nil | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
// 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 TestPGDatabaseWraparoundCollector(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{ | ||
"datname", | ||
"age_datfrozenxid", | ||
"age_datminmxid", | ||
} | ||
rows := sqlmock.NewRows(columns). | ||
AddRow("newreddit", 87126426, 0) | ||
|
||
mock.ExpectQuery(sanitizeQuery(databaseWraparoundQuery)).WillReturnRows(rows) | ||
|
||
ch := make(chan prometheus.Metric) | ||
go func() { | ||
defer close(ch) | ||
c := PGDatabaseWraparoundCollector{} | ||
|
||
if err := c.Update(context.Background(), inst, ch); err != nil { | ||
t.Errorf("Error calling PGDatabaseWraparoundCollector.Update: %s", err) | ||
} | ||
}() | ||
expected := []MetricResult{ | ||
{labels: labelMap{"datname": "newreddit"}, value: 87126426, metricType: dto.MetricType_GAUGE}, | ||
{labels: labelMap{"datname": "newreddit"}, value: 0, 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) | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.