Releases: getsentry/sentry-xamarin
2.1.0
Fixes
-
Validate PrivacyInfo.xcprivacy and warn users of required missing privacy parameters (#152)
Due to a requirement by apple, all Projects will require a (Privacy Manifest file). Sentry will automatically patch your project with the required fields by Sentry if no privacy manifest file is provided. Otherwise, it will validate your privacy manifest file for the required fields by Sentry and warn you during the build time if the required keys are present or not when building an iOS project.
Below you can find a snippet of the minimum required privacy manifest required by Sentry Xamarin:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>NSPrivacyCollectedDataTypes</key>
<array>
<dict>
<key>NSPrivacyCollectedDataType</key>
<string>NSPrivacyCollectedDataTypeCrashData</string>
<key>NSPrivacyCollectedDataTypeLinked</key>
<false/>
<key>NSPrivacyCollectedDataTypeTracking</key>
<false/>
<key>NSPrivacyCollectedDataTypePurposes</key>
<array>
<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
</array>
</dict>
<dict>
<key>NSPrivacyCollectedDataType</key>
<string>NSPrivacyCollectedDataTypePerformanceData</string>
<key>NSPrivacyCollectedDataTypeLinked</key>
<false/>
<key>NSPrivacyCollectedDataTypeTracking</key>
<false/>
<key>NSPrivacyCollectedDataTypePurposes</key>
<array>
<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
</array>
</dict>
<dict>
<key>NSPrivacyCollectedDataType</key>
<string>NSPrivacyCollectedDataTypeOtherDiagnosticData</string>
<key>NSPrivacyCollectedDataTypeLinked</key>
<false/>
<key>NSPrivacyCollectedDataTypeTracking</key>
<false/>
<key>NSPrivacyCollectedDataTypePurposes</key>
<array>
<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
</array>
</dict>
</array>
<key>NSPrivacyAccessedAPITypes</key>
<array>
<dict>
<key>NSPrivacyAccessedAPIType</key>
<string>NSPrivacyAccessedAPICategoryFileTimestamp</string>
<key>NSPrivacyAccessedAPITypeReasons</key>
<array>
<string>C617.1</string>
</array>
</dict>
<dict>
<key>NSPrivacyAccessedAPIType</key>
<string>NSPrivacyAccessedAPICategorySystemBootTime</string>
<key>NSPrivacyAccessedAPITypeReasons</key>
<array>
<string>35F9.1</string>
</array>
</dict>
</array>
</dict>
</plist>
Dependencies
- Bump Sentry.NET 4.5.0 (#154)
2.0.0
Sentry Self-hosted Compatibility
If you're using sentry.io
this change does not affect you.
This SDK version is compatible with a self-hosted version of Sentry 22.12.0
or higher. If you are using an older version of self-hosted Sentry (aka on-premise), you will need to upgrade.
Significant change in behavior
- Setting
SentryOptions.Dsn
tonull
now throwsArgumentNullException
during initialization. (#2655) - Enable
CaptureFailedRequests
by default (#2688) - Added
Sentry
namespace to global usings whenImplicitUsings
is enabled (#3043)
If you have conflicts, you can opt out by adding the following to yourcsproj
:
<PropertyGroup>
<SentryImplicitUsings>false</SentryImplicitUsings>
</PropertyGroup>
- Transactions' spans are no longer automatically finished with the status
deadline_exceeded
by the transaction. This is now handled by the Relay.- Customers self hosting Sentry must use verion 22.12.0 or later (#3013)
- The
User.IpAddress
is now set to{{auto}}
by default, even when sendDefaultPII is disabled (#2981)- The "Prevent Storing of IP Addresses" option in the "Security & Privacy" project settings on sentry.io can be used to control this instead
- The
DiagnosticLogger
signature forLogWarning
changed to take theexception
as the first parameter. That way it no longer gets mixed up with the TArgs. (#2987)
API breaking Changes
If you have compilation errors you can find the affected types or overloads missing in the changelog entries below.
Changed APIs
- Class renamed
Sentry.User
toSentry.SentryUser
(#3015) - Class renamed
Sentry.Runtime
toSentry.SentryRuntime
(#3016) - Class renamed
Sentry.Span
toSentry.SentrySpan
(#3021) - Class renamed
Sentry.Transaction
toSentry.SentryTransaction
(#3023) ITransaction
has been renamed toITransactionTracer
. You will need to update any references to these interfaces in your code to use the new interface names (#2731, #2870)DebugImage
andDebugMeta
moved toSentry.Protocol
namespace. (#2815)SentryClient.Dispose
is no longer obsolete (#2842)ISentryClient.CaptureEvent
overloads have been replaced by a single method accepting optionalHint
andScope
parameters. You will need to passhint
as a named parameter from code that callsCaptureEvent
without passing ascope
argument. (#2749)TransactionContext
andSpanContext
constructors were updated. If you're constructing instances of these classes, you will need to adjust the order in which you pass parameters to these. (#2694, #2696)- The
DiagnosticLogger
signature forLogError
andLogFatal
changed to take theexception
as the first parameter. That way it no longer gets mixed up with the TArgs. TheDiagnosticLogger
now also receives an overload forLogError
andLogFatal
that accepts a message only. (#2715) Distribution
added toIEventLike
. (#2660)StackFrame
'sImageAddress
,InstructionAddress
, andFunctionId
changed tolong?
. (#2691)DebugImage.ImageAddress
changed tolong?
. (#2725)- Contexts now inherit from
IDictionary
rather thanConcurrentDictionary
. The specific dictionary being used is an implementation detail. (#2729) - The method used to configure a Sentry Sink for Serilog now has an additional overload. Calling
WriteTo.Sentry()
with no arguments will no longer attempt to initialize the SDK (it has optional arguments to configure the behavior of the Sink only). If you want to initialize Sentry at the same time you configure the Sentry Sink then you will need to use the overload of this method that accepts a DSN as the first parameter (e.g.WriteTo.Sentry("https://d4d82fc1c2c4032a83f3a29aa3a3aff@fake-sentry.io:65535/2147483647")
). (#2928)
Removed APIs
-
SentrySinkExtensions.ConfigureSentrySerilogOptions is now internal. If you were using this method, please use one of the
SentrySinkExtensions.Sentry
extension methods instead. (#2902) -
A number of
[Obsolete]
options have been removed (#2841)BeforeSend
- useSetBeforeSend
instead.BeforeSendTransaction
- useSetBeforeSendTransaction
instead.BeforeBreadcrumb
- useSetBeforeBreadcrumb
instead.CreateHttpClientHandler
- useCreateHttpMessageHandler
instead.ReportAssemblies
- useReportAssembliesMode
instead.KeepAggregateException
- this property is no longer used and has no replacement.DisableTaskUnobservedTaskExceptionCapture
method has been renamed toDisableUnobservedTaskExceptionCapture
.DebugDiagnosticLogger
- useTraceDiagnosticLogger
instead.
-
A number of iOS/Android-specific
[Obsolete]
options have been removed (#2856)Distribution
- useSentryOptions.Distribution
instead.EnableAutoPerformanceTracking
- useSetBeforeSendTransaction
instead.EnableCoreDataTracking
- useEnableCoreDataTracing
instead.EnableFileIOTracking
- useEnableFileIOTracing
instead.EnableOutOfMemoryTracking
- useEnableWatchdogTerminationTracking
instead.EnableUIViewControllerTracking
- useEnableUIViewControllerTracing
instead.StitchAsyncCode
- no longer available.ProfilingTracesInterval
- no longer available.ProfilingEnabled
- useProfilesSampleRate
instead.
-
Obsolete
SystemClock
constructor removed, useSystemClock.Clock
instead. (#2856) -
Obsolete
Runtime.Clone()
removed, this shouldn't have been public in the past and has no replacement. (#2856) -
Obsolete
SentryException.Data
removed, useSentryException.Mechanism.Data
instead. (#2856) -
Obsolete
AssemblyExtensions
removed, this shouldn't have been public in the past and has no replacement. (#2856) -
Obsolete
SentryDatabaseLogging.UseBreadcrumbs()
removed, it is called automatically and has no replacement. (#2856) -
Obsolete
Scope.GetSpan()
removed, useSpan
property instead. (#2856) -
Obsolete
IUserFactory
removed, useISentryUserFactory
instead. (#2856, #2840) -
IHasMeasurements
has been removed, useISpanData
instead. (#2659) -
IHasBreadcrumbs
has been removed, useIEventLike
instead. (#2670) -
ISpanContext
has been removed, useITraceContext
instead. (#2668) -
IHasTransactionNameSource
has been removed, useITransactionContext
instead. (#2654) -
(#2694)
-
The unused
StackFrame.InstructionOffset
has been removed. (#2691) -
The unused
Scope.Platform
property has been removed. (#2695) -
The obsolete setter
Sentry.PlatformAbstractions.Runtime.Identifier
has been removed (2764) -
Sentry.Values<T>
is now internal as it is never exposed in the public API (#2771) -
The
TracePropagationTarget
class has been removed, use theSubstringOrRegexPattern
class instead. (#2763) -
The
WithScope
andWithScopeAsync
methods have been removed. We have discovered that these methods didn't work correctly in certain desktop contexts, especially when using a global scope. (#2717)Replace your usage of
WithScope
with overloads ofCapture*
methods:SentrySdk.CaptureEvent(SentryEvent @event, Action<Scope> scopeCallback)
SentrySdk.CaptureMessage(string message, Action<Scope> scopeCallback)
SentrySdk.CaptureException(Exception exception, Action<Scope> scopeCallback)
// Before SentrySdk.WithScope(scope => { scope.SetTag("key", "value"); ...