QInsightConfiguration Class

Use QInsightConfiguration to configure the tracker. You must make all configuration changes before enabling the tracking. The tracker reads default values from a configuration file (qtinsight.conf), which is searched from following the locations in a decending order:

1. Application's resources file.

2. Application's directory.

3. Current working directory.

4. System configuration directories as defined by QStandardPaths::GenericConfigLocation.

Use an environment variable QT_INSIGHT_CONFIG to override the used configuration file.

Example of a JSON configuration file:

{
    "server" : "collect-insight.qt.io",
    "token" : "00000000-0000-0000-0000-000000000000",
    "device_model" :  "model 1",
    "device_variant" : "a",
    "device_screen_type" : "NON_TOUCH",
    "platform" : "app",
    "app_build" : "1.2.3",
    "storage" : "SQLITE",
    "storage_path" : "",
    "sync" : {
        "interval" : {
            "seconds" : 0
            "minutes" : 0
            "hours" : 1
            "days" : 0
            "months" : 0
        },
        "max_batch_size" : 100
    }
}

A token is used to match the data your application sends to your Qt Insight Organization and you can find your token from the Qt Insight Console.

Some of the configuration items are directly linked to the Snowblow Tracker Protocol, which defines the allowed values. These include QInsightConfiguration::setPlatform() and QInsightConfiguration::setDeviceScreenType().

QInsightConfiguration::setStorageType() can be used to configure the storage type, where SQLITE is the default value and use SQLite database to store the events before they are sent to the back-end server. If an unknown storage type is specified or it is explicitly set to an empty string, caching will be disabled. In that case the tracked data will be lost if the back-end server isn't available.

QInsightConfiguration::setStoragePath() can be used to configure the location of the storage. By default, the SQLite database is created in the application's directory.

QInsightConfiguration::setSyncInterval() can be used to configure how often the tracked events are sent to the back-end server. The API takes the value in seconds, while the json configuration file can be configured also with more natural minutes, hours, days, and months. If sync interval is not set, events will never be sent to the backend and cached only in the local storage.

QInsightConfiguration::setBatchSize is used to minimize the overhead when sending, reading and writing to the storage. When synchronizing the cached data to back-end server, at most QInsightConfiguration::batchSize() items will be fetched at once from the storage and sent to back-end server. This is more optimal, than fetching the data one by one. The sent data will be removed from the storage also in batches. The process repeats, until all data is sent. If one batch fails, the synchronization will stop, as the next batches will likely also fail.

QInsightConfiguration::QInsightConfiguration(QObject *parent = nullptr)▲

QString QInsightConfiguration::appBuild() const▲

int QInsightConfiguration::batchSize() const▲

QStringList QInsightConfiguration::categories()▲

QString QInsightConfiguration::deviceModel() const▲

QString QInsightConfiguration::deviceScreenType() const▲

QString QInsightConfiguration::deviceVariant() const▲

QStringList QInsightConfiguration::events()▲

bool QInsightConfiguration::isValid()▲

bool QInsightConfiguration::load()▲

QString QInsightConfiguration::platform() const▲

QString QInsightConfiguration::server() const▲

void QInsightConfiguration::setAppBuild(const QString &appBuild)▲

void QInsightConfiguration::setBatchSize(int batchSize)▲

void QInsightConfiguration::setCategories(const QStringList &categories)▲

void QInsightConfiguration::setDeviceModel(const QString &deviceModel)▲

void QInsightConfiguration::setDeviceScreenType(const QString &deviceScreenType)▲

void QInsightConfiguration::setDeviceVariant(const QString &deviceVariant)▲

void QInsightConfiguration::setEvents(const QStringList &events)▲

void QInsightConfiguration::setPlatform(const QString &platform)▲

void QInsightConfiguration::setServer(const QString &server)▲

void QInsightConfiguration::setStoragePath(const QString &storagePath)▲

void QInsightConfiguration::setStorageSize(int storageSize)▲

void QInsightConfiguration::setStorageType(const QString &storageType)▲

void QInsightConfiguration::setSyncInterval(int syncInterval)▲

void QInsightConfiguration::setToken(const QString &token)▲

QString QInsightConfiguration::storagePath() const▲

int QInsightConfiguration::storageSize() const▲

QString QInsightConfiguration::storageType() const▲

int QInsightConfiguration::syncInterval() const▲

QString QInsightConfiguration::token() const▲