Add active series to all user stats page

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## master / unreleased
 
+* [FEATURE] Ingester: Add active series to all_user_stats page. #4972
+
 ## 1.14.0 in progress
 
   **This release removes support for chunks storage. See below for more.**

pkg/distributor/distributor.go

@@ -1189,10 +1189,13 @@ func (d *Distributor) UserStats(ctx context.Context) (*UserStats, error) {
 		totalStats.APIIngestionRate += r.ApiIngestionRate
 		totalStats.RuleIngestionRate += r.RuleIngestionRate
 		totalStats.NumSeries += r.NumSeries
+		totalStats.ActiveSeries += r.ActiveSeries
 	}
 
-	totalStats.IngestionRate /= float64(d.ingestersRing.ReplicationFactor())
-	totalStats.NumSeries /= uint64(d.ingestersRing.ReplicationFactor())
+	factor := d.ingestersRing.ReplicationFactor()
+	totalStats.IngestionRate /= float64(factor)
+	totalStats.NumSeries /= uint64(factor)
+	totalStats.ActiveSeries /= uint64(factor)
 
 	return totalStats, nil
 }
@@ -1231,6 +1234,7 @@ func (d *Distributor) AllUserStats(ctx context.Context) ([]UserIDStats, error) {
 			s.APIIngestionRate += u.Data.ApiIngestionRate
 			s.RuleIngestionRate += u.Data.RuleIngestionRate
 			s.NumSeries += u.Data.NumSeries
+			s.ActiveSeries += u.Data.ActiveSeries
 			perUserTotals[u.UserId] = s
 		}
 	}
@@ -1245,6 +1249,7 @@ func (d *Distributor) AllUserStats(ctx context.Context) ([]UserIDStats, error) {
 				APIIngestionRate:  stats.APIIngestionRate,
 				RuleIngestionRate: stats.RuleIngestionRate,
 				NumSeries:         stats.NumSeries,
+				ActiveSeries:      stats.ActiveSeries,
 			},
 		})
 	}

pkg/distributor/http_admin.go

@@ -30,6 +30,7 @@ const tpl = `
 					<tr>
 						<th>User</th>
 						<th># Series</th>
+						<th># Active Series</th>
 						<th>Total Ingest Rate</th>
 						<th>API Ingest Rate</th>
 						<th>Rule Ingest Rate</th>
@@ -40,6 +41,7 @@ const tpl = `
 					<tr>
 						<td>{{ .UserID }}</td>
 						<td align='right'>{{ .UserStats.NumSeries }}</td>
+						<td align='right'>{{ .UserStats.ActiveSeries }}</td>
 						<td align='right'>{{ printf "%.2f" .UserStats.IngestionRate }}</td>
 						<td align='right'>{{ printf "%.2f" .UserStats.APIIngestionRate }}</td>
 						<td align='right'>{{ printf "%.2f" .UserStats.RuleIngestionRate }}</td>

pkg/distributor/http_server.go

@@ -12,6 +12,7 @@ type UserStats struct {
 	NumSeries         uint64  `json:"numSeries"`
 	APIIngestionRate  float64 `json:"APIIngestionRate"`
 	RuleIngestionRate float64 `json:"RuleIngestionRate"`
+	ActiveSeries      uint64  `json:"activeSeries"`
 }
 
 // UserStatsHandler handles user stats to the Distributor.

pkg/ingester/client/ingester.proto

@@ -97,6 +97,7 @@ message UserStatsResponse {
   uint64 num_series = 2;
   double api_ingestion_rate = 3;
   double rule_ingestion_rate = 4;
+  uint64 active_series = 5;
 }
 
 message UserIDStatsResponse {

pkg/ingester/ingester.go

@@ -1553,7 +1553,7 @@ func (i *Ingester) UserStats(ctx context.Context, req *client.UserStatsRequest)
 		return &client.UserStatsResponse{}, nil
 	}
 
-	return createUserStats(db), nil
+	return createUserStats(db, i.cfg.ActiveSeriesMetricsEnabled), nil
 }
 
 // AllUserStats returns ingestion statistics for all users known to this ingester.
@@ -1573,20 +1573,27 @@ func (i *Ingester) AllUserStats(_ context.Context, _ *client.UserStatsRequest) (
 	for userID, db := range users {
 		response.Stats = append(response.Stats, &client.UserIDStatsResponse{
 			UserId: userID,
-			Data:   createUserStats(db),
+			Data:   createUserStats(db, i.cfg.ActiveSeriesMetricsEnabled),
 		})
 	}
 	return response, nil
 }
 
-func createUserStats(db *userTSDB) *client.UserStatsResponse {
+func createUserStats(db *userTSDB, activeSeriesMetricsEnabled bool) *client.UserStatsResponse {
 	apiRate := db.ingestedAPISamples.Rate()
 	ruleRate := db.ingestedRuleSamples.Rate()
+
+	var activeSeries uint64
+	if activeSeriesMetricsEnabled {
+		activeSeries = uint64(db.activeSeries.Active())
+	}
+
 	return &client.UserStatsResponse{
 		IngestionRate:     apiRate + ruleRate,
 		ApiIngestionRate:  apiRate,
 		RuleIngestionRate: ruleRate,
 		NumSeries:         db.Head().NumSeries(),
+		ActiveSeries:      activeSeries,
 	}
 }
 

pkg/ingester/ingester_test.go

@@ -3193,6 +3193,7 @@ func Test_Ingester_AllUserStats(t *testing.T) {
 				NumSeries:         3,
 				ApiIngestionRate:  0.2,
 				RuleIngestionRate: 0,
+				ActiveSeries:      3,
 			},
 		},
 		{
@@ -3202,6 +3203,7 @@ func Test_Ingester_AllUserStats(t *testing.T) {
 				NumSeries:         2,
 				ApiIngestionRate:  0.13333333333333333,
 				RuleIngestionRate: 0,
+				ActiveSeries:      2,
 			},
 		},
 	}