Skip to content
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

Jump to bottom

Support matchers in labels API #828

Merged
merged 2 commits into from Feb 11, 2021
Merged

Support matchers in labels API #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75d7516
support matchers in labels API
yeya24 Dec 29, 2020
595a1d5
update comment
yeya24 Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 12 additions & 6 deletions api/prometheus/v1/api.go
View file
Open in desktop
Expand Up @@ -230,10 +230,10 @@ type API interface {
DeleteSeries(ctx context.Context, matches []string, startTime time.Time, endTime time.Time) error
// Flags returns the flag values that Prometheus was launched with.
Flags(ctx context.Context) (FlagsResult, error)
// LabelNames returns all the unique label names present in the block in sorted order.
LabelNames(ctx context.Context, startTime time.Time, endTime time.Time) ([]string, Warnings, error)
// LabelValues performs a query for the values of the given label.
LabelValues(ctx context.Context, label string, startTime time.Time, endTime time.Time) (model.LabelValues, Warnings, error)
// LabelNames returns the unique label names present in the block in sorted order by given time range and matchers.
LabelNames(ctx context.Context, matches []string, startTime time.Time, endTime time.Time) ([]string, Warnings, error)
Copy link
Member

Choose a reason for hiding this comment

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

This is technically a breaking change. I am not sure what are the rules for this project cc @beorn7

Do we allow this or not in single major version?

Copy link
Member

Choose a reason for hiding this comment

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

The whole API client is marked as experimental and not covered by the semantic versioning.

(In fact, I'd much prefer to have the API client on a separate release schedule. But as long as the API client is effectively pre-1.0, it doesn't really matter. Once we are ready to declare the API client as stable, we can revisit the decision if we want to keep it bundled with the rest of client_golang or separate it out (into a new repo or a separate Go module in a sub-directory).)

// LabelValues performs a query for the values of the given label, time range and matchers.
LabelValues(ctx context.Context, label string, matches []string, startTime time.Time, endTime time.Time) (model.LabelValues, Warnings, error)
// Query performs a query for the given time.
Query(ctx context.Context, query string, ts time.Time) (model.Value, Warnings, error)
// QueryRange performs a query for the given range.
Expand Down Expand Up @@ -691,11 +691,14 @@ func (h *httpAPI) Runtimeinfo(ctx context.Context) (RuntimeinfoResult, error) {
return res, json.Unmarshal(body, &res)
}

func (h *httpAPI) LabelNames(ctx context.Context, startTime time.Time, endTime time.Time) ([]string, Warnings, error) {
func (h *httpAPI) LabelNames(ctx context.Context, matches []string, startTime time.Time, endTime time.Time) ([]string, Warnings, error) {
u := h.client.URL(epLabels, nil)
q := u.Query()
q.Set("start", formatTime(startTime))
q.Set("end", formatTime(endTime))
for _, m := range matches {
q.Add("match[]", m)
}

u.RawQuery = q.Encode()

Expand All @@ -711,11 +714,14 @@ func (h *httpAPI) LabelNames(ctx context.Context, startTime time.Time, endTime t
return labelNames, w, json.Unmarshal(body, &labelNames)
}

func (h *httpAPI) LabelValues(ctx context.Context, label string, startTime time.Time, endTime time.Time) (model.LabelValues, Warnings, error) {
func (h *httpAPI) LabelValues(ctx context.Context, label string, matches []string, startTime time.Time, endTime time.Time) (model.LabelValues, Warnings, error) {
u := h.client.URL(epLabelValues, map[string]string{"name": label})
q := u.Query()
q.Set("start", formatTime(startTime))
q.Set("end", formatTime(endTime))
for _, m := range matches {
q.Add("match[]", m)
}

u.RawQuery = q.Encode()

Expand Down
40 changes: 28 additions & 12 deletions api/prometheus/v1/api_test.go
View file
Open in desktop
Expand Up @@ -151,15 +151,15 @@ func TestAPIs(t *testing.T) {
}
}

doLabelNames := func(label string) func() (interface{}, Warnings, error) {
doLabelNames := func(matches []string) func() (interface{}, Warnings, error) {
return func() (interface{}, Warnings, error) {
return promAPI.LabelNames(context.Background(), time.Now().Add(-100*time.Hour), time.Now())
return promAPI.LabelNames(context.Background(), matches, time.Now().Add(-100*time.Hour), time.Now())
}
}

doLabelValues := func(label string) func() (interface{}, Warnings, error) {
doLabelValues := func(matches []string, label string) func() (interface{}, Warnings, error) {
return func() (interface{}, Warnings, error) {
return promAPI.LabelValues(context.Background(), label, time.Now().Add(-100*time.Hour), time.Now())
return promAPI.LabelValues(context.Background(), label, matches, time.Now().Add(-100*time.Hour), time.Now())
}
}

Expand Down Expand Up @@ -359,14 +359,14 @@ func TestAPIs(t *testing.T) {
},

{
do: doLabelNames("mylabel"),
do: doLabelNames(nil),
inRes: []string{"val1", "val2"},
reqMethod: "GET",
reqPath: "/api/v1/labels",
res: []string{"val1", "val2"},
},
{
do: doLabelNames("mylabel"),
do: doLabelNames(nil),
inRes: []string{"val1", "val2"},
inWarnings: []string{"a"},
reqMethod: "GET",
Expand All @@ -376,31 +376,39 @@ func TestAPIs(t *testing.T) {
},

{
do: doLabelNames("mylabel"),
do: doLabelNames(nil),
inErr: fmt.Errorf("some error"),
reqMethod: "GET",
reqPath: "/api/v1/labels",
err: fmt.Errorf("some error"),
},
{
do: doLabelNames("mylabel"),
do: doLabelNames(nil),
inErr: fmt.Errorf("some error"),
inWarnings: []string{"a"},
reqMethod: "GET",
reqPath: "/api/v1/labels",
err: fmt.Errorf("some error"),
warnings: []string{"a"},
},
{
do: doLabelNames([]string{"up"}),
inRes: []string{"val1", "val2"},
reqMethod: "GET",
reqPath: "/api/v1/labels",
reqParam: url.Values{"match[]": {"up"}},
res: []string{"val1", "val2"},
},

{
do: doLabelValues("mylabel"),
do: doLabelValues(nil, "mylabel"),
inRes: []string{"val1", "val2"},
reqMethod: "GET",
reqPath: "/api/v1/label/mylabel/values",
res: model.LabelValues{"val1", "val2"},
},
{
do: doLabelValues("mylabel"),
do: doLabelValues(nil, "mylabel"),
inRes: []string{"val1", "val2"},
inWarnings: []string{"a"},
reqMethod: "GET",
Expand All @@ -410,21 +418,29 @@ func TestAPIs(t *testing.T) {
},

{
do: doLabelValues("mylabel"),
do: doLabelValues(nil, "mylabel"),
inErr: fmt.Errorf("some error"),
reqMethod: "GET",
reqPath: "/api/v1/label/mylabel/values",
err: fmt.Errorf("some error"),
},
{
do: doLabelValues("mylabel"),
do: doLabelValues(nil, "mylabel"),
inErr: fmt.Errorf("some error"),
inWarnings: []string{"a"},
reqMethod: "GET",
reqPath: "/api/v1/label/mylabel/values",
err: fmt.Errorf("some error"),
warnings: []string{"a"},
},
{
do: doLabelValues([]string{"up"}, "mylabel"),
inRes: []string{"val1", "val2"},
reqMethod: "GET",
reqPath: "/api/v1/label/mylabel/values",
reqParam: url.Values{"match[]": {"up"}},
res: model.LabelValues{"val1", "val2"},
},

{
do: doSeries("up", testTime.Add(-time.Minute), testTime),
Expand Down