Configuration

io.Insights comes as a built-in feature of both io.Connect Desktop and io.Connect Browser. The default data points it publishes can be enabled, disabled or customized based on your specific business scenarios.

io.Insights is disabled by default. To enable io.Insights and configure its features in io.Connect Desktop, use the "otel" top-level key in the system.json system configuration file of io.Connect Desktop located in the %LocalAppData%/interop.io/io.Connect Desktop/Desktop/config folder:

{
    "otel": {
        "enabled": true,
        "metrics": {
            "enabled": true,
            "url": "http://localhost:4242/my-metrics-collector",
            "publishInterval": 60000,
            "defaultMetricsEnabled": true,
            "metrics": [
                {
                   "type": "app_crash",
                   "enabled": false
                }
            ]
        }
    }
}

The "otel" object has the following properties:

Metrics

To provide custom settings for publishing metrics, use the "metrics" property of the "otel" object.

The "metrics" object has the following properties:

You can enable, disable or override the settings for the default metrics published by io.Insights by using a combination of the "defaultMetricsEnabled" and the "metrics" properties of the "metrics" object. For instance, you can enable all default metrics by setting the "defaultMetricsEnabled" to true, and then disable or customize individual metrics by specifying the predefined metric type in the "metrics" array:

{
    "otel": {
        "enabled": true,
        "metrics": {
            "url": "http://localhost:4242/my-metrics-collector",
            "defaultMetricsEnabled": true,
            "metrics": [
                // Disabling a default metric.
                {
                   "type": "app_error",
                   "enabled": false
                },
                // Overriding the default settings for a predefined metric.
                {
                    "type": "layout_startup",
                    "name": "Global Layout Startup",
                    "description": "The time it takes to load a Global Layout.",
                    "buckets": [
                        10000,
                        15000,
                        20000,
                    ]
                }
            ]
        }
    }
}

Each object in the "metrics" array has the following properties:

The "type" property accepts the following values describing a predefined metric type:

io.Insights is disabled by default. To enable io.Insights and configure its features in io.Connect Browser, use the otel property of the configuration object when initializing your Main app:

import IOBrowserPlatform from "@interopio/browser-platform";

const config = {
    licenseKey: "my-license-key",
    // Enabling io.Insights and providing settings for publishing data.
    otel: {
        metrics: {
            url: "http://localhost:4242/my-metrics-collector",
            metrics: [
                {
                    type: "app_error",
                    enabled: false
                }
            ]
        }
    }
};

const { io } = await IOBrowserPlatform(config);

The otel object has the following properties:

Metrics

To provide custom settings for publishing metrics, use the metrics property of the otel object.

The metrics object has the following properties:

You can enable, disable or override the settings for the default metrics published by io.Insights by using the metrics property of the metrics object.

The following example demonstrates how to disable and customize individual metrics by specifying the predefined metric type in the metrics array:

import IOBrowserPlatform from "@interopio/browser-platform";

const config = {
    licenseKey: "my-license-key",
    otel: {
        metrics: {
            url: "http://localhost:4242/my-metrics-collector",
            metrics: [
                // Disabling a default metric.
                {
                   type: "app_error",
                   enabled: false
                },
                // Overriding the default settings for a predefined metric.
                {
                    type: "layout_startup",
                    name: "Global Layout Startup",
                    description: "The time it takes to load a Global Layout.",
                    buckets: [
                        10000,
                        15000,
                        20000,
                    ]
                }
            ]
        }
    }
};

const { io } = await IOBrowserPlatform(config);

Each object in the metrics array has the following properties:

The type property accepts the following values describing a predefined metric type: