Skip to content

feat(metrics): [Trace Metrics 12] Record client report for discarded metrics envelope item #4991

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

Draft
adinauer wants to merge 1 commit into
base: 12-19-metrics_envelope_item_deserialization
Choose a base branch
from
+47 −0
Draft

feat(metrics): [Trace Metrics 12] Record client report for discarded metrics envelope item #4991

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
15 changes: 15 additions & 0 deletions sentry/src/main/java/io/sentry/clientreport/ClientReportRecorder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import io.sentry.SentryLevel;
import io.sentry.SentryLogEvent;
import io.sentry.SentryLogEvents;
import io.sentry.SentryMetricsEvent;
import io.sentry.SentryMetricsEvents;
import io.sentry.SentryOptions;
import io.sentry.protocol.SentrySpan;
import io.sentry.protocol.SentryTransaction;
Expand Down Expand Up @@ -115,6 +117,19 @@ public void recordLostEnvelopeItem(
} else {
options.getLogger().log(SentryLevel.ERROR, "Unable to parse lost logs envelope item.");
}
} else if (itemCategory.equals(DataCategory.TraceMetric)) {
final @Nullable SentryMetricsEvents metrics =
envelopeItem.getMetrics(options.getSerializer());
if (metrics != null) {
final @NotNull List<SentryMetricsEvent> items = metrics.getItems();
final long count = items.size();
recordLostEventInternal(reason.getReason(), itemCategory.getCategory(), count);
executeOnDiscard(reason, itemCategory, count);
} else {
options
.getLogger()
.log(SentryLevel.ERROR, "Unable to parse lost metrics envelope item.");
}
} else {
recordLostEventInternal(reason.getReason(), itemCategory.getCategory(), 1L);
executeOnDiscard(reason, itemCategory, 1L);
Expand Down
32 changes: 32 additions & 0 deletions sentry/src/test/java/io/sentry/clientreport/ClientReportTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import io.sentry.SentryLogEvent
import io.sentry.SentryLogEvents
import io.sentry.SentryLogLevel
import io.sentry.SentryLongDate
import io.sentry.SentryMetricsEvent
import io.sentry.SentryMetricsEvents
import io.sentry.SentryOptions
import io.sentry.SentryReplayEvent
import io.sentry.SentryTracer
Expand Down Expand Up @@ -382,6 +384,36 @@ class ClientReportTest {
assertEquals(226, logByte.quantity)
}

@Test
fun `recording lost client report counts metric entries`() {
val onDiscardMock = mock<SentryOptions.OnDiscardCallback>()
givenClientReportRecorder { options -> options.onDiscard = onDiscardMock }

val envelope =
testHelper.newEnvelope(
SentryEnvelopeItem.fromMetrics(
opts.serializer,
SentryMetricsEvents(
listOf(
SentryMetricsEvent(SentryId(), SentryLongDate(1), "metric1", "counter", 1.0),
SentryMetricsEvent(SentryId(), SentryLongDate(2), "metric2", "gauge", 2.0),
SentryMetricsEvent(SentryId(), SentryLongDate(3), "metric3", "distribution", 3.0),
)
),
)
)

clientReportRecorder.recordLostEnvelopeItem(DiscardReason.NETWORK_ERROR, envelope.items.first())

verify(onDiscardMock, times(1))
.execute(DiscardReason.NETWORK_ERROR, DataCategory.TraceMetric, 3)

val clientReport = clientReportRecorder.resetCountsAndGenerateClientReport()
val metricItem =
clientReport!!.discardedEvents!!.first { it.category == DataCategory.TraceMetric.category }
assertEquals(3, metricItem.quantity)
}

private fun givenClientReportRecorder(
callback: Sentry.OptionsConfiguration<SentryOptions>? = null
) {
Expand Down
Loading