Skip to content

database_observability: Add pgsql engine version to connection_info #4099

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+69 −24
Open

database_observability: Add pgsql engine version to connection_info #4099

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d61bc27
Fetch pgsql database engine version at component start, and pass it t…
rgeyer Jul 31, 2025
6e56dad
Parse the pgsql version to provide predicatable results
rgeyer Jul 31, 2025
a25a378
Handle whitespace in golang, rather than in the regex. Should make it…
rgeyer Jul 31, 2025
58da06e
Change version labels to be consistent with the 'engine' naming conve…
rgeyer Aug 5, 2025
9f1b190
Stragglers for engine name change
rgeyer Aug 6, 2025
6b4d52a
Move the engine version regex to it's own const, more renaming
rgeyer Aug 6, 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
43 changes: 30 additions & 13 deletions internal/component/database_observability/postgres/collector/connection_info.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package collector

import (
"context"
"fmt"
"regexp"
"strings"

Expand All @@ -12,19 +13,22 @@ import (
const ConnectionInfoName = "connection_info"

var (
rdsRegex = regexp.MustCompile(`(?P<identifier>[^\.]+)\.([^\.]+)\.(?P<region>[^\.]+)\.rds\.amazonaws\.com`)
azureRegex = regexp.MustCompile(`(?P<identifier>[^\.]+)\.postgres\.database\.azure\.com`)
rdsRegex = regexp.MustCompile(`(?P<identifier>[^\.]+)\.([^\.]+)\.(?P<region>[^\.]+)\.rds\.amazonaws\.com`)
azureRegex = regexp.MustCompile(`(?P<identifier>[^\.]+)\.postgres\.database\.azure\.com`)
versionRegex = regexp.MustCompile(`(?P<version>^[1-9]+\.[1-9]+)(?P<suffix>.*)?$`)
)

type ConnectionInfoArguments struct {
DSN string
Registry *prometheus.Registry
DSN string
Registry *prometheus.Registry
EngineVersion string
}

type ConnectionInfo struct {
DSN string
Registry *prometheus.Registry
InfoMetric *prometheus.GaugeVec
DSN string
Registry *prometheus.Registry
EngineVersion string
InfoMetric *prometheus.GaugeVec

running *atomic.Bool
}
Expand All @@ -34,15 +38,16 @@ func NewConnectionInfo(args ConnectionInfoArguments) (*ConnectionInfo, error) {
Namespace: "database_observability",
Name: "connection_info",
Help: "Information about the connection",
}, []string{"provider_name", "provider_region", "db_instance_identifier", "engine"})
}, []string{"provider_name", "provider_region", "db_instance_identifier", "engine", "engine_version", "engine_version_suffix"})

args.Registry.MustRegister(infoMetric)

return &ConnectionInfo{
DSN: args.DSN,
Registry: args.Registry,
InfoMetric: infoMetric,
running: &atomic.Bool{},
DSN: args.DSN,
Registry: args.Registry,
EngineVersion: args.EngineVersion,
InfoMetric: infoMetric,
running: &atomic.Bool{},
}, nil
}

Expand All @@ -58,6 +63,8 @@ func (c *ConnectionInfo) Start(ctx context.Context) error {
providerRegion = "unknown"
dbInstanceIdentifier = "unknown"
engine = "postgres"
engineVersion = "unknown"
engineVersionSuffix = "none"
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need the suffix for anything? If not I'd remove it for now (easier to add later when we need it)

Copy link
Contributor

Choose a reason for hiding this comment

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

I asked Ryan to put this up since it won't hurt and this info might be useful for debugging in the future.

Copy link
Contributor

Choose a reason for hiding this comment

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

I feel the opposite - let's not collect data we don't need. We can always add it later once we have a use for it.

)

parts, err := ParseURL(c.DSN)
Expand All @@ -81,7 +88,17 @@ func (c *ConnectionInfo) Start(ctx context.Context) error {
}
}
}
c.InfoMetric.WithLabelValues(providerName, providerRegion, dbInstanceIdentifier, engine).Set(1)

matches := versionRegex.FindStringSubmatch(c.EngineVersion)
fmt.Println(matches)
if len(matches) > 1 {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should these be inclusive?

engineVersion = matches[1]
}
if len(matches) > 2 && matches[2] != "" {
engineVersionSuffix = strings.TrimSpace(matches[2])
}

c.InfoMetric.WithLabelValues(providerName, providerRegion, dbInstanceIdentifier, engine, engineVersion, engineVersionSuffix).Set(1)
return nil
}

Expand Down
35 changes: 24 additions & 11 deletions internal/component/database_observability/postgres/collector/connection_info_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,37 +17,50 @@ func TestConnectionInfo(t *testing.T) {
const baseExpectedMetrics = `
# HELP database_observability_connection_info Information about the connection
# TYPE database_observability_connection_info gauge
database_observability_connection_info{db_instance_identifier="%s",engine="%s",provider_name="%s",provider_region="%s"} 1
database_observability_connection_info{db_instance_identifier="%s",engine="%s",engine_version="%s",engine_version_suffix="%s",provider_name="%s",provider_region="%s"} 1
`

testCases := []struct {
name string
dsn string
expectedMetrics string
name string
dsn string
engineVersion string
engineVersionSuffix string
expectedMetrics string
}{
{
name: "generic dsn",
dsn: "postgres://user:pass@localhost:5432/mydb",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "unknown", "postgres", "unknown", "unknown"),
engineVersion: "15.4",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "unknown", "postgres", "15.4", "none", "unknown", "unknown"),
},
{
name: "AWS/RDS dsn",
dsn: "postgres://user:[email protected]:5432/mydb",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "products-db", "postgres", "aws", "us-east-1"),
engineVersion: "15.4",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "products-db", "postgres", "15.4", "none", "aws", "us-east-1"),
},
{
name: "Azure flexibleservers dsn",
dsn: "postgres://user:[email protected]:5432/mydb",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "products-db", "postgres", "azure", "unknown"),
name: "Azure flexibleservers dsn",
dsn: "postgres://user:[email protected]:5432/mydb",
engineVersion: "15.4",
engineVersionSuffix: "none",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "products-db", "postgres", "15.4", "none", "azure", "unknown"),
},
{
name: "version suffix",
dsn: "postgres://user:pass@localhost:5432/mydb",
engineVersion: "15.4 (Debian 15.4-1.pgdg120+1)",
expectedMetrics: fmt.Sprintf(baseExpectedMetrics, "unknown", "postgres", "15.4", "(Debian 15.4-1.pgdg120+1)", "unknown", "unknown"),
},
}

for _, tc := range testCases {
reg := prometheus.NewRegistry()

collector, err := NewConnectionInfo(ConnectionInfoArguments{
DSN: tc.dsn,
Registry: reg,
DSN: tc.dsn,
Registry: reg,
EngineVersion: tc.engineVersion,
})
require.NoError(t, err)
require.NotNil(t, collector)
Expand Down
20 changes: 18 additions & 2 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 @@ -31,6 +31,8 @@ import (

const name = "database_observability.postgres"

const selectEngineVersion = `SHOW server_version`

func init() {
component.Register(component.Registration{
Name: name,
Expand Down Expand Up @@ -216,10 +218,24 @@ func (c *Component) startCollectors() error {
}
c.dbConnection = dbConnection

rs := dbConnection.QueryRowContext(context.Background(), selectEngineVersion)
err = rs.Err()
if err != nil {
level.Error(c.opts.Logger).Log("msg", "failed to query engine version", "err", err)
return err
}

var engineVersion string
if err := rs.Scan(&engineVersion); err != nil {
level.Error(c.opts.Logger).Log("msg", "failed to scan engine version", "err", err)
return err
}

// Connection Info collector is always enabled
ciCollector, err := collector.NewConnectionInfo(collector.ConnectionInfoArguments{
DSN: string(c.args.DataSourceName),
Registry: c.registry,
DSN: string(c.args.DataSourceName),
Registry: c.registry,
EngineVersion: engineVersion,
})
if err != nil {
level.Error(c.opts.Logger).Log("msg", "failed to create ConnectionInfo collector", "err", err)
Expand Down
Loading