Default Metrics
Overview
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.
Default Metrics
⚠️ Note that some of the metrics aren't supported in io.Connect Browser due to limitations of modern browsers.
All default metrics have the following attributes:
| Attribute | Description |
|---|---|
exported_instance |
Instance ID of the platform (e.g., "7tNTxtrmRLp0Q3B8n36C"). |
exported_job |
Name of the platform (e.g., "io.Connect Desktop"). |
platformVersion |
Version of the platform (e.g., "9.4.0.28"). |
user |
Name of the platform user (e.g., "user_42"). |
The following sections describe all default metrics as well as any additional attributes they may have.
System
The following table lists the available metrics related to system performance:
| Metric | Type | Unit | Description |
|---|---|---|---|
system_cpu |
Gauge |
percent | Current and average system CPU and average platform CPU. Not supported in io.Connect Browser. |
system_memory |
Gauge |
gigabytes | Free system memory, used system memory and used platform memory. Not supported in io.Connect Browser. |
The system_cpu metric has the following additional attributes:
| Attribute | Description |
|---|---|
type |
Determines whether the metric value reflects the current system CPU usage, the average system CPU usage, or the average platform CPU usage. Possible values for this attribute are "current_system_cpu", "average_system_cpu" and "average_platform_cpu". |
The system_memory metric has the following additional attributes:
| Attribute | Description |
|---|---|
type |
Determines whether the metric value reflects the free system memory, the used system memory, or the used platform memory. Possible values for this attribute are "free_system_memory", "used_system_memory" and "used_platform_memory". |
Platform
The following table lists the available metrics related to platform performance:
| Metric | Type | Unit | Description |
|---|---|---|---|
platform_error |
Counter |
number | Number of times a platform error was received during each platform session. |
platform_startup |
Gauge |
milliseconds | Time it took to load the platform. |
The platform_startup metric has the following additional attributes:
| Attribute | Description |
|---|---|
api |
Version string of the @interopio/desktop or the @interopio/browser-platform library depending on whether the metric was published by the io.Connect Desktop or the io.Connect Browser platform. |
Apps
The following table lists the available metrics related to app performance:
| Metric | Type | Unit | Description |
|---|---|---|---|
app_count |
UpDownCounter |
number | Number of app instances during each platform session. |
app_cpu |
Gauge |
percent | Average percentage of CPU used for the last measured interval. Not supported in io.Connect Browser. |
app_crash |
Counter |
number | Number of times an app crashed during each platform session. Not supported in io.Connect Browser. |
app_duration |
Histogram |
milliseconds | How long an app has been on focus during each platform session. |
app_error |
Counter |
number | Number of times an app error was received during each platform session. |
app_memory |
Gauge |
kilobytes | Current app memory usage. Not supported in io.Connect Browser. |
app_started |
Counter |
number | Number of times an app has been started during each platform session. |
app_startup |
Histogram |
milliseconds | Time it took to load an app. An app is considered loaded when the io.Connect API in it has been initialized. |
app_stopped |
Counter |
number | Number of times an app has been stopped during each platform session. |
The app_count metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_count metric was published. |
The app_cpu metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_cpu metric was published. |
applicationInstance |
Unique ID of the app instance within the io.Connect framework. |
The app_crash metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_crash metric was published. |
reason |
Describes the reason for the app crash. |
The app_duration metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_duration metric was published. |
The app_error metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_error metric was published. |
The app_memory metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_memory metric was published. |
applicationInstance |
Unique ID of the app instance within the io.Connect framework. |
The app_started metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_started metric was published. |
The app_startup metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_startup metric was published. |
api |
Version string of the @interopio/desktop or the @interopio/browser library depending on whether the app is running within the io.Connect Desktop or the io.Connect Browser platform. |
The app_stopped metric has the following additional attributes:
| Attribute | Description |
|---|---|
application |
Name of the app within the io.Connect framework for which the app_stopped metric was published. |
Workspaces
The following table lists the available metrics related to Workspaces performance:
| Metric | Type | Unit | Description |
|---|---|---|---|
workspace_count |
UpDownCounter |
number | Number of Workspaces running during each platform session. |
workspace_startup |
Histogram |
milliseconds | Time it took to load a Workspace. |
workspace_stopped |
Counter |
number | Number of times a Workspace has been stopped during each platform session. |
All metrics related to Workspaces have the following additional attributes:
| Attribute | Description |
|---|---|
layout |
Name of the Workspace for which the respective metric was published. |
Layouts
The following table lists the available metrics related to Global Layouts performance:
| Metric | Type | Unit | Description |
|---|---|---|---|
layout_startup |
Histogram |
milliseconds | Time it took to load a Global Layout. |
The layout_startup metric has the following additional attributes:
| Attribute | Description |
|---|---|
layout |
Name of the Global Layout for which the layout_startup metric was published. |