Default Metrics

io.Insights publishes a wide array of default metrics that provide information about the system, platform and app performance, as well as data related to loading Workspaces and Global Layouts. It's possible to enable or disable all default metrics, and also to provide custom settings for each default metric individually.

For details on configuring the default metrics in io.Connect Desktop and io.Connect Browser, see the Configuration section.

⚠️ Note that some of the metrics aren't supported in io.Connect Browser due to limitations of modern browsers.

The following example demonstrates the basic structure of a metrics payload:

{
    "resourceMetrics": [
        {
            "resource": {
                "attributes": [
                    // Attributes describing the resource publishing the metrics -
                    // e.g., `"service.name"`, `"service.instance.id"`, and other standard OpenTelemetry attributes.
                ]
            },
            "scopeMetrics": [
                {
                    "scope": {
                        "name": "io.Connect Desktop",
                        "version": ""
                    },
                    "metrics": [
                        // List of objects describing the published metrics.
                    ]
                }
            ]
        }
    ]
}

The following is an example metrics object in the "metrics" array. The example uses the "app_startup" metric:

{
    "metrics": [
        {
            "name": "app_startup",
            "description": "Time to load an application",
            "unit": "ms",
            // Type of the metrics point - e.g., `"sum"`, `"gauge"`, `"histogram"`.
            "histogram": {
                "aggregationTemporality": 2,
                // Metric data points.
                "dataPoints": [
                    {
                        // Metrics attributes.
                        "attributes": [
                            {
                                "key": "api",
                                "value": {
                                    "stringValue": "6.6.0"
                                }
                            },
                            {
                                "key": "user",
                                "value": {
                                    "stringValue": "user_42"
                                }
                            },
                            {
                                "key": "platformVersion",
                                "value": {
                                    "stringValue": "9.4.0.34"
                                }
                            },
                            {
                                "key": "application",
                                "value": {
                                    "stringValue": "my-app"
                                }
                            }
                        ],
                        "bucketCounts": [
                            0,
                            1,
                            0,
                            0,
                            0,
                            0
                        ],
                        "explicitBounds": [
                            100,
                            1000,
                            10000,
                            30000,
                            60000
                        ],
                        "count": 1,
                        "sum": 483,
                        "min": 483,
                        "max": 483,
                        "startTimeUnixNano": "1723555102580000000",
                        "timeUnixNano": "1723556246869000000"
                    }
                ]
            }
        }
    ]
}

All metrics payloads have the following attributes at the "resource" level:

All metrics data points have the following attributes:

The following sections describe all default metrics, the type of Instrument used for their implementation, and any additional attributes they may have in their data points.

System

The following table lists the available metrics related to system performance:

The "system_cpu" metric has the following additional attributes:

The "system_memory" metric has the following additional attributes:

Platform

The following table lists the available metrics related to platform performance:

The "platform_startup" metric has the following additional attributes:

Apps

The following table lists the available metrics related to app performance:

The "app_count" metric has the following additional attributes:

The "app_cpu" metric has the following additional attributes:

The "app_crash" metric has the following additional attributes:

The "app_duration" metric has the following additional attributes:

The "app_error" metric has the following additional attributes:

The "app_memory" metric has the following additional attributes:

The "app_started" metric has the following additional attributes:

The "app_startup" metric has the following additional attributes:

The "app_stopped" metric has the following additional attributes:

Workspaces

The following table lists the available metrics related to Workspaces performance:

All metrics related to Workspaces have the following additional attributes:

Layouts

The following table lists the available metrics related to Global Layouts performance:

The "layout_startup" metric has the following additional attributes: