Features and fixes:
- ref: Add read-only scope property to Hub #975
Breaking Changes:
- ref: Remove SentryException.userReported #974
- ref: Replace SentryLogLevel with SentryLevel #978
We replaced the SentryLogLevel
with SentryLevel
, renamed logLevel
to diagnosticLevel
on SentryOptions
to align with other Sentry SDKs, and set the default diagnosticLevel
to
SentryLevel.debug
. Furthermore, we removed setting the logLevel
statically on the SentrySDK
.
Please use the SentryOptions
to set the diagnosticLevel
instead.
6.x
SentrySDK.start { options in
options.logLevel = SentryLogLevel.verbose
}
// Or
SentrySDK.logLevel = SentryLogLevel.verbose
7.x
SentrySDK.start { options in
options.diagnosticLevel = SentryLevel.debug
}
Internal Note: Move this migration guide to the docs before GA.
Breaking Change: This version introduces a change to the grouping of issues. The SDK now sets the inApp
flag for frames originating from only the main executable using CFBundleExecutable.
In previous versions, all frames originating from the application bundle were marked as inApp
. This had the
downside of marking frames of private frameworks inside the bundle as inApp
. This problem is fixed now.
Applications using static frameworks shouldn't be affected by this change.
For more information on marking frames as inApp docs.
- fix: Mark frames as inApp #956
- fix: Redundant x29 GP register on arm64 and UBSan crash #964
With this version, Sentry groups errors by domain and code. MyDomain 1 and MyDomain 2 are going to be two separate issues in Sentry. If you are using self-hosted Sentry, it requires Sentry version >= v21.2.0 to work. Staying on Sentry < v21.2.0 and upgrading to this version of the SDK won't do any damage. Sentry will group like in previous versions, but you will see a new group because we slightly changed the wording. If you are using sentry.io no action is needed. In case you are not satisfied with this change, you can take a look at SDK fingerprinting to group by domain only.
- fix: Use mechanism meta for error grouping #946
- fix: Sanitize SentryMechanism.data on serialize #947
- feat: Add error to SentryEvent #944
- fix: Mark SentryEvent.message as Nullable #943
- fix: Stacktrace inApp marking on Simulators #942
- feat: Group NSError by domain and code #941
- fix: Discard Sessions when JSON is faulty #939
- feat: Add sendDefaultPii to SentryOptions #923
- fix: Sessions for Hybrid SDKs #913
- fix: Capture envelope updates session state #906
- fix: Clash with KSCrash functions #905
- fix: Duplicate symbol clash with KSCrash #902
- perf: Improve locks in SentryScope #888
- fix: Change maxAttachmentSize from MiB to bytes #891
- feat: Add maxAttachmentSize to SentryOptions #887
- ref: Remove SentryAttachment.isEqual and hash #885
- ref: Remove SentryScope.isEqual and hash #884
- feat: Add basic support for attachments #875
- fix: Crash in SentrySession.serialize #870
- perf: Drop global dispatch queue (#869)
- fix: Increase precision of iso8601 date formatter #860
- feat: Add onCrashedLastRun #808
- feat: Add SentrySdkInfo to SentryOptions #859
- fix: Serialization of SentryScope #841
- fix: Recrash parsing in SentryCrash #850
- fix: Not crash during crash reporting #849
- feat: Add storeEnvelope on SentryClient #836
- perf: Async synching of scope on to SentryCrash #832
- fix: Drop Sessions without release name #826
- feat: Bring back SentryOptions.enabled #818
- fix: Remove enum specifier for SentryLevel #822
- feat: Send environment 'production' if nothing was set #825
- fix: Typo for Swift name: UserFeedback #829
- fix: Call beforeBreadcrumb for Breadcrumb Tracker #815
- fix: Add eventId to user feedback envelope header #809
- feat: Manually capturing User Feedback #804
- fix: Sanitize UserInfo of NSError and NSException #770
- fix: Xcode 12 warnings for Cocoapods #791
- fix: Making SentrySdkInfo Public #788
- fix: iOS 13.4 Runtime Crash #786
- fix: Using wrong SDK name #782
- feat: Expose
captureEnvelope
on the client #784 - fix: Remove initWithJSON from SentryEvent #781
- fix: Carthage for Xcode 12 #780
- fix: Add missing SentrySdkInfo.h to umbrella header #779
- ref: Remove event.json field #768
- fix: Warning Duplicate build file in Copy Headers #761
- fix: Warning when integrating SDK via Carthage #760
- feat: Set installationId to userId if no user is set #757
This is a major bump with lots of internal improvements and a few breaking changes. For a detailed explanation how to updgrade please checkout the migration guide.
Breaking changes:
- fix: Make SentryMessage formatted required #756
- feat: Add SentryMessage #752
- feat: Replace passing nullable Scope with overloads #743
- feat: Remove SentryOptions.enabled #736
- fix: Public Headers #735
- feat: Attach stacktraces to all events by default #705
- feat: Replace NSNumber with BOOL in SentryOptions #719
- feat: Enable auto session tracking per default #689
- feat: Remove deprecated SDK inits #673
- feat: Bump minimum iOS version to 9.0 #669
- fix: Umbrella header #671
- feat: Replace NSString for eventId with SentryId #668
- feat: Use envelopes for sending events #650
Features and fixes:
- fix: Make public isEqual _Nullable #751
- feat: Use error domain and code for event message #750
- feat: Remove SDK frames when attaching stacktrace #739
- fix: captureException crates a event type=error #746
- fix: Setting environment for Sessions #734
- feat: Crash event and session in same envelope #731
- feat: Allow nil in setExtraValue on SentryScope to remove key #703
- fix: Header Imports for the Swift Package Manager #721
- fix: Async storing of envelope to disk #714
- feat: Migrate session init for stored envelopes #693
- fix: Remove redundant sdk options enable check in SentryHttpTransport #698
- fix: Sending envelopes multiple times #687
- fix: Rate limiting for cached envelope items #685
- feat: Errors and sessions in the same envelope #686
- feat: Implement NSCopying for SentrySession #683
- fix: Crash when SentryClient is nil in SentryHub #681
- feat: Send cached envelopes first #676
Breaking changes:
- feat: Remove SentryOptions.enabled #736
- fix: Public Headers #735
Fix:
- fix: Setting environment for Sessions #734
This release also enables by default the option attackStacktrace
which includes
the stacktrace in all events, including captureMessage
by default.
Breaking Changes:
- feat: Attach stacktraces to all events by default #705
Features and fixes:
- feat: Crash event and session in same envelope #731
- feat: Allow nil in setExtraValue on SentryScope to remove key #703
Breaking changes:
- feat: Replace NSNumber with BOOL in SentryOptions #719
Features and fixes:
- fix: Header Imports for the Swift Package Manager #721
- fix: Async storing of envelope to disk #714
- feat: Migrate session init for stored envelopes #693
- fix: Remove redundant sdk options enable check in SentryHttpTransport #698
Breaking Change: This version uses the envelope endpoint.
If you are using an on-premise installation it requires Sentry version
>= v20.6.0
to work. If you are using sentry.io nothing will change and
no action is needed. Furthermore, with this version
auto session tracking
is enabled per default.
This feature
is collecting and sending health data about the usage of your
application.
We are going to add the official migration guide in one of the next beta releases.
Here is an overview of all the breaking changes:
- feat: Enable auto session tracking per default #689
- feat: Remove deprecated SDK inits #673
- feat: Bump minimum iOS version to 9.0 #669
- fix: Umbrella header #671
- feat: Replace NSString for eventId with SentryId #668
- feat: Use envelopes for sending events #650
Other new features and fixes:
- fix: Sending envelopes multiple times #687
- fix: Rate limiting for cached envelope items #685
- feat: Errors and sessions in the same envelope #686
- feat: Implement NSCopying for SentrySession #683
- fix: Crash when SentryClient is nil in SentryHub #681
- feat: Send cached envelopes first #676
- feat: Add crashedLastRun to SentrySDK #688
- fix: Add IP address to user serialization #665
- fix: Crash in SentryEnvelope.initWithEvent #643
- fix: Build failure for Apple Silicon Macs #588
- feat: capture userinfo from NSError and NSException #679
- fix: nxgetlocalarch app store #651
- fix: Crash when converting Recrash Report #627
- feat: Add SdkInfo to Envelope Header #626
- fix: Deserialize envelope with header and item #620
- fix: Set LogLevel in startWithConfigureOptions #613
- fix: Abnormal sessions #607
- fix: beforeSend callback in SentryClient #608
- fix: Cocoapods build
- fix: Overwriting stack trace for crashes #605
- fix: Deployment target warning for Swift Package Manager for Xcode 12 #586
- feat: Simplified SDK start #580
- fix: Custom release name for crash reports #590
- feat: Attach the stacktrace to custom events #583
- fix: SentryCrashJSON encodeObject crash #576
- feat: Added automatic breadcrumbs for system events #559
- fix: Increase max report length #569
- fix: Remove weak ref file contents #571
- fix: UUID for SentryCrashReport is null #566
- feat: Attach stacktrace of current thread to events #561
- fix: Prefix categories methods with sentry #555
- feat: Attach DebugMeta to Events #545
- fix: Duplicate symbol for SentryMeta #549
- feat: Set SUPPORTS_MACCATALYST to YES explicitly #547
- fix: Make properties of Session readonly #541
- fix: Remove MemoryWarningIntegration #537
- fix: Avoid Implicit conversion in SentrySession #540
- fix: Change SentryScope setTagValue to NSString #524
- feat: Add remove methods for SentryScope #529
- fix: Failing MacOS build #530
- ref: Session values are unsigned #527
- fix: End file at the right place with #ifdef #521
- fix: Exit session with timestamp #518
- feat: Add sentry_sanitize for NSArray #509
- fix: Keep maximum rate limit #498
- fix: Ignore unknown rate limit categories #497
- fix: On app exit, close session as healthy #500
- fix: Flakey concurrent test for RateLimits #493
- fix: missing breadcrumbs data on hardcrash #492
- GA of major version 5
- feat: Add support for mac catalyst #479
- fix: RateLimitCategories #482
- fix: RetryAfter treated like all categories #481
- feat: RateLimiting for cached events and envelopes #480
- fix: EnvelopeRateLimit init envelope with header #478
- feat: RateLimit for non cached Envelopes #476
- fix: Use RateLimitCategoryError for events #470
- feat: Store SentryEnvelopes in extra path #468
- feat: Adds setUser to SentrySDK and SentryHub #467
- feat: Add auto session starting for macOS #463
- fix: Take release name from options #462
- feat: Use new envelope endpoint #475
- feat: App lifecycle events as breadcrumbs #474
- feat: RateLimit for sendAllStoredEvents #458
- fix: Use maxBreadcrumbs from options #451
- fix: Send vmaddr if available for apple crash reports #459
- fix: Limit number of breadcrumbs #450
- feat: Add Sentry initialization function 'start' #441
- fix: Crashed sessions are marked as such #448
- fix: Persisting Scope with CrashReport
- fix: Frame in app detection #438
- fix: Session ending as Crashed #439
- fix: The order of how integrations are initialized (fixes not sending crashes on startup)
- fix: Add missing header files to umbrella header
- feat: Added Session Feature
- feat: New option
enableAutoSessionTracking
set totrue
if you want sessions to be enabled - feat: Add
_crashOnException:
to handle exceptions for AppKit apps on macOS
- feat: Added internal
captureEnvelope
method
BREAKING: This is the first public release of our new 5.0.0
#339 version of the SDK.
The majority of the public API of the SDK changed, now it's more streamlined with other Sentry SDKs and prepared for future updates.
Please read the migration guide how to use the new SDK MIGRATION.MD
- fix: Mac Catalyst detection
- fix: Add null checks in crash reporter
- fix: Check type of key before use it as NSString (#383)
- fix: Use rawKey to get object from dictionary (#392)
- fix: Change instantiating SentryMechanism of unknown exception type (#385)
- feat: Swift Package Manager support #352
- fix: travis lane lint #345
- feat: Prefer snprintf over sprintf #342
- feat: Add support for custom context and event types
- feat: Helper property on event to send raw payload
- fix: #305
- fix: 64 int conversion #296
- fix: Extracting reason of NSException
- fix: [SentryThread serialize] will crash when threadId is nil #292
- ref: Make
event_id
all lowercase - feat: Emit log error in case no shared client is set and crash handler was started
- ref: Renamed
Container+DeepSearch
toContainer+SentryDeepSearch
- ref: Renamed
NSData+Compression
toNSData+SentryCompression
- ref: Renamed
NSDate+Extras
toNSDate+SentryExtras
- ref: Renamed
NSDictionary+Sanitize
toNSDictionary+SentrySanitize
- feat: Added
initWithOptions
function, it takes an Dictionary of key value. Possible values aredsn
,enabled
,environment
,release
,dist
- feat: Added
enabled
on theClient
- feat: Added
environment
on theClient
- feat: Added
release
on theClient
- feat: Added
dist
on theClient
- ref: Renamed
NSError+SimpleConstructor.h
toNSError+SentrySimpleConstructor.h
- fix: Add environment to Event in JavaScriptHelper
- feat: Add
Client.shared?.trackMemoryPressureAsEvent()
to emit an event if application receives memory pressure notification - feat:
Client.shared?.enableAutomaticBreadcrumbTracking()
now adds a breadcrumb in case of memory pressure notification
- Fix: WatchOS build
- fix(react-native): Correctly label fingerprints for JS bridge. (#279)
- Fix error for empty array creation (#278)
- Fix NSInvalidArgumentException in SentryBreadcrumbStore (#272)
- Add fingerprint support to JavaScript bridge
- Fix internal variable naming conflict with KSCrash
- Introduce
maxEvents
maxBreadcrumbs
to increase the max count of offline stored assets
- Fixes CocoaPods build to include C++ as a library #252
- Moved KSCrash into Codebase while renaming it to SentryCrash.
Removed KSCrash dep in Podspec.
Still if you do not call
startCrashHandlerWithError
crash handlers will not be installed.
This should be safe to upgrade from 3.x.x, there are no code changes what so ever. If you are using CocoaPods or Carthage an update should take care of everything, if you were using the source code directly, make sure to remove KSCrash if you were using it.
We recommend updating if you experience any KSCrash related crashes since we fixed bunch of stuff directly in our codebase now.
- Updated KSCrash project to SKIP_INSTALL
- Update docs to use public DSN
- Don't emit nslog if loglevel is none
- Send new mechanism
- Add transaction of current uiviewcontroller
- Fixed a bug for empty timestamp if created from JavaScript
- Fixed #239
- Synchronize storing of breadcrumbs and events
- Fixed and error in javascript helper for new exception structure
- Fixed #235
- Fixed #236
- Fixed #231
- Greatly improved handling for rate limiting see: #230
- Added
shouldQueueEvent
- There is a hardlimit for offline stored events of 10 and 200 for breadcrumbs
- This update will create a subfolder for each instance of SentryClient depending on the DSN. This also fixes a bug where under rare circumstances on MacOS for not sandboxed apps got sent with the wrong SentryClient. We recommend updating to this version if you are running a un-sandboxed macOS app
- Fixes #216
- Fixed #213
- Added JavaScriptBridgeHelper for react-native, cordova SDK
- Send breadcrumbs in the order in which they got created
- Tick allow-app-extension-API-only box for Carthage builds
- Fixed an issue where a crash and the actual event diverge in release version/ dist #218
- Fixed #217
- Fixed #214
- Fixed failing test
- Make KSCrash default CocoaPod subspec
- macOS: Call super exception handler when crash happens
- Added
sampleRate
parameter to configure the likelihood of sending an event [0.0-1.0]
- Fixes a bug where stack trace is nil when snapshotting stacktrace
- Bump KSCrash to
1.15.12
- Add
SentryCrashExceptionApplication
for macOS uncaught exception handling
- Add
storeEvent
function, mainly used forreact-native
- Fixed a bug in crash Thread detection which caused the Sentry web interface to sometimes show the wrong culprit
- Fixed getsentry#200 Make userId optional of
SentryUser
- Fixed getsentry#198
- Initialize extra and tags in private instead of setter in Client init
- Fixed #196
Fixed messed up Travis build.
Expose sdk
property for SentryEvent
to allow users to set specific SDK information. -> mainly used in react-native
Remove stripping of __sentry extra because it breaks if the event is serialized more than once.
Fix integrations
for sdk
context.
Pretty print json request when verbose logging is active.
Change the way extra
tags
and user
is stored.
- Fixed #190
- Fixed #191
- Add
appendStacktraceToEvent
function in addition tosnapshotStacktrace
to add stacktraces reliably.
- Bump KSCrash to
1.15.11
- Add support for SDK integrations
- Prefix internal category function
- Added new callback
shouldSendEvent
to make it possible to prevent the event from being sent. - Fixes #178
- Fix
snapshotStacktrace
to also includedebug_meta
to fix grouping
- Sanitize all extra's array before serialization (Convert NSDate -> NSString)
- Change internal locking mechanism for swizzling
- Use
KSCrash
1.15.9
Core
subspec which only uses bare minimum for Crash reporting - Fixes #174
- Fix system name
- Fix
NSNumber
properties in DebugMeta
- Rename
RSSwizzle
toSentrySwizzle
- Fix empty frames on specific crash
- Fix carthage builds
Bundled KSCrash into Sentry. Note that this is just for Carthage, CocoaPods knows how to link 2 dynamic frameworks together.
- Fix Sentry dynamic framework
- Fix carthage build
This release is a rewrite of the existing codebase, sentry-cocoa
now uses Objective-C instead of Swift.
Please make sure to check out the docs since this update introduced many breaking changes.
https://docs.sentry.io/clients/cocoa/
KSCrash
is now optional, you can use Sentry without it, we still recommend using KSCrash by default otherwise Sentry will not catch any crashes.
- Fix swift 3 async operation -> Operation never got removed from queue due using private vars instead of setter
- Fixed release naming to
bundleIdentifier
-shortVersion
- Add support for distributions in sentry
- Make
eventID
var
instead oflet
- Update KSCrash
-
Fix duplicate symbols in crash report
1884.42s user 368.70s system 171% cpu 21:55.70 total
- Add additional Info about device
("app_identifier", bundleID)
("app_name", bundleName)
("app_build", bundleVersion)
("app_version", bundleShortVersion)
- Only switflint in Xcode builds, do not while building with CARTHAGE
- No longer automatically clear breadcrumbs when an event is sent
- Set
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES
back toNO
since it prevents upload to iTunes Connect
- Prefix react-native frames with
app://
- Update swiftlint to whitelist rules
- Add app context
- Added
addTag
addExtra
function toSentryClient
andEvent
e.g.:
SentryClient.shared?.addExtra("key", value: "value")
event.addTag("key", value: "value")
- Fixed a bug where 64bit uInt got converted to 32bit
- Added compatiblity for incomplete Crashreports from KSCrash
- Added internal support for upcoming react-native support
- Exposed
maxCrumbs
so the maximum amount of breadcrumbs can be adjusted
- Fixed a bug with not sending
release
with event - Changed the way how swizzling works, there should not be a problem with e.g.: New Relic anymore
-
We decided to rename
SentrySwift
to justSentry
Version
2.0.0
has the same features as1.4.5
. The name of the Framework has been changed from:import SentrySwift
toimport Sentry
Also in thePodfile
you have to change topod Sentry
instead ofpod SentrySwift
. Everything else stayed the same.
- Now sending
registers
with stacktrace for better symbolication results - Added
verbose
logging option which outputs raw events and crash reports - Add
relevant_address
to stacktrace - Extended
mechanism
- Add
build
torelease
e.g.:1.0 (1337)
- Added
objcBeforeSendEventBlock
as equivalent to swiftsbeforeSendEventBlock
- Removed
SentryClient.shared?.enableThreadNames
because KSCrash changed the mechanism on how threadnames are fetched. They will show up in sentry if available. - Now sending build number with every event.
- Fixed an issue where properties of an event will be overwritten before sending
- Added
SentryClient.shared?.enableThreadNames
variable which can be set to true in order to retrieve the thread names when a crash happens. Enable this on you own risk this could deadlock you app therefore its not yet officially documented.
- Fixed Xcode 7 support
- enable
searchThreadNames
to display thread names in sentry
- Update KSCrash to 1.13.x
Warning
- Added namespace for Objc
e.g.:
User
->SentryUser
but Xcode should suggest the new class names ... Swift code does not change
- Store events now in
Library/Caches
instead ofDocuments
folder
- Add
RequestManager
for improved handling on many requests
- Reuse
URLSession
when sending events - Optimize
BreadcrumbStore
- Default log level
.Error
- Don't strip filepath from frames
- Add
reportReactNativeFatalCrash
- Moved
docs/
to this repo - You can now take a snapshot of the stacktrace and send it with your event ... see https://docs.sentry.io/clients/cocoa/advanced/#adding-stacktrace-to-message for more information
- Added
beforeSendEventBlock
to change a event before sending it https://docs.sentry.io/clients/cocoa/advanced/#change-event-before-sending-it
- Reverse frames in stacktrace
- Remove in_app from stacktrace
- Added
SentryClient.shared?.enableAutomaticBreadcrumbTracking()
for iOS which sends all actions and viewDidAppear as breadcrumbs to the server - Fixed podspec for all target
- Improved UserFeedback controller
- Updated KSCrash to 1.11.2
- Refactored a lot of internal classes
- Added
UserFeedback
feature to iOS - Added basic support for watchOS
- Remove appleCrashReport from request
- Add mechanism to request
- Switch version/build to make iOS version in sentry more understandable
- Use
diagnosis
from KSCrash for crash reasons
Fixed for breadcrumbs not always sending on fatal
- Support for Swift 2.3 and Swift 3.0
- Fixes issue in where capturing
NSError
was not sending up to API
- Release was not getting sent up on crashes
- Contexts was getting sent up on wrong key
- Defaulting release to main bundle version
- Added support for crashing reporting for Mac apps
- Requests are now gzip before going off to Sentry API
- Fixed breadcrumbs for updated spec
- Removed all references of "raven"
- Fixed #13
- Changed merging behaviour in EventProperties
- Event takes priority over client
- Added tvOS support
- Fixes with KSCrash that will build KSCrash for all platforms
First pre-release that is ready for testers