feat: Add metrics support by aldy505 · Pull Request #1151 · getsentry/sentry-go

aldy505 · 2025-11-30T05:00:51Z

Description

Implement metrics based on https://develop.sentry.dev/sdk/telemetry/metrics/ and https://develop.sentry.dev/sdk/data-model/envelope-items/#trace-metric

Issues

Closes Sentry Metrics for Go #1136
Closes GO-99

Usage example

ctx := context.Background()
meter := sentry.NewMeter(ctx)
// Attaching permanent attributes on the meter
meter.SetAttributes(
	attribute.String("version", "1.0.0"),
)

meter.Distribution("file_upload_size", 3.14,
	sentry.WithUnit(sentry.UnitMegabyte), // Using standard unit constants
	sentry.WithAttributes(
		attribute.String("file.type", "image/png"),
		attribute.String("bucket.region", "us-west-2"),
		attribute.String("bucket.name", "user-uploads"),
	),
)

Changelog Entry

Add metric support
- support for three metric methods (counter, gauge, distribution)
- custom metric units
- unexport batchlogger

interfaces.go

internal/protocol/metric_batch.go

codecov · 2026-01-12T16:04:19Z

Codecov Report

❌ Patch coverage is 81.14754% with 92 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.46%. Comparing base (1ce3436) to head (fd95f1b).
⚠️ Report is 16 commits behind head on master.

Files with missing lines	Patch %	Lines
interfaces.go	75.51%	20 Missing and 4 partials ⚠️
transport.go	16.66%	20 Missing ⚠️
scope.go	70.00%	6 Missing and 6 partials ⚠️
metrics.go	91.59%	6 Missing and 4 partials ⚠️
client.go	50.00%	7 Missing ⚠️
internal/protocol/metric_batch.go	70.00%	3 Missing and 3 partials ⚠️
internal/telemetry/scheduler.go	64.28%	3 Missing and 2 partials ⚠️
metric_batch_processor.go	71.42%	2 Missing and 2 partials ⚠️
internal/protocol/envelope.go	83.33%	1 Missing and 1 partial ⚠️
log_batch_processor.go	85.71%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1151      +/-   ##
==========================================
- Coverage   86.04%   85.46%   -0.58%     
==========================================
  Files          62       67       +5     
  Lines        6090     6509     +419     
==========================================
+ Hits         5240     5563     +323     
- Misses        635      708      +73     
- Partials      215      238      +23

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

interfaces.go

batch_processor.go

aldy505 · 2026-01-15T00:43:34Z

interfaces.go

+	// Count records a count metric.
+	Count(name string, count int64, options MeterOptions)
+	// Gauge records a gauge metric.
+	Gauge(name string, value float64, options MeterOptions)


@giortzisg Gauge can accept normal integers (non-floats), that's why I created the Numbers interface above.

I know, but the generic solution didn't make much sense. It didn't apply to Count and Dist and in most cases you would need float64 anyways for most calculations, so it is extra verbose for no reason. Type casting in some cases is fine, but I might introduce also a GaugeInt and some other convenience methods.

The convenience methods would be nice!

On another note, I was thinking it's because of JSON serialization for float64 and int differences.

JSON serialization for float64 and int differences.

That still is a problem, but doesn't get solved by generics. Count should be an int and Gauge/Dist floats, so the problem is storing and converting without precision loss between count/gauge/dist metric events.

github-actions · 2026-01-20T14:07:49Z

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

New Features ✨

Add metric support by aldy505 in #1151

support for three metric methods (counter, gauge, distribution)

custom metric units

unexport batchlogger

Add metric support by aldy505 in #1151
- support for three metric methods (counter, gauge, distribution)
- custom metric units
- unexport batchlogger

Internal Changes 🔧

Release

Fix changelog-preview permissions by BYK in #1181
Switch from action-prepare-release to Craft by BYK in #1167

Other

(repo) Add Claude Code settings with basic permissions by philipphofmann in #1175
Update release and changelog-preview workflows by giortzisg in #1177
Bump echo to 4.10.1 by giortzisg in #1174

_{🤖 This preview updates automatically when you update the PR.}

transport.go

internal/protocol/envelope.go

internal/protocol/metric_batch.go

batch_processor.go

interfaces.go

metrics.go

scope.go

The previous batch_processor implementation needed to stop and read the timer so that any stale data was cleared. From go1.23 and on, the time.Timer uses an unbuffered channel, meaning that we can remove both reading and stop(), which simplifies the batch_processor significantly.

batch_processor.go

Litarnus

LGTM

aldy505 · 2026-01-22T15:13:59Z

_examples/metrics/main.go

+	sentryhttp "github.com/getsentry/sentry-go/http"
+)
+
+var meter sentry.Meter


Nooo don't do this. It looks a lot like otel.

aldy505 · 2026-01-22T15:15:51Z

interfaces.go

 	"github.com/getsentry/sentry-go/internal/ratelimit"
 )

+const errorType = ""


What is this for? Providing comment would be great.

the errorType if an empty string if you have a look at how the sdk currently works. Just added the type so that it makes more sense.

aldy505 · 2026-01-22T15:18:48Z

interfaces_test.go

+			name: "metric event",
+			event: &Event{
+				EventID: "12345678901234567890123456789012",
+				Type:    "trace_metric",
+				Metrics: []Metric{
+					{
+						Name:      "test.metric",
+						Value:     Int64MetricValue(42),
+						Timestamp: time.Date(2023, 1, 1, 12, 0, 0, 0, time.UTC),
+						Type:      MetricTypeCounter,
+					},
+				},


We should also test for invalid and nil MetricValue, as well as invalid metric type (other than count, dist, gauge)

internal/protocol/envelope.go

aldy505 · 2026-01-22T15:20:41Z

internal/testutils/maps.go

+// If there are duplicate keys, the value from the last map takes precedence.
+//
+// CC BY-SA 4.0 Oliver (https://stackoverflow.com/a/74750675/3153224)
+func MergeMaps[M ~map[K]V, K comparable, V any](src ...M) M {


We can safely remove this if this is not used.

aldy505 · 2026-01-22T15:21:44Z

metrics.go

+// Duration Units.
+const (
+	UnitNanosecond  = "nanosecond"
+	UnitMicrosecond = "microsecond"
+	UnitMillisecond = "millisecond"
+	UnitSecond      = "second"
+	UnitMinute      = "minute"
+	UnitHour        = "hour"
+	UnitDay         = "day"
+	UnitWeek        = "week"
+)


I would prefer to have this as a type of it's own, better for static typing.

We want to receive custom units as string, but also allow the users to use the supported ones like that, so can't really have a custom type for it.

So the freedom of type/unit is intentional?

codecov · 2026-01-23T12:00:14Z

Codecov Report

❌ Patch coverage is 80.60606% with 96 lines in your changes missing coverage. Please review.
✅ Project coverage is 85.45%. Comparing base (1ce3436) to head (e143a53).
⚠️ Report is 18 commits behind head on master.

Files with missing lines	Patch %	Lines
interfaces.go	75.51%	20 Missing and 4 partials ⚠️
client.go	54.16%	17 Missing and 5 partials ⚠️
transport.go	16.66%	20 Missing ⚠️
metrics.go	93.06%	4 Missing and 3 partials ⚠️
internal/protocol/metric_batch.go	70.00%	3 Missing and 3 partials ⚠️
scope.go	84.61%	3 Missing and 3 partials ⚠️
internal/telemetry/scheduler.go	64.28%	3 Missing and 2 partials ⚠️
internal/protocol/envelope.go	83.33%	1 Missing and 1 partial ⚠️
log_batch_processor.go	84.61%	1 Missing and 1 partial ⚠️
metric_batch_processor.go	84.61%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1151      +/-   ##
==========================================
- Coverage   86.04%   85.45%   -0.60%     
==========================================
  Files          62       67       +5     
  Lines        6090     6509     +419     
==========================================
+ Hits         5240     5562     +322     
- Misses        635      709      +74     
- Partials      215      238      +23

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

client.go

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.}

_examples/metrics/main.go

aldy505 and others added 3 commits November 20, 2025 08:43

feat: initial sentry metrics

aa07a93

Merge branch 'getsentry:master' into feat/sentry-metrics

086d8c7

feat: metrics tests

2beb443

aldy505 changed the title ~~Feat/sentry metrics~~ feat: Sentry Metrics Nov 30, 2025

aldy505 added 6 commits November 30, 2025 14:37

fix: test should use their own pointers

233ffaf

chore: format

f64578e

chore: unused parameter

56b79b5

test: CurrentHub should be cloned

a03c5e4

chore: skip dupl

0517c98

fix: should count for itemrs rather than metrics

72e7595

sentry bot reviewed Nov 30, 2025

View reviewed changes

interfaces.go Outdated Show resolved Hide resolved

cursor bot reviewed Nov 30, 2025

View reviewed changes

internal/protocol/metric_batch.go Outdated Show resolved Hide resolved

aldy505 marked this pull request as draft December 30, 2025 13:38

giortzisg added 2 commits January 12, 2026 16:37

fix: serialize metrics correctly

852a524

fix: add ctx isolation for tests

b01a2c3

giortzisg added 2 commits January 13, 2026 15:20

chore: rename batch_logger to batch_processor

87956fc

feat: abstract batchProcessor functionality

8ee32f7

giortzisg force-pushed the feat/sentry-metrics branch 3 times, most recently from 345f1c0 to 8ee32f7 Compare January 14, 2026 12:00

giortzisg added 8 commits January 14, 2026 13:01

Merge remote-tracking branch 'origin/master' into feat/sentry-metrics

3fe021d

fix: renaming log

37dc253

fix: metrics issues

d00396f

feat: pre-compute default attributes

dd2dc64

add metrics tests

de750d5

add units & custom scope

88df4e9

fix debug output

4d6fec1

add batchSize and timeout on MetricsBuffer

6c41527

aldy505 commented Jan 15, 2026

View reviewed changes

sentry bot reviewed Jan 20, 2026

View reviewed changes

transport.go Outdated Show resolved Hide resolved

handle debug messages correctly

0090964

This comment was marked as outdated.

Sign in to view

giortzisg requested a review from Litarnus January 22, 2026 09:23

Litarnus reviewed Jan 22, 2026

View reviewed changes

giortzisg added 2 commits January 22, 2026 15:31

review changes

00435dc

cursor bot reviewed Jan 22, 2026

View reviewed changes

batch_processor.go Show resolved Hide resolved

Litarnus approved these changes Jan 22, 2026

View reviewed changes

aldy505 commented Jan 22, 2026

View reviewed changes

improve test coverage

fd95f1b

giortzisg added 2 commits January 26, 2026 13:53

ref: captureX should go through client

171e5bd

use customScope

e4d2455

cursor bot reviewed Jan 26, 2026

View reviewed changes

client.go Outdated Show resolved Hide resolved

giortzisg added 2 commits January 26, 2026 14:53

fix: attribute precedence

4b8e898

fix: lint

c777f23

cursor bot reviewed Jan 26, 2026

View reviewed changes

client.go Show resolved Hide resolved

giortzisg added 3 commits January 26, 2026 15:07

chore: unexport batch processors

ef19a59

fix: captureX return correct bool

a7e3095

fix: lint

7db0c36

cursor bot reviewed Jan 26, 2026

View reviewed changes

client.go Show resolved Hide resolved

fix: invert batchlogger send

ed6e4c9

cursor bot reviewed Jan 26, 2026

View reviewed changes

_examples/metrics/main.go Show resolved Hide resolved

fix: example

e143a53

giortzisg changed the title ~~feat: Sentry Metrics~~ feat: add metrics support Jan 26, 2026

giortzisg changed the title ~~feat: add metrics support~~ feat: Add metrics support Jan 26, 2026

giortzisg merged commit 5d2aa89 into getsentry:master Jan 26, 2026
22 checks passed

sentry-release-bot bot mentioned this pull request Jan 27, 2026

publish: getsentry/sentry-go@0.42.0 getsentry/publish#7000

Closed

12 tasks

Conversation

aldy505 commented Nov 30, 2025 • edited by giortzisg Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues

Usage example

Changelog Entry

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

New Features ✨

Internal Changes 🔧

Release

Other

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Litarnus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

aldy505 commented Nov 30, 2025 •

edited by giortzisg

Loading

codecov bot commented Jan 12, 2026 •

edited

Loading

github-actions bot commented Jan 20, 2026 •

edited

Loading

codecov bot commented Jan 23, 2026 •

edited

Loading