Skip to content

Latest commit

 

History

History
759 lines (498 loc) · 29.2 KB

CHANGELOG.md

File metadata and controls

759 lines (498 loc) · 29.2 KB
Raw

Changelog

0.6.0

Breaking changes:

  • When built as a shared library for Android or Linux, the Native SDK limits the export of symbols to the sentry_-prefix. The option SENTRY_EXPORT_SYMBOLS is no longer available and the linker settings are constrained to the Native SDK and no longer PUBLIC to parent projects. (#363)

Features:

  • A session may be ended with a different status code. (#801)

Fixes:

Internal:

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.5.4

Fixes:

  • Better error messages in sentry_transport_curl. (#777)
  • Increased curl headers buffer size to 512 (in sentry_transport_curl). (#784)
  • Fix sporadic crash on Windows due to race condition when initializing background-worker thread-id. (#785)
  • Open the database file-lock on "UNIX" with O_RDRW (#791)

Internal:

  • Updated Breakpad and Crashpad backends to 2022-12-12. (#778)

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.5.3

Fixes:

  • Linux module-finder now also searches for code-id in ".note" ELF sections (#775)

Internal:

  • CI: updated github actions to upgrade deprecated node runners. (#767)
  • CI: upgraded Ubuntu to 20.04 for "old gcc" (v7) job due to deprecation. (#768)

0.5.2

Fixes:

  • Fix build when CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION is undefined. (crashpad#73)

Internal:

  • Updated Breakpad and Crashpad backends to 2022-10-17. (#765)

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.5.1

Features:

  • Crashpad on Windows now supports fast-fail crashes via a registered Windows Error Reporting (WER) module. (#735)

Fixes:

  • Fix "flush" implementation of winhttp transport. (#763)

Internal:

  • Updated libunwindstack-ndk submodule to 2022-09-16. (#759)
  • Updated Breakpad and Crashpad backends to 2022-09-14. (#735)
  • Be more defensive around transactions (#757)
  • Added a CI timeout for the Android simulator start. (#764)

0.5.0

Features:

  • Provide on_crash() callback to allow clients to act on detected crashes. Users often inquired about distinguishing between crashes and "normal" events in the before_send() hook. on_crash() can be considered a replacement for before_send() for crash events, where the goal is to use before_send() only for normal events, while on_crash() is only invoked for crashes. This change is backward compatible for current users of before_send() and allows gradual migration to on_crash() (see the docs for details). (#724, #734)

Fixes:

  • Make Windows ModuleFinder more resilient to missing Debug Info (#732)
  • Aligned pre-send event processing in sentry_capture_event() with the cross-SDK session filter order (#729)
  • Align the default value initialization for the environment payload attribute with the developer documentation (#739)
  • Iterate all debug directory entries when parsing PE modules for a valid CodeView record (#740)

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.18

Features:

  • The crashpad backend now captures thread names. (#725)
  • The inproc backend now captures the context registers. (#714)
  • A new set of APIs to get the sentry SDK version at runtime. (#726)
  • Add more convenient APIs to attach stack traces to exception or thread values. (#723)
  • Allow disabling the crash reporting backend at runtime. (#717)

Fixes:

  • Improved heuristics flagging sessions as "crashed". (#719)

Internal:

  • Updated Breakpad and Crashpad backends to 2022-06-14. (#725)

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.17

Fixes:

  • sentry-native now successfully builds when examples aren't included. (#702)

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.16

Features:

  • Removed the SENTRY_PERFORMANCE_MONITORING compile flag requirement to access performance monitoring in the Sentry SDK. Performance monitoring is now available to everybody who has opted into the experimental API.
  • New API to check whether the application has crashed in the previous run: sentry_get_crashed_last_run() and sentry_clear_crashed_last_run() (#685).
  • Allow overriding the SDK name at build time - set the SENTRY_SDK_NAME CMake cache variable.
  • More aggressively prune the Crashpad database. (#698)

Internal:

  • Project IDs are now treated as opaque strings instead of integer values. (#690)
  • Updated Breakpad and Crashpad backends to 2022-04-12. (#696)

Fixes:

  • Updated CI as well as list of supported platforms to reflect Windows Server 2016, and therefore MSVC 2017 losing active support.
  • Correctly free Windows Mutexes in Crashpad backend.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.15

Fixes:

  • Fix contexts from the scope not being attached to events correctly.
  • Improve performance of event serialization.

0.4.14

Features:

  • The Sentry SDK now has experimental support for performance monitoring. The performance monitoring API allows manually creating transactions and instrumenting spans, and offers APIs for distributed tracing. The API is currently disabled by default and needs to be enabled via a compile-time SENTRY_PERFORMANCE_MONITORING flag. For more information, take a look at the more detailed documentation of performance monitoring.
  • Sentry now has an explicit sentry_flush method that blocks the calling thread for the given time, waiting for the transport queue to be flushed. Custom transports need to implement a new flush_hook for this to work.

Fixes:

  • Fix Sentry API deadlocking when the SDK was not initialized (or sentry_init failed).
  • The rate limit handling of the default transports was updated to match the expected behavior.
  • The Windows OS version is now read from the Registry and is more accurate.
  • The SENTRY_LIBRARY_TYPE CMake option is now correctly honored.
  • The Linux Modulefinder was once again improved to increase its memory safety and reliability.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.13

Features:

  • Add client-side stackwalking on Linux, Windows, and macOS (disabled by default).
  • CMake: add ability to set solution folder name.
  • Add AIX support.

Fixes:

  • CMake: check whether libcurl was already found.
  • Increment CXX standard version to 14 to allow crashpad to build.

Internal:

  • Update Crashpad and Breakpad submodules to 2021-12-03.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.12

Features:

  • Make the shutdown timeout configurable via sentry_options_set_shutdown_timeout.

Fixes:

  • The crashpad backend compiles with mingw again.
  • Build System improvements.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.11

Fixes:

  • The crashpad backend now respects the max_breadcrumbs setting.
  • Hanging HTTP requests will now be canceled on shutdown in the WinHTTP transport.
  • The Modulefinder and Android unwinder now use safer memory access.
  • Possible races and deadlocks have been fixed in init/close, and in API related to sessions.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.10

Fixes:

  • Fix a potential deadlock in macOS modulefinder.
  • Lower Stack usage, to lower change of stack overflows.
  • Avoid a double-free when parsing an invalid DSN.
  • Improvements to Unity Builds and 32-bit Builds.
  • Fix infinite recursion in signal handler by correctly cleaning up on shutdown.

Internal:

  • Update Crashpad and Breakpad submodules to 2021-06-14.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.9

Features:

  • Rewrote the Linux modulefinder which should now work correctly when encountering gaps in the memory mapping of loaded libraries, and supports libraries loaded from a file offset, such as libraries loaded directly from .apk files on Android.
  • Invoke the before_send hook at time of a hard crash when using the Windows or Linux Crashpad backend.
  • Added the following new convenience functions:
    • sentry_value_new_exception
    • sentry_value_new_thread
    • sentry_value_new_stacktrace
    • sentry_event_add_exception
    • sentry_event_add_thread
    • The sentry_event_value_add_stacktrace is deprecated.
  • Renamed sentry_shutdown to sentry_close, though the old function is still available.
  • Updated Qt integration to Qt 6.

Fixes:

  • Optimized and fixed bugs in the JSON parser/serializer.
  • Build fixes for PPC and universal macOS.
  • Fixes to build using musl libc.
  • Correctness fixes around printf and strftime usage.
  • Allow building and running on older macOS versions.

Internal:

  • Update Crashpad and Breakpad submodules to 2021-04-12

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.8

Features:

  • The unwinder on Android was updated to a newer version.
  • Experimental support for the Breakpad backend on Android and iOS.

Fixes:

  • Fixed some memory leaks on Windows.
  • Build System improvements.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.7

Features:

  • Events will automatically get an os context with OS version information.
  • Added a new max_breadcrumbs option.

Fixes:

  • Fixed some memory leaks related to bounded breadcrumbs.

0.4.6

Fixes:

  • Restore compatibility with CMake 3.10 (as used in Android NDK Tools)

Internal:

  • Update Crashpad and Breakpad submodules to 2021-01-25

0.4.5

Features:

  • The Breakpad backend is now supported on macOS, although the crashpad backend is recommended on that platform.
  • Added a new sentry_reinstall_backend function which can be used in case a third-party library is overriding the signal/exception handler.
  • Add a Qt integration that hooks into Qt logging (opt-in CMake option).
  • Expose the sentry-native version via CMake.

Fixes:

  • Install .pdb files correctly.
  • Improve macOS runtime version detection.
  • Fixed a potential segfault when doing concurrent scope modification.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.4

Features:

  • The sentry_get_modules_list function was made public, which will return a list of loaded libraries that will be sent to sentry with each event.
  • A new sentry_options_set_transport_thread_name function was added to set an explicit name for sentries http transport thread.

Fixes:

  • The session duration is now printed in a locale-independent way, avoiding invalid session payloads.
  • Correctly clean up locks and pass the Windows Application Verifier.
  • Build fixes for MinGW and better documentation for universal MacOS builds.
  • Crashes captured by the crashpad backend after calling sentry_shutdown will now have the full metadata.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.3

Caution:

  • The representation of sentry_value_t was changed to avoid problems with the newly introduced Memory Tagging Extension (MTE) on ARM / Android. Implementation details of sentry_value_t were never considered public, and it should always be treated as an opaque type.

Fixes:

  • Fix corrupted breadcrumb data when using the crashpad backend on Windows.
  • Avoid sending empty envelopes when using the crashpad backend.
  • Correctly encode the signal number when using the Windows inproc backend, avoiding a processing Error.
  • Unwind from the local call-stack, fixing empty stacktraces when using the inproc backend on Linux.
  • Improvements to the Build configuration.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.4.2

Fixes:

  • Sampled (discarded) events still contribute to a sessions errors count.
  • Initialize all static data structures.

0.4.1

Fixes:

  • Fix parsing rate limit headers with multiple categories.

0.4.0

Breaking Changes:

  • The minimum CMake version required to build on windows was raised to 3.16.4 to avoid potential build failures on older versions.
  • The sentry_get_options function was removed, as it was unsafe to use after a sentry_shutdown call.
  • The sentry_options_set_logger function now accepts a userdata parameter.
  • The name parameter of sentry_options_add_attachment(w) was removed, it will now be inferred from the filename of path.
  • The transport startup hook that is set via sentry_transport_set_startup_func now needs to return an int, and a failure will propagate to sentry_init.
  • The return value of the transport shutdown hook set via sentry_transport_set_shutdown_func was also changed to return an int.
  • Both functions should return 0 on success, and a non-zero error code on failure, as does sentry_init.
  • Similarly, the return value of sentry_shutdown was also changed to an int, and will return 0 on success and a non-zero error code on unclean shutdown.
  • Documentation for custom transports was updated to highlight the ordering requirements of submitted envelopes, which is important for release health.
// before
sentry_options_set_logger(options, my_custom_logger);
sentry_options_add_attachment(options, "some-attachment", "/path/to/some-attachment.txt");

void transport_startup(sentry_options_t *options, void*state) {
}
sentry_transport_set_startup_func(transport, transport_startup);
bool transport_shutdown(uint64_t timeout, void*state) {
  return true;
}
sentry_transport_set_shutdown_func(transport, transport_shutdown);

// after
sentry_options_set_logger(options, my_custom_logger, NULL);
sentry_options_add_attachment(options, "/path/to/some-attachment.txt");

int transport_startup(sentry_options_t *options, void*state) {
  return 0;
}
sentry_transport_set_startup_func(transport, transport_startup);
int transport_shutdown(uint64_t timeout, void*state) {
  return 0;
}
sentry_transport_set_shutdown_func(transport, transport_shutdown);

Features:

  • Release Health support is now stable and enabled by default. After the update, you will see the number of crash free sessions and crash free users on the Releases page in Sentry. To disable automatic session tracking, use sentry_options_set_auto_session_tracking.
  • Breakpad support for Windows. This allows you to use sentry-native even on Windows XP! (#278)
  • Add an in-process backend for Windows. As opposed to Breakpad, stack traces are generated on the device and sent to Sentry for symbolication. (#287)
  • Support for the Crashpad backend was fixed and enabled for Linux. (#320)
  • A new SENTRY_BREAKPAD_SYSTEM CMake option was added to link to the system-installed breakpad client instead of building it as part of sentry.

Fixes:

  • Reworked thread synchronization code and logic in sentry_shutdown, avoiding an abort in case of an unclean shutdown. (#323)
  • Similarly, reworked global options handling, avoiding thread safety issues. (#333)
  • Fixed errors not being properly recorded in sessions. (#317)
  • Fixed some potential memory leaks and other issues. (#304 and others)

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.3.4

Fixes:

  • Invalid memory access when sentry_options_set_debug(1) is set, leading to an application crash. This bug was introduced in version 0.3.3. (#310).

0.3.3

Fixes:

  • Fix a memory unsafety issue when calling sentry_value_remove_by_key. (#297)
  • Improvements to internal logging. (#301, #302)
  • Better handling of timeouts. (#284)
  • Better 32-bit build support. (#291)
  • Run more checks on CI. (#299)

Thank you:

Fixes in this release have been contributed by:

0.3.2

Features:

  • Implement a new logger hook. (#267)

    This adds the new sentry_options_set_logger function, which can be used to customize the sentry-internal logging, for example to integrate into an app’s own logging system, or to stream logs to a file.

  • New CMake options: SENTRY_LINK_PTHREAD, SENTRY_BUILD_RUNTIMESTATIC and SENTRY_EXPORT_SYMBOLS along with other CMake improvements.

Fixes:

  • Avoid memory unsafety when loading session from disk. (#270)
  • Avoid Errors in Crashpad Backend without prior scope changes. (#272)
  • Fix absolute paths on Windows, and allow using forward-slashes as directory separators. (#266, #289)
  • Various fixes uncovered by static analysis tools, notably excessive allocations by the page-allocator used inside signal handlers.
  • Build fixes for MinGW and other compilers.

Thank you:

Features, fixes and improvements in this release have been contributed by:

0.3.1

  • Add support for on-device symbolication, which is enabled by default on Android. Use sentry_options_set_symbolize_stacktraces to customize.
  • Enable gzip compressed crashpad minidumps on windows.
  • Correctly 0-pad short build-ids.
  • Fix build for 32bit Apple targets.

0.3.0

  • Always send the newer x-sentry-envelope format, which makes this incompatible with older on-premise installations.
  • Better document and handle non-ASCII paths. Users on windows should use the w version of the appropriate APIs.
  • Avoid segfaults due to failed sentry initialization.
  • Avoid creating invalid sessions without a release.
  • Make sentry_transport_t opaque, and instead expose APIs to configure it. More functionality related to creating custom transports will be exposed in future versions.

Breaking changes

  • The sentry_backend_free function was removed.
  • The sentry_backend_t type was removed.
  • The sentry_transport_t type is now opaque. Use the following new API to create a custom transport.

New API

  • sentry_transport_new
  • sentry_transport_set_state
  • sentry_transport_set_free_func
  • sentry_transport_set_startup_func
  • sentry_transport_set_shutdown_func

See sentry.h for more documentation.

Deprecations

  • sentry_new_function_transport has been deprecated in favor of the new transport builder functions.

0.2.6

  • Avoid crash with invalid crashpad handler path.

0.2.5

  • Send sessions to the correct sentry endpoint and make sure they work.
  • Smaller cleanups.

0.2.4

  • Avoid unsafe reads in the linux module finder.
  • Update to latest crashpad snapshot.
  • Yet more CMake improvements (thanks @madebr and @Amphaal).

0.2.3

Important upgrade notice

All 0.2.x versions prior to this one were affected by a bug that could potentially lead to serious data-loss on Windows platforms. We encourage everyone to update as quickly as possible. See #220 for details.

Deprecations

  • sentry_transport_t will be replaced by an opaque struct with setter methods in a future release.
  • sentry_backend_free and sentry_backend_t are deprecated and will be removed in a future release.

Other changes

  • Further improvements to the cmake build system (huge thanks to @madebr #207)
  • Improved support for older Windows versions, as low as Windows XP SP3 (thanks to @Mixaill #203, @cammm #202 and @jblazquez #212)
  • Improved documentation
  • Cleaned up sentry database handling
  • Added new sentry_handle_exception function to explicitly capture a crash (thanks @cammm #201)
  • Added new sentry_clear_modulecache function to clear the list of loaded modules. Use this function when dynamically loading libraries at runtime.

0.2.2

  • Implement experimental Session handling
  • Implement more fine grained Rate Limiting for HTTP requests
  • Implement sample_rate option
  • In-process and Breakpad backend will not lose events queued for HTTP submission on crash
  • sentry_shutdown will better clean up after itself
  • Add Experimental MinGW build support (thanks @Amphaal #189)
  • Various other fixes and improvements

0.2.1

  • Added Breakpad support on Linux
  • Implemented fallback debug-id on Linux and Android for modules that are built without a build-id
  • Fixes issues and added CI for more platforms/compilers, including 32-bit Linux and 32-bit VS2017
  • Further improvements to the CMake configuration (thanks @madebr #168)
  • Added a new SENTRY_TRANSPORT CMake option to customize the default HTTP transport

0.2.0

  • Complete rewrite in C
  • Build system was switched to CMake
  • Add attachment support
  • Better support for custom transports
  • The crashpad backend will automatically look for a crashpad_handler executable next to the running program if no handler_path is set.

Breaking Changes

  • The sentry_uuid_t struct is now always a char bytes[16] instead of a platform specific type.

  • sentry_remove_context: The second parameter was removed.

  • sentry_options_set_transport: This function now takes a pointer to the new sentry_transport_t type. Migrating from the old API can be done by wrapping with sentry_new_function_transport, like this:

    sentry_options_set_transport(
      options, sentry_new_function_transport(send_envelope_func, &closure_data));

Other API Additions

  • size_t sentry_value_refcount(sentry_value_t value)
  • void sentry_envelope_free(sentry_envelope_t *envelope)
  • void sentry_backend_free(sentry_backend_t *backend)

0.1.4

  • Add an option to enable the system crash reporter
  • Fix compilation warnings

0.1.3

  • Stack unwinding on Android
  • Fix UUID generation on Android
  • Fix concurrently captured events leaking data in some cases
  • Fix crashes when the database path contains both slashes and backslashes
  • More robust error handling when creating the database folder
  • Fix wrong initialization of CA info for the curl backend
  • Disable the system crash handler on macOS for faster crashes

0.1.2

  • Fix SafeSEH builds on Win32
  • Fix a potential error when shutting down after unloading libsentry on macOS

0.1.1

  • Update Crashpad
  • Fix compilation on Windows with VS 2019
  • Fix a bug in the JSON serializer causing invalid escapes
  • Fix a bug in the Crashpad backend causing invalid events
  • Reduce data event data sent along with minidumps
  • Experimental support for Android NDK

0.1.0

  • Support for capturing messages
  • Add an API to capture arbitrary contexts (sentry_set_context)
  • Fix scope information being lost in some cases
  • Experimental on-device unwinding support
  • Experimental on-device symbolication support

0.0.4

  • Breakpad builds on all platforms
  • Add builds for Windows (x86)
  • Add builds for Linux

0.0.3

  • Fix debug information generation on macOS

0.0.2

  • Crashpad builds on macOS
  • Crashpad builds on Windows (x64)

0.0.1

Initial Release