QtQt
Sentry's Qt integration enables automatic reporting of errors, exceptions, and log messages.
On this page, we get you up and running with Sentry's SDK.
Using a framework?
Get started using a guide listed in the right sidebar.
Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.
Sentry captures data by using an SDK within your application’s runtime.
The Qt integration is part of the sentry-native SDK, which currently supports Windows, macOS, and Linux. Both Qt 5 and Qt 6 are supported.
To build the SDK, download the latest sources from the Releases page. The SDK is managed as a CMake project, which additionally supports several configuration options, such as the backend to use.
To enable the Qt integration set the SENTRY_INTEGRATION_QT option to YES.
If the Qt libraries are not installed in one of the predefined CMake system prefix paths, where they can be found by CMake, you will need to set CMAKE_PREFIX_PATH explicitly.
For example (on macOS):
# Configure the cmake build into the `build` directory,
# with crashpad, and Qt integration (on macOS).
cmake -B build \
-D SENTRY_BACKEND=crashpad \
-D SENTRY_INTEGRATION_QT=YES
# Build the project
cmake --build build --parallel
# Install the resulting artifacts into a specific prefix
cmake --install build --prefix install
# Which will result in the following (on macOS):
exa --tree install --level 2
install
├── bin
│ └── crashpad_handler
├── include
│ └── sentry.h
└── lib
├── cmake
├── libsentry.dylib
└── libsentry.dylib.dSYM
You can configure the Qt build for Windows analogous to the regular build instructions.
Bundling crashpad_handler
When using the Crashpad backend, which is the default on Windows and macOS, the crashpad_handler binary has to be shipped alongside the application binary. See the Crashpad documentation for more information.
Configuration should happen as early as possible in your application's lifecycle.
#include <QtWidgets>
#include <sentry.h>
int main(int argc, char *argv[])
{
sentry_options_t *options = sentry_options_new();
sentry_options_set_dsn(options, "https://examplePublicKey@o0.ingest.sentry.io/0");
// This is also the default-path. For further information and recommendations:
// https://docs.sentry.io/platforms/native/configuration/options/#database-path
sentry_options_set_database_path(options, ".sentry-native");
sentry_options_set_release(options, "my-project-name@2.3.12");
sentry_options_set_debug(options, 1);
sentry_init(options);
// Make sure everything flushes
auto sentryClose = qScopeGuard([] { sentry_close(); });
QApplication app(argc, argv);
QWidget widget;
widget.show();
return app.exec();
}
Alternatively, the DSN can be passed as SENTRY_DSN environment variable during runtime. This can be especially useful for server applications.
Warning
Calling sentry_close() (formerly sentry_shutdown()) before exiting the application is critical. It ensures that events can be sent to Sentry before execution stops. Otherwise, event data may be lost.
This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.
The quickest way to verify Sentry in your Native application is by capturing a message:
sentry_capture_event(sentry_value_new_message_event(
/* level */ SENTRY_LEVEL_INFO,
/* logger */ "custom",
/* message */ "It works!"
));
Learn more about manually capturing an error or message in our Usage documentation.
To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
