|
| 1 | +// SPDX-License-Identifier: AGPL-3.0-only |
| 2 | +//go:build requires_docker |
| 3 | + |
| 4 | +package integration |
| 5 | + |
| 6 | +import ( |
| 7 | + "encoding/json" |
| 8 | + "fmt" |
| 9 | + "net/http" |
| 10 | + "net/url" |
| 11 | + "sort" |
| 12 | + "testing" |
| 13 | + "time" |
| 14 | + |
| 15 | + "github.com/grafana/e2e" |
| 16 | + e2edb "github.com/grafana/e2e/db" |
| 17 | + "github.com/prometheus/prometheus/model/labels" |
| 18 | + "github.com/prometheus/prometheus/prompb" |
| 19 | + "github.com/stretchr/testify/assert" |
| 20 | + "github.com/stretchr/testify/require" |
| 21 | + |
| 22 | + "github.com/grafana/mimir/integration/e2emimir" |
| 23 | +) |
| 24 | + |
| 25 | +func TestQuerierInfoLabels(t *testing.T) { |
| 26 | + s, err := e2e.NewScenario(networkName) |
| 27 | + require.NoError(t, err) |
| 28 | + defer s.Close() |
| 29 | + |
| 30 | + // Start dependencies. |
| 31 | + consul := e2edb.NewConsul() |
| 32 | + require.NoError(t, s.StartAndWaitReady(consul)) |
| 33 | + |
| 34 | + flags := mergeFlags(BlocksStorageFlags(), BlocksStorageS3Flags(), map[string]string{}) |
| 35 | + |
| 36 | + // Start minio. |
| 37 | + minio := e2edb.NewMinio(9000, flags["-blocks-storage.s3.bucket-name"]) |
| 38 | + require.NoError(t, s.StartAndWaitReady(minio)) |
| 39 | + |
| 40 | + // Start Mimir components. |
| 41 | + distributor := e2emimir.NewDistributor("distributor", consul.NetworkHTTPEndpoint(), flags) |
| 42 | + ingester := e2emimir.NewIngester("ingester", consul.NetworkHTTPEndpoint(), flags) |
| 43 | + querier := e2emimir.NewQuerier("querier", consul.NetworkHTTPEndpoint(), flags) |
| 44 | + require.NoError(t, s.StartAndWaitReady(distributor, ingester, querier)) |
| 45 | + |
| 46 | + // Wait until distributor and querier have updated the ring. |
| 47 | + require.NoError(t, distributor.WaitSumMetricsWithOptions(e2e.Equals(1), []string{"cortex_ring_members"}, e2e.WithLabelMatchers( |
| 48 | + labels.MustNewMatcher(labels.MatchEqual, "name", "ingester"), |
| 49 | + labels.MustNewMatcher(labels.MatchEqual, "state", "ACTIVE")))) |
| 50 | + require.NoError(t, querier.WaitSumMetricsWithOptions(e2e.Equals(1), []string{"cortex_ring_members"}, e2e.WithLabelMatchers( |
| 51 | + labels.MustNewMatcher(labels.MatchEqual, "name", "ingester"), |
| 52 | + labels.MustNewMatcher(labels.MatchEqual, "state", "ACTIVE")))) |
| 53 | + |
| 54 | + // Create client for pushing and querying. |
| 55 | + client, err := e2emimir.NewClient(distributor.HTTPEndpoint(), querier.HTTPEndpoint(), "", "", userID) |
| 56 | + require.NoError(t, err) |
| 57 | + |
| 58 | + now := time.Now() |
| 59 | + |
| 60 | + // Push target_info metrics with data labels. |
| 61 | + // target_info is the standard info metric that contains identifying labels (job, instance) |
| 62 | + // and data labels (version, commit, etc.) that describe the target. |
| 63 | + targetInfoSeries := []prompb.TimeSeries{ |
| 64 | + { |
| 65 | + Labels: []prompb.Label{ |
| 66 | + {Name: "__name__", Value: "target_info"}, |
| 67 | + {Name: "job", Value: "prometheus"}, |
| 68 | + {Name: "instance", Value: "localhost:9090"}, |
| 69 | + {Name: "version", Value: "2.45.0"}, |
| 70 | + {Name: "commit", Value: "abc123"}, |
| 71 | + }, |
| 72 | + Samples: []prompb.Sample{{Value: 1, Timestamp: now.UnixMilli()}}, |
| 73 | + }, |
| 74 | + { |
| 75 | + Labels: []prompb.Label{ |
| 76 | + {Name: "__name__", Value: "target_info"}, |
| 77 | + {Name: "job", Value: "prometheus"}, |
| 78 | + {Name: "instance", Value: "localhost:9091"}, |
| 79 | + {Name: "version", Value: "2.44.0"}, |
| 80 | + {Name: "commit", Value: "def456"}, |
| 81 | + }, |
| 82 | + Samples: []prompb.Sample{{Value: 1, Timestamp: now.UnixMilli()}}, |
| 83 | + }, |
| 84 | + { |
| 85 | + Labels: []prompb.Label{ |
| 86 | + {Name: "__name__", Value: "target_info"}, |
| 87 | + {Name: "job", Value: "grafana"}, |
| 88 | + {Name: "instance", Value: "localhost:3000"}, |
| 89 | + {Name: "version", Value: "10.0.0"}, |
| 90 | + {Name: "edition", Value: "oss"}, |
| 91 | + }, |
| 92 | + Samples: []prompb.Sample{{Value: 1, Timestamp: now.UnixMilli()}}, |
| 93 | + }, |
| 94 | + } |
| 95 | + |
| 96 | + // Also push a build_info metric to test metric_match parameter. |
| 97 | + buildInfoSeries := []prompb.TimeSeries{ |
| 98 | + { |
| 99 | + Labels: []prompb.Label{ |
| 100 | + {Name: "__name__", Value: "build_info"}, |
| 101 | + {Name: "job", Value: "mimir"}, |
| 102 | + {Name: "instance", Value: "localhost:8080"}, |
| 103 | + {Name: "branch", Value: "main"}, |
| 104 | + {Name: "goversion", Value: "go1.21.0"}, |
| 105 | + }, |
| 106 | + Samples: []prompb.Sample{{Value: 1, Timestamp: now.UnixMilli()}}, |
| 107 | + }, |
| 108 | + } |
| 109 | + |
| 110 | + // Push all series. |
| 111 | + res, err := client.Push(targetInfoSeries) |
| 112 | + require.NoError(t, err) |
| 113 | + require.Equal(t, http.StatusOK, res.StatusCode) |
| 114 | + |
| 115 | + res, err = client.Push(buildInfoSeries) |
| 116 | + require.NoError(t, err) |
| 117 | + require.Equal(t, http.StatusOK, res.StatusCode) |
| 118 | + |
| 119 | + t.Run("basic info_labels query returns data labels from target_info", func(t *testing.T) { |
| 120 | + result, err := queryInfoLabels(client, querier.HTTPEndpoint(), nil) |
| 121 | + require.NoError(t, err) |
| 122 | + |
| 123 | + // Should return data labels from target_info (excludes identifying labels like job, instance, __name__) |
| 124 | + // Data labels are: version, commit, edition |
| 125 | + assert.Contains(t, result, "version") |
| 126 | + assert.Contains(t, result, "commit") |
| 127 | + assert.Contains(t, result, "edition") |
| 128 | + |
| 129 | + // Verify values are sorted and correct |
| 130 | + sort.Strings(result["version"]) |
| 131 | + assert.Equal(t, []string{"10.0.0", "2.44.0", "2.45.0"}, result["version"]) |
| 132 | + }) |
| 133 | + |
| 134 | + t.Run("info_labels with metric_match returns data labels from specified info metric", func(t *testing.T) { |
| 135 | + result, err := queryInfoLabels(client, querier.HTTPEndpoint(), map[string]string{ |
| 136 | + "metric_match": "build_info", |
| 137 | + }) |
| 138 | + require.NoError(t, err) |
| 139 | + |
| 140 | + // Should return data labels from build_info |
| 141 | + assert.Contains(t, result, "branch") |
| 142 | + assert.Contains(t, result, "goversion") |
| 143 | + assert.Equal(t, []string{"main"}, result["branch"]) |
| 144 | + assert.Equal(t, []string{"go1.21.0"}, result["goversion"]) |
| 145 | + |
| 146 | + // Should NOT contain target_info labels |
| 147 | + assert.NotContains(t, result, "version") |
| 148 | + assert.NotContains(t, result, "commit") |
| 149 | + }) |
| 150 | + |
| 151 | + t.Run("info_labels with match[] filters to base metrics", func(t *testing.T) { |
| 152 | + result, err := queryInfoLabels(client, querier.HTTPEndpoint(), map[string]string{ |
| 153 | + "match[]": `{job="prometheus"}`, |
| 154 | + }) |
| 155 | + require.NoError(t, err) |
| 156 | + |
| 157 | + // Should only return labels from target_info series where job=prometheus |
| 158 | + assert.Contains(t, result, "version") |
| 159 | + assert.Contains(t, result, "commit") |
| 160 | + |
| 161 | + // Should have prometheus versions only |
| 162 | + sort.Strings(result["version"]) |
| 163 | + assert.Equal(t, []string{"2.44.0", "2.45.0"}, result["version"]) |
| 164 | + |
| 165 | + // Should NOT have grafana-specific labels |
| 166 | + assert.NotContains(t, result, "edition") |
| 167 | + }) |
| 168 | + |
| 169 | + t.Run("info_labels with limit truncates values", func(t *testing.T) { |
| 170 | + result, err := queryInfoLabels(client, querier.HTTPEndpoint(), map[string]string{ |
| 171 | + "limit": "1", |
| 172 | + }) |
| 173 | + require.NoError(t, err) |
| 174 | + |
| 175 | + // Each label should have at most 1 value due to limit |
| 176 | + for labelName, values := range result { |
| 177 | + assert.LessOrEqual(t, len(values), 1, "label %s should have at most 1 value", labelName) |
| 178 | + } |
| 179 | + }) |
| 180 | + |
| 181 | + t.Run("info_labels with time range", func(t *testing.T) { |
| 182 | + // Query with a time range that includes our data |
| 183 | + start := now.Add(-1 * time.Hour) |
| 184 | + end := now.Add(1 * time.Hour) |
| 185 | + result, err := queryInfoLabels(client, querier.HTTPEndpoint(), map[string]string{ |
| 186 | + "start": fmt.Sprintf("%d", start.Unix()), |
| 187 | + "end": fmt.Sprintf("%d", end.Unix()), |
| 188 | + }) |
| 189 | + require.NoError(t, err) |
| 190 | + |
| 191 | + // Should return data |
| 192 | + assert.NotEmpty(t, result) |
| 193 | + assert.Contains(t, result, "version") |
| 194 | + }) |
| 195 | +} |
| 196 | + |
| 197 | +// infoLabelsResponse represents the API response from /api/v1/info_labels. |
| 198 | +type infoLabelsResponse struct { |
| 199 | + Status string `json:"status"` |
| 200 | + Data map[string][]string `json:"data"` |
| 201 | +} |
| 202 | + |
| 203 | +// queryInfoLabels queries the /api/v1/info_labels endpoint with optional parameters. |
| 204 | +func queryInfoLabels(client *e2emimir.Client, querierAddress string, params map[string]string) (map[string][]string, error) { |
| 205 | + u, err := url.Parse(fmt.Sprintf("http://%s/prometheus/api/v1/info_labels", querierAddress)) |
| 206 | + if err != nil { |
| 207 | + return nil, err |
| 208 | + } |
| 209 | + |
| 210 | + q := u.Query() |
| 211 | + for k, v := range params { |
| 212 | + q.Set(k, v) |
| 213 | + } |
| 214 | + u.RawQuery = q.Encode() |
| 215 | + |
| 216 | + resp, body, err := client.DoGetBody(u.String()) |
| 217 | + if err != nil { |
| 218 | + return nil, err |
| 219 | + } |
| 220 | + |
| 221 | + if resp.StatusCode != http.StatusOK { |
| 222 | + return nil, fmt.Errorf("unexpected status code: %d, body: %s", resp.StatusCode, string(body)) |
| 223 | + } |
| 224 | + |
| 225 | + var result infoLabelsResponse |
| 226 | + if err := json.Unmarshal(body, &result); err != nil { |
| 227 | + return nil, fmt.Errorf("failed to unmarshal response: %w, body: %s", err, string(body)) |
| 228 | + } |
| 229 | + |
| 230 | + if result.Status != "success" { |
| 231 | + return nil, fmt.Errorf("unexpected status: %s", result.Status) |
| 232 | + } |
| 233 | + |
| 234 | + return result.Data, nil |
| 235 | +} |
0 commit comments