Skip to content

distributor: add new metrics #4367

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

Merged
merged 1 commit into from
Aug 12, 2025
+44 −9
Merged

distributor: add new metrics #4367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 17 additions & 6 deletions pkg/distributor/distributor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,11 @@ func (d *Distributor) pushSeries(ctx context.Context, req *distributormodel.Prof
}
sort.Sort(phlaremodel.Labels(req.Labels))

d.calculateRequestSize(req)
req.TotalProfiles = 1
req.TotalBytesUncompressed = calculateRequestSize(req)
req.TotalBytesUncompressedProcessed = req.TotalBytesUncompressed

d.metrics.receivedDecompressedBytesTotal.WithLabelValues(tenantID).Observe(float64(req.TotalBytesUncompressed))

if err := d.checkIngestLimit(req); err != nil {
level.Debug(logger).Log("msg", "rejecting push request due to global ingest limit", "tenant", tenantID)
Expand Down Expand Up @@ -391,6 +395,9 @@ func (d *Distributor) pushSeries(ctx context.Context, req *distributormodel.Prof
}

profLanguage := d.GetProfileLanguage(req)
defer func() { // defer to allow re-calculate the size of the profile after normalization
d.metrics.processedDecompressedBytes.WithLabelValues(tenantID).Observe(float64(req.TotalBytesUncompressedProcessed))
}()

usagestats.NewCounter(fmt.Sprintf("distributor_profile_type_%s_received", profName)).Inc(1)
d.profileReceivedStats.Inc(1, profLanguage)
Expand Down Expand Up @@ -428,6 +435,8 @@ func (d *Distributor) pushSeries(ctx context.Context, req *distributormodel.Prof
req.Profile.Normalize()
sp.Finish()

req.TotalBytesUncompressedProcessed = calculateRequestSize(req)

if len(req.Profile.Sample) == 0 {
// TODO(kolesnikovae):
// Normalization may cause all profiles and series to be empty.
Expand Down Expand Up @@ -847,14 +856,16 @@ func (d *Distributor) rateLimit(tenantID string, req *distributormodel.ProfileSe
return nil
}

func (d *Distributor) calculateRequestSize(req *distributormodel.ProfileSeries) {
func calculateRequestSize(req *distributormodel.ProfileSeries) int64 {
// include the labels in the size calculation
bs := int64(0)
for _, lbs := range req.Labels {
req.TotalBytesUncompressed += int64(len(lbs.Name))
req.TotalBytesUncompressed += int64(len(lbs.Value))
bs += int64(len(lbs.Name))
bs += int64(len(lbs.Value))
}
req.TotalProfiles += 1
req.TotalBytesUncompressed += int64(req.Profile.SizeVT())

bs += int64(req.Profile.SizeVT())
return bs
}

func (d *Distributor) checkIngestLimit(req *distributormodel.ProfileSeries) error {
Expand Down
25 changes: 24 additions & 1 deletion pkg/distributor/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ type metrics struct {
receivedSamplesBytes *prometheus.HistogramVec
receivedSymbolsBytes *prometheus.HistogramVec
replicationFactor prometheus.Gauge

receivedDecompressedBytesTotal *prometheus.HistogramVec
processedDecompressedBytes *prometheus.HistogramVec
}

func newMetrics(reg prometheus.Registerer) *metrics {
Expand All @@ -39,7 +42,7 @@ func newMetrics(reg prometheus.Registerer) *metrics {
prometheus.HistogramOpts{
Namespace: "pyroscope",
Name: "distributor_received_decompressed_bytes",
Help: "The number of decompressed bytes per profiles received by the distributor.",
Help: "The number of decompressed bytes per profiles received by the distributor after limits/sampling checks.",
Buckets: prometheus.ExponentialBucketsRange(minBytes, maxBytes, bucketsCount),
},
[]string{"type", "tenant"},
Expand Down Expand Up @@ -71,6 +74,24 @@ func newMetrics(reg prometheus.Registerer) *metrics {
},
[]string{"type", "tenant"},
),
receivedDecompressedBytesTotal: prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Namespace: "pyroscope",
Name: "distributor_received_decompressed_bytes_total",
Copy link
Contributor

Choose a reason for hiding this comment

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

I expect this to be confused with the existing metric because they have an overlapping name, but I can't think of a better name. Perhaps once we validate that this metric works the way we want, we can remove or rename the existing one (potentially breaking dashboards in the process).

Help: "The total number of decompressed bytes per profile received by the distributor before limits/sampling checks.",
Buckets: prometheus.ExponentialBucketsRange(minBytes, maxBytes, bucketsCount),
},
[]string{"tenant"},
),
processedDecompressedBytes: prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Namespace: "pyroscope",
Name: "distributor_processed_decompressed_bytes",
Help: "The number of decompressed bytes per profile received (processed) by the distributor after limits/sampling checks and normalization.",
Buckets: prometheus.ExponentialBucketsRange(minBytes, maxBytes, bucketsCount),
},
[]string{"tenant"},
),
}
if reg != nil {
reg.MustRegister(
Expand All @@ -80,6 +101,8 @@ func newMetrics(reg prometheus.Registerer) *metrics {
m.receivedSamplesBytes,
m.receivedSymbolsBytes,
m.replicationFactor,
m.receivedDecompressedBytesTotal,
m.processedDecompressedBytes,
)
}
return m
Expand Down
5 changes: 3 additions & 2 deletions pkg/distributor/model/push.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ type ProfileSeries struct {

Annotations []*v1.ProfileAnnotation

// always 1
// always 1 todo delete
TotalProfiles int64
TotalBytesUncompressed int64

TotalBytesUncompressedProcessed int64 // after normalization and other size-reducing manipulation

DiscardedProfilesRelabeling int64
DiscardedBytesRelabeling int64
}
Expand Down Expand Up @@ -80,7 +82,6 @@ func getProfileLanguageFromSpy(spyName string) string {
func (req *ProfileSeries) Clone() *ProfileSeries {
c := &ProfileSeries{
TenantID: req.TenantID,
TotalProfiles: req.TotalProfiles,
TotalBytesUncompressed: req.TotalBytesUncompressed,
Labels: phlaremodel.Labels(req.Labels).Clone(),
Profile: &pprof.Profile{Profile: req.Profile.CloneVT()},
Expand Down
Loading