Skip to content

fix: improved postgres version parsing for explain plans in database_observability component #5131

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

Merged
rgeyer merged 5 commits into from
Jan 5, 2026
Merged

fix: improved postgres version parsing for explain plans in database_observability component #5131

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
edda5ed
Move semver parsing of postgres version into explain plan collector t…
rgeyer Dec 16, 2025
538fe4a
More guardrails for parsing the postgres versions with semver to supp…
rgeyer Dec 16, 2025
2debddf
More useful comments
rgeyer Dec 17, 2025
48c304a
Merge branch 'main' into rgeyer/dbo11y/fix/psql-version
rgeyer Dec 17, 2025
dcd39a2
Add percona version string test
rgeyer Dec 17, 2025
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
17 changes: 13 additions & 4 deletions internal/component/database_observability/postgres/collector/explain_plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ var unrecoverablePostgresSQLErrors = []string{
}

var paramCountRegex = regexp.MustCompile(`\$\d+`)
var versSanitizeRegex = regexp.MustCompile(`^v?[0-9]+\.?[0-9]+`)

type PgSQLExplainplan struct {
Plan PlanNode `json:"Plan"`
Expand Down Expand Up @@ -214,7 +215,7 @@ type ExplainPlanArguments struct {
ExcludeSchemas []string
EntryHandler loki.EntryHandler
InitialLookback time.Time
DBVersion semver.Version
DBVersion string

Logger log.Logger
}
Expand All @@ -239,10 +240,9 @@ type ExplainPlan struct {
}

func NewExplainPlan(args ExplainPlanArguments) (*ExplainPlan, error) {
return &ExplainPlan{
ep := &ExplainPlan{
dbConnection: args.DB,
dbDSN: args.DSN,
dbVersion: args.DBVersion,
dbConnectionFactory: defaultDbConnectionFactory,
scrapeInterval: args.ScrapeInterval,
queryCache: make(map[string]*queryInfo),
Expand All @@ -253,7 +253,16 @@ func NewExplainPlan(args ExplainPlanArguments) (*ExplainPlan, error) {
entryHandler: args.EntryHandler,
logger: log.With(args.Logger, "collector", ExplainPlanCollector),
running: atomic.NewBool(false),
}, nil
}
// Pre-sanitize the version a bit before semver gets it
Copy link
Contributor

@matthewnolf matthewnolf Dec 17, 2025

Choose a reason for hiding this comment

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

nit: "a bit" is not very clear

Copy link
Contributor Author

@rgeyer rgeyer Dec 17, 2025

Choose a reason for hiding this comment

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

Fair enough, hopefully it is more informative now.

foundVers := versSanitizeRegex.FindString(args.DBVersion)
engineSemver, err := semver.ParseTolerant(foundVers)
if err != nil {
return ep, fmt.Errorf("failed to parse database engine version: %s: %w", args.DBVersion, err)
}
ep.dbVersion = engineSemver

return ep, nil
}

func (c *ExplainPlan) sendExplainPlansOutput(schemaName string, digest string, generatedAt string, result database_observability.ExplainProcessingResult, reason string, plan *database_observability.ExplainPlanNode) error {
Expand Down
72 changes: 44 additions & 28 deletions internal/component/database_observability/postgres/collector/explain_plan_test.go
View file
Open in desktop
Copy link
Contributor

@matthewnolf matthewnolf Dec 17, 2025

Choose a reason for hiding this comment

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

Should we add a test for the exact versions that are failing today?

Copy link
Contributor Author

@rgeyer rgeyer Dec 17, 2025

Choose a reason for hiding this comment

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

Did do, on lines 2293-2305. That said, this is just one of the failing version strings, but it's one I directly experienced with the postgres docker image.

I didn't get a chance to grab the full Percona version number that's failing, but the error is the same, semver is trying to parse spaces and special characters as a minor version. The changes (and the test) account for basically any combination of that.

Original file line number Diff line number Diff line change
Expand Up @@ -2255,37 +2255,53 @@ func TestNewExplainPlan(t *testing.T) {
entryHandler := loki.NewCollectingHandler()
defer entryHandler.Stop()

pre17ver, err := semver.ParseTolerant("14.1")
require.NoError(t, err)
t.Run("pre17 version", func(t *testing.T) {
pre17ver := "14.1"
pre17semver, err := semver.ParseTolerant(pre17ver)
require.NoError(t, err)

args := ExplainPlanArguments{
DB: db,
DSN: "postgres://user:pass@localhost:5432/testdb",
ScrapeInterval: time.Minute,
PerScrapeRatio: 0.1,
ExcludeSchemas: []string{"information_schema", "pg_catalog"},
EntryHandler: entryHandler,
InitialLookback: time.Now().Add(-time.Hour),
DBVersion: pre17ver,
Logger: logger,
}
args := ExplainPlanArguments{
DB: db,
DSN: "postgres://user:pass@localhost:5432/testdb",
ScrapeInterval: time.Minute,
PerScrapeRatio: 0.1,
ExcludeSchemas: []string{"information_schema", "pg_catalog"},
EntryHandler: entryHandler,
InitialLookback: time.Now().Add(-time.Hour),
DBVersion: pre17ver,
Logger: logger,
}

explainPlan, err := NewExplainPlan(args)
explainPlan, err := NewExplainPlan(args)

require.NoError(t, err)
require.NotNil(t, explainPlan)
assert.Equal(t, db, explainPlan.dbConnection)
assert.Equal(t, args.DSN, explainPlan.dbDSN)
assert.Equal(t, args.DBVersion, explainPlan.dbVersion)
assert.Equal(t, args.ScrapeInterval, explainPlan.scrapeInterval)
assert.Equal(t, args.PerScrapeRatio, explainPlan.perScrapeRatio)
assert.Equal(t, args.ExcludeSchemas, explainPlan.excludeSchemas)
assert.Equal(t, entryHandler, explainPlan.entryHandler)
assert.NotNil(t, explainPlan.queryCache)
assert.NotNil(t, explainPlan.queryDenylist)
assert.NotNil(t, explainPlan.finishedQueryCache)
assert.NotNil(t, explainPlan.running)
assert.False(t, explainPlan.running.Load())
require.NoError(t, err)
require.NotNil(t, explainPlan)
assert.Equal(t, db, explainPlan.dbConnection)
assert.Equal(t, args.DSN, explainPlan.dbDSN)
assert.Equal(t, pre17semver, explainPlan.dbVersion)
assert.Equal(t, args.ScrapeInterval, explainPlan.scrapeInterval)
assert.Equal(t, args.PerScrapeRatio, explainPlan.perScrapeRatio)
assert.Equal(t, args.ExcludeSchemas, explainPlan.excludeSchemas)
assert.Equal(t, entryHandler, explainPlan.entryHandler)
assert.NotNil(t, explainPlan.queryCache)
assert.NotNil(t, explainPlan.queryDenylist)
assert.NotNil(t, explainPlan.finishedQueryCache)
assert.NotNil(t, explainPlan.running)
assert.False(t, explainPlan.running.Load())
})

t.Run("version with trailing characters", func(t *testing.T) {
args := ExplainPlanArguments{
DBVersion: "16.10 (Debian 16.10-1.pgdg13+1)",
}

ep, err := NewExplainPlan(args)
require.NoError(t, err)

assert.Equal(t, ep.dbVersion.Major, uint64(16))
assert.Equal(t, ep.dbVersion.Minor, uint64(10))
assert.Equal(t, ep.dbVersion.Patch, uint64(0))
})
}

func TestExplainPlan_Name(t *testing.T) {
Expand Down
7 changes: 1 addition & 6 deletions internal/component/database_observability/postgres/component.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"sync"
"time"

"github.com/blang/semver/v4"
"github.com/lib/pq"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
Expand Down Expand Up @@ -447,17 +446,13 @@ func (c *Component) startCollectors(systemID string, engineVersion string, cloud
c.collectors = append(c.collectors, ciCollector)

if collectors[collector.ExplainPlanCollector] {
engineSemver, err := semver.ParseTolerant(engineVersion)
if err != nil {
logStartError(collector.ExplainPlanCollector, "parse version", err)
}
epCollector, err := collector.NewExplainPlan(collector.ExplainPlanArguments{
DB: c.dbConnection,
DSN: string(c.args.DataSourceName),
ScrapeInterval: c.args.ExplainPlanArguments.CollectInterval,
PerScrapeRatio: c.args.ExplainPlanArguments.PerCollectRatio,
Logger: c.opts.Logger,
DBVersion: engineSemver,
DBVersion: engineVersion,
EntryHandler: entryHandler,
})
if err != nil {
Expand Down
Loading