Skip to content

feat: expose Desc error through public Err() method #1902

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 3 commits into
base: main
Choose a base branch
from
Open

feat: expose Desc error through public Err() method #1902

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ffa5cc
feat: expose Desc error through public Err() method
duricanikolic Oct 31, 2025
ec2ca21
Fixing review findings
duricanikolic Nov 24, 2025
24e20d9
Merge remote-tracking branch 'upstream/main' into yuri/expose-err-desc
duricanikolic Nov 24, 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
5 changes: 5 additions & 0 deletions prometheus/desc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,11 @@ func NewInvalidDesc(err error) *Desc {
}
}

// Err returns an error that occurred during construction, if any.
func (d *Desc) Err() error {
return d.err
}

func (d *Desc) String() string {
lpStrings := make([]string, 0, len(d.constLabelPairs))
for _, lp := range d.constLabelPairs {
Expand Down
26 changes: 20 additions & 6 deletions prometheus/desc_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,29 @@ import (
"testing"
)

func TestNewDescInvalidLabelValues(t *testing.T) {
func TestNewDescInvalidConstLabelValues(t *testing.T) {
labelValue := "\xFF"
desc := NewDesc(
"sample_label",
"sample label",
nil,
Labels{"a": "\xFF"},
Labels{"a": labelValue},
)
if desc.err == nil {
t.Errorf("NewDesc: expected error because: %s", desc.err)
if desc.Err() == nil {
t.Errorf("NewDesc: expected error because const label value is invalid: %s", labelValue)
}
}

func TestNewDescInvalidVariableLabelName(t *testing.T) {
labelValue := "__label__"
desc := NewDesc(
"sample_label",
"sample label",
[]string{labelValue},
Labels{"a": "b"},
)
if desc.Err() == nil {
t.Errorf("NewDesc: expected error because variable label name is invalid: %s", labelValue)
}
}

Expand All @@ -36,8 +50,8 @@ func TestNewDescNilLabelValues(t *testing.T) {
nil,
nil,
)
if desc.err != nil {
t.Errorf("NewDesc: unexpected error: %s", desc.err)
if desc.Err() != nil {
t.Errorf("NewDesc: unexpected error: %s", desc.Err())
}
}

Expand Down
Loading