Add Metrics API support

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add Metrics API support ([#1214](https://github.com/getsentry/sentry-unreal/pull/1214))
+
 ### Dependencies
 
 - Bump Cocoa SDK from v9.3.0 to v9.4.0 ([#1218](https://github.com/getsentry/sentry-unreal/pull/1218))

plugin-dev/Source/Sentry/Private/Android/AndroidSentryMetric.cpp

@@ -0,0 +1,134 @@
+// Copyright (c) 2025 Sentry. All Rights Reserved.
+
+#include "AndroidSentryMetric.h"
+
+#include "Infrastructure/AndroidSentryConverters.h"
+#include "Infrastructure/AndroidSentryJavaClasses.h"
+
+FAndroidSentryMetric::FAndroidSentryMetric()
+	: FSentryJavaObjectWrapper(SentryJavaClasses::SentryMetricsEvent, "()V")
+{
+	SetupClassMethods();
+}
+
+FAndroidSentryMetric::FAndroidSentryMetric(jobject metricEvent)
+	: FSentryJavaObjectWrapper(SentryJavaClasses::SentryMetricsEvent, metricEvent)
+{
+	SetupClassMethods();
+}
+
+void FAndroidSentryMetric::SetupClassMethods()
+{
+	SetNameMethod = GetMethod("setName", "(Ljava/lang/String;)V");
+	GetNameMethod = GetMethod("getName", "()Ljava/lang/String;");
+	SetTypeMethod = GetMethod("setType", "(Ljava/lang/String;)V");
+	GetTypeMethod = GetMethod("getType", "()Ljava/lang/String;");
+	SetValueMethod = GetMethod("setValue", "(Ljava/lang/Double;)V");
+	GetValueMethod = GetMethod("getValue", "()Ljava/lang/Double;");
+	SetUnitMethod = GetMethod("setUnit", "(Ljava/lang/String;)V");
+	GetUnitMethod = GetMethod("getUnit", "()Ljava/lang/String;");
+}
+
+void FAndroidSentryMetric::SetName(const FString& name)
+{
+	CallMethod<void>(SetNameMethod, *GetJString(name));
+}
+
+FString FAndroidSentryMetric::GetName() const
+{
+	return CallMethod<FString>(GetNameMethod);
+}
+
+void FAndroidSentryMetric::SetType(const FString& type)
+{
+	CallMethod<void>(SetTypeMethod, *GetJString(type));
+}
+
+FString FAndroidSentryMetric::GetType() const
+{
+	return CallMethod<FString>(GetTypeMethod);
+}
+
+void FAndroidSentryMetric::SetValue(float value)
+{
+	TSharedPtr<FSentryJavaObjectWrapper> javaDouble = MakeShareable(new FSentryJavaObjectWrapper(SentryJavaClasses::Double, "(D)V", static_cast<double>(value)));
+	CallMethod<void>(SetValueMethod, javaDouble->GetJObject());
+}
+
+float FAndroidSentryMetric::GetValue() const
+{
+	auto valueObject = CallObjectMethod<jobject>(GetValueMethod);
+	if (!valueObject)
+	{
+		return 0.0f;
+	}
+
+	FSentryJavaObjectWrapper valueWrapper(SentryJavaClasses::Double, *valueObject);
+	FSentryJavaMethod floatValueMethod = valueWrapper.GetMethod("floatValue", "()F");
+	return valueWrapper.CallMethod<float>(floatValueMethod);
+}
+
+void FAndroidSentryMetric::SetUnit(const FString& unit)
+{
+	CallMethod<void>(SetUnitMethod, *GetJString(unit));
+}
+
+FString FAndroidSentryMetric::GetUnit() const
+{
+	return CallMethod<FString>(GetUnitMethod);
+}
+
+void FAndroidSentryMetric::SetAttribute(const FString& key, const FSentryVariant& value)
+{
+	TSharedPtr<FSentryJavaObjectWrapper> attribute = FAndroidSentryConverters::VariantToNative(value);
+
+	if (!attribute)
+	{
+		return;
+	}
+
+	CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "setMetricAttribute", "(Lio/sentry/SentryMetricsEvent;Ljava/lang/String;Ljava/lang/Object;)V",
+		GetJObject(), *GetJString(key), attribute->GetJObject());
+}
+
+FSentryVariant FAndroidSentryMetric::GetAttribute(const FString& key) const
+{
+	auto attribute = CallStaticObjectMethod<jobject>(SentryJavaClasses::SentryBridgeJava, "getMetricAttribute", "(Lio/sentry/SentryMetricsEvent;Ljava/lang/String;)Ljava/lang/Object;",
+		GetJObject(), *GetJString(key));
+
+	if (!attribute)
+	{
+		return FSentryVariant();
+	}
+
+	return FAndroidSentryConverters::VariantToUnreal(*attribute);
+}
+
+bool FAndroidSentryMetric::TryGetAttribute(const FString& key, FSentryVariant& value) const
+{
+	auto attribute = CallStaticObjectMethod<jobject>(SentryJavaClasses::SentryBridgeJava, "getMetricAttribute", "(Lio/sentry/SentryMetricsEvent;Ljava/lang/String;)Ljava/lang/Object;",
+		GetJObject(), *GetJString(key));
+
+	if (!attribute)
+	{
+		return false;
+	}
+
+	value = FAndroidSentryConverters::VariantToUnreal(*attribute);
+
+	return true;
+}
+
+void FAndroidSentryMetric::RemoveAttribute(const FString& key)
+{
+	CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "removeMetricAttribute", "(Lio/sentry/SentryMetricsEvent;Ljava/lang/String;)V",
+		GetJObject(), *GetJString(key));
+}
+
+void FAndroidSentryMetric::AddAttributes(const TMap<FString, FSentryVariant>& attributes)
+{
+	for (const auto& pair : attributes)
+	{
+		SetAttribute(pair.Key, pair.Value);
+	}
+}

plugin-dev/Source/Sentry/Private/Android/AndroidSentryMetric.h

@@ -0,0 +1,43 @@
+// Copyright (c) 2025 Sentry. All Rights Reserved.
+
+#pragma once
+
+#include "Interface/SentryMetricInterface.h"
+
+#include "Infrastructure/AndroidSentryJavaObjectWrapper.h"
+
+class FAndroidSentryMetric : public ISentryMetric, public FSentryJavaObjectWrapper
+{
+public:
+	FAndroidSentryMetric();
+	FAndroidSentryMetric(jobject metricEvent);
+
+	void SetupClassMethods();
+
+	virtual void SetName(const FString& name) override;
+	virtual FString GetName() const override;
+	virtual void SetType(const FString& type) override;
+	virtual FString GetType() const override;
+	virtual void SetValue(float value) override;
+	virtual float GetValue() const override;
+	virtual void SetUnit(const FString& unit) override;
+	virtual FString GetUnit() const override;
+
+	virtual void SetAttribute(const FString& key, const FSentryVariant& value) override;
+	virtual FSentryVariant GetAttribute(const FString& key) const override;
+	virtual bool TryGetAttribute(const FString& key, FSentryVariant& value) const override;
+	virtual void RemoveAttribute(const FString& key) override;
+	virtual void AddAttributes(const TMap<FString, FSentryVariant>& attributes) override;
+
+private:
+	FSentryJavaMethod SetNameMethod;
+	FSentryJavaMethod GetNameMethod;
+	FSentryJavaMethod SetTypeMethod;
+	FSentryJavaMethod GetTypeMethod;
+	FSentryJavaMethod SetValueMethod;
+	FSentryJavaMethod GetValueMethod;
+	FSentryJavaMethod SetUnitMethod;
+	FSentryJavaMethod GetUnitMethod;
+};
+
+typedef FAndroidSentryMetric FPlatformSentryMetric;

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.cpp

@@ -45,7 +45,7 @@ FAndroidSentrySubsystem::~FAndroidSentrySubsystem()
 	SentryJavaClasses::ClearJavaClassRefsCache();
 }
 
-void FAndroidSentrySubsystem::InitWithSettings(const USentrySettings* settings, USentryBeforeSendHandler* beforeSendHandler, USentryBeforeBreadcrumbHandler* beforeBreadcrumbHandler, USentryBeforeLogHandler* beforeLogHandler, USentryTraceSampler* traceSampler)
+void FAndroidSentrySubsystem::InitWithSettings(const USentrySettings* settings, USentryBeforeSendHandler* beforeSendHandler, USentryBeforeBreadcrumbHandler* beforeBreadcrumbHandler, USentryBeforeLogHandler* beforeLogHandler, USentryBeforeMetricHandler* beforeMetricHandler, USentryTraceSampler* traceSampler)
 {
 	isScreenshotAttachmentEnabled = settings->AttachScreenshot;
 
@@ -67,6 +67,7 @@ void FAndroidSentrySubsystem::InitWithSettings(const USentrySettings* settings,
 	SettingsJson->SetBoolField(TEXT("enableAnrTracking"), settings->EnableAppNotRespondingTracking);
 	SettingsJson->SetBoolField(TEXT("enableAutoLogAttachment"), settings->EnableAutoLogAttachment);
 	SettingsJson->SetBoolField(TEXT("enableStructuredLogging"), settings->EnableStructuredLogging);
+	SettingsJson->SetBoolField(TEXT("enableMetrics"), settings->EnableMetrics);
 	if (settings->EnableTracing && settings->SamplingType == ESentryTracesSamplingType::UniformSampleRate)
 	{
 		SettingsJson->SetNumberField(TEXT("tracesSampleRate"), settings->TracesSampleRate);
@@ -87,6 +88,10 @@ void FAndroidSentrySubsystem::InitWithSettings(const USentrySettings* settings,
 	{
 		SettingsJson->SetNumberField(TEXT("beforeLogHandler"), (jlong)beforeLogHandler);
 	}
+	if (beforeMetricHandler != nullptr)
+	{
+		SettingsJson->SetNumberField(TEXT("beforeMetricHandler"), (jlong)beforeMetricHandler);
+	}
 
 	FString SettingsJsonStr;
 	TSharedRef<TJsonWriter<>> JsonWriter = TJsonWriterFactory<>::Create(&SettingsJsonStr);
@@ -194,6 +199,27 @@ void FAndroidSentrySubsystem::AddLog(const FString& Message, ESentryLevel Level,
 	}
 }
 
+void FAndroidSentrySubsystem::AddCount(const FString& Key, int32 Value, const TMap<FString, FSentryVariant>& Attributes)
+{
+	TSharedPtr<FSentryJavaObjectWrapper> attributesMap = FAndroidSentryConverters::VariantMapToNative(Attributes);
+	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "metricCount", "(Ljava/lang/String;DLjava/util/HashMap;)V",
+		*FSentryJavaObjectWrapper::GetJString(Key), static_cast<double>(Value), attributesMap->GetJObject());
+}
+
+void FAndroidSentrySubsystem::AddDistribution(const FString& Key, float Value, const FString& Unit, const TMap<FString, FSentryVariant>& Attributes)
+{
+	TSharedPtr<FSentryJavaObjectWrapper> attributesMap = FAndroidSentryConverters::VariantMapToNative(Attributes);
+	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "metricDistribution", "(Ljava/lang/String;DLjava/lang/String;Ljava/util/HashMap;)V",
+		*FSentryJavaObjectWrapper::GetJString(Key), static_cast<double>(Value), *FSentryJavaObjectWrapper::GetJString(Unit), attributesMap->GetJObject());
+}
+
+void FAndroidSentrySubsystem::AddGauge(const FString& Key, float Value, const FString& Unit, const TMap<FString, FSentryVariant>& Attributes)
+{
+	TSharedPtr<FSentryJavaObjectWrapper> attributesMap = FAndroidSentryConverters::VariantMapToNative(Attributes);
+	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::SentryBridgeJava, "metricGauge", "(Ljava/lang/String;DLjava/lang/String;Ljava/util/HashMap;)V",
+		*FSentryJavaObjectWrapper::GetJString(Key), static_cast<double>(Value), *FSentryJavaObjectWrapper::GetJString(Unit), attributesMap->GetJObject());
+}
+
 void FAndroidSentrySubsystem::ClearBreadcrumbs()
 {
 	FSentryJavaObjectWrapper::CallStaticMethod<void>(SentryJavaClasses::Sentry, "clearBreadcrumbs", "()V");

plugin-dev/Source/Sentry/Private/Android/AndroidSentrySubsystem.h

@@ -10,13 +10,16 @@ class FAndroidSentrySubsystem : public ISentrySubsystem
 	FAndroidSentrySubsystem();
 	~FAndroidSentrySubsystem();
 
-	virtual void InitWithSettings(const USentrySettings* settings, USentryBeforeSendHandler* beforeSendHandler, USentryBeforeBreadcrumbHandler* beforeBreadcrumbHandler, USentryBeforeLogHandler* beforeLogHandler, USentryTraceSampler* traceSampler) override;
+	virtual void InitWithSettings(const USentrySettings* settings, USentryBeforeSendHandler* beforeSendHandler, USentryBeforeBreadcrumbHandler* beforeBreadcrumbHandler, USentryBeforeLogHandler* beforeLogHandler, USentryBeforeMetricHandler* beforeMetricHandler, USentryTraceSampler* traceSampler) override;
 	virtual void Close() override;
 	virtual bool IsEnabled() override;
 	virtual ESentryCrashedLastRun IsCrashedLastRun() override;
 	virtual void AddBreadcrumb(TSharedPtr<ISentryBreadcrumb> breadcrumb) override;
 	virtual void AddBreadcrumbWithParams(const FString& Message, const FString& Category, const FString& Type, const TMap<FString, FSentryVariant>& Data, ESentryLevel Level) override;
 	virtual void AddLog(const FString& Message, ESentryLevel Level, const TMap<FString, FSentryVariant>& Attributes) override;
+	virtual void AddCount(const FString& Key, int32 Value, const TMap<FString, FSentryVariant>& Attributes) override;
+	virtual void AddDistribution(const FString& Key, float Value, const FString& Unit, const TMap<FString, FSentryVariant>& Attributes) override;
+	virtual void AddGauge(const FString& Key, float Value, const FString& Unit, const TMap<FString, FSentryVariant>& Attributes) override;
 	virtual void ClearBreadcrumbs() override;
 	virtual void AddAttachment(TSharedPtr<ISentryAttachment> attachment) override;
 	virtual void RemoveAttachment(TSharedPtr<ISentryAttachment> attachment) override;

plugin-dev/Source/Sentry/Private/Android/Infrastructure/AndroidSentryJavaClasses.cpp

@@ -29,6 +29,7 @@ const FSentryJavaClass SentryJavaClasses::TransactionOptions	= FSentryJavaClass
 const FSentryJavaClass SentryJavaClasses::SentryTraceHeader		= FSentryJavaClass { "io/sentry/SentryTraceHeader", ESentryJavaClassType::External };
 const FSentryJavaClass SentryJavaClasses::SentryLogEvent		= FSentryJavaClass { "io/sentry/SentryLogEvent", ESentryJavaClassType::External };
 const FSentryJavaClass SentryJavaClasses::SentryLogLevel		= FSentryJavaClass { "io/sentry/SentryLogLevel", ESentryJavaClassType::External };
+const FSentryJavaClass SentryJavaClasses::SentryMetricsEvent	= FSentryJavaClass { "io/sentry/SentryMetricsEvent", ESentryJavaClassType::External };
 
 // System Java classes definitions
 const FSentryJavaClass SentryJavaClasses::ArrayList				= FSentryJavaClass { "java/util/ArrayList", ESentryJavaClassType::System };
@@ -73,6 +74,7 @@ void SentryJavaClasses::InitJavaClassRefsCache()
 	JavaClassRefsCache.Add(SentryTraceHeader.Name, FindJavaClassRef(SentryTraceHeader));
 	JavaClassRefsCache.Add(SentryLogEvent.Name, FindJavaClassRef(SentryLogEvent));
 	JavaClassRefsCache.Add(SentryLogLevel.Name, FindJavaClassRef(SentryLogLevel));
+	JavaClassRefsCache.Add(SentryMetricsEvent.Name, FindJavaClassRef(SentryMetricsEvent));
 
 	// System Java classes definitions
 	JavaClassRefsCache.Add(ArrayList.Name, FindJavaClassRef(ArrayList));

plugin-dev/Source/Sentry/Private/Android/Infrastructure/AndroidSentryJavaClasses.h

@@ -29,6 +29,7 @@ struct SentryJavaClasses
 	const static FSentryJavaClass SentryTraceHeader;
 	const static FSentryJavaClass SentryLogEvent;
 	const static FSentryJavaClass SentryLogLevel;
+	const static FSentryJavaClass SentryMetricsEvent;
 
 	// System Java classes
 	const static FSentryJavaClass ArrayList;