io.Insights Documentation - Signals > Traces

Overview

Available since io.Connect Desktop 10.1

io.Insights publishes a wide array of default traces that provide information about the platform processes and client library usage. The following sections describe the default trace instrumentations provided by io.Insights for the io.Connect Desktop platform and the @interopio/desktop library.

All published traces have common resource attributes.

All spans have common span attributes specific to the instrumented entity (e.g., the io.Connect Desktop platform, the @interopio/desktop library) that are described in the respective main entity section.

Each span entry may have additional span attributes described in the respective span sub-section. If a span sub-section contains only the span description, this means that it doesn't have any span-specific attributes.

The tables describing the specific span attributes also list the verbosity level at which some attributes are published. If a span attribute can be used in the span filtering context, this is explicitly stated in its description.

Trace Payload Structure

Traces are published as standard OpenTelemetry trace payloads.

ℹ️ For more details on the standard structure of OpenTelemetry signals, see the OpenTelemetry examples in GitHub.

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

{
    "resourceSpans": [
        {
            "resource": {
                "attributes": [
                    // Attributes describing the resource publishing the traces -
                    // e.g., `"service.name"`, `"service.instance.id"`, and other standard OpenTelemetry attributes.
                ]
            },
            "scopeSpans": [
                {
                    "scope": {
                        "name": "interopio.desktop.startup",
                        "version": ""
                    },
                    "spans": [
                        // List of span objects describing the published spans.
                    ]
                }
            ]
        }
    ]
}

The following is an example of a trace payload containing spans from the "interopio.desktop.startup" trace. The root span "interopio.desktop.startup" has two child spans ("interopio.desktop.startup.startup" and "interopio.desktop.startup.init") - linked to it via the "parentSpanId" field:

{
    "resourceSpans": [
        {
            "resource": {
                "attributes": [
                    { "key": "service.name", "value": { "stringValue": "io.Connect Desktop" } },
                    { "key": "service.instance.id", "value": { "stringValue": "hSzwWyE3TkdE5r-ZqmTq" } },
                    { "key": "service.version", "value": { "stringValue": "10.1.0" } },
                    { "key": "user", "value": { "stringValue": "user_42" } },
                    { "key": "user.id", "value": { "stringValue": "user_42" } },
                    { "key": "platformVersion", "value": { "stringValue": "10.1.0" } },
                    { "key": "machine", "value": { "stringValue": "PW052B0C" } },
                    { "key": "host", "value": { "stringValue": "iocd" } },
                    { "key": "osUser", "value": { "stringValue": "user_42" } },
                    { "key": "region", "value": { "stringValue": "DEMO" } },
                    { "key": "env", "value": { "stringValue": "DEMO" } },
                    { "key": "advancedMode", "value": { "boolValue": true } },
                    { "key": "tracingAppName", "value": { "stringValue": "io.Connect Desktop" } },
                    { "key": "tracingAppInstance", "value": { "stringValue": "hSzwWyE3TkdE5r-ZqmTq" } }
                ],
                "droppedAttributesCount": 0
            },
            // The root span.
            "scopeSpans": [
                {
                    "scope": {
                        "name": "interopio.desktop.startup",
                        "version": ""
                    },
                    "spans": [
                        {
                            "traceId": "db787c70760f29b163566c96b9863198",
                            "spanId": "1a95dcb7bdaeb0ff",
                            "parentSpanId": "",
                            "name": "interopio.desktop.startup",
                            "kind": 1,
                            "startTimeUnixNano": 1774876487256000000,
                            "endTimeUnixNano": 1774876519690000000,
                            "attributes": [
                                { "key": "platformVersion", "value": { "stringValue": "10.1.0" } },
                                { "key": "sid", "value": { "stringValue": "user_42" } }
                            ],
                            "droppedAttributesCount": 0,
                            "droppedEventsCount": 0,
                            "droppedLinksCount": 0,
                            "status": { "code": 0, "message": "" }
                        }
                    ]
                }
            ]
        },
        {
            "resource": {
                // Same resource attributes as above.
            },
            // Child spans share the same `traceId` and reference the root span via `parentSpanId`.
            "scopeSpans": [
                {
                    "scope": {
                        "name": "interopio.desktop.startup.startup",
                        "version": ""
                    },
                    "spans": [
                        {
                            "traceId": "db787c70760f29b163566c96b9863198",
                            "spanId": "92f6f18630754d8e",
                            "parentSpanId": "1a95dcb7bdaeb0ff",
                            "name": "interopio.desktop.startup.startup",
                            "kind": 1,
                            "startTimeUnixNano": 1774876487256000000,
                            "endTimeUnixNano": 1774876487998000000,
                            "attributes": [
                                { "key": "platformVersion", "value": { "stringValue": "10.1.0" } },
                                { "key": "sid", "value": { "stringValue": "user_42" } }
                            ],
                            "droppedAttributesCount": 0,
                            "droppedEventsCount": 0,
                            "droppedLinksCount": 0,
                            "status": { "code": 0, "message": "" }
                        },
                        {
                            "traceId": "db787c70760f29b163566c96b9863198",
                            "spanId": "59be404068f0a82b",
                            "parentSpanId": "1a95dcb7bdaeb0ff",
                            "name": "interopio.desktop.startup.init",
                            "kind": 1,
                            "startTimeUnixNano": 1774876488135000000,
                            "endTimeUnixNano": 1774876488298000000,
                            "attributes": [
                                { "key": "platformVersion", "value": { "stringValue": "10.1.0" } },
                                { "key": "sid", "value": { "stringValue": "user_42" } }
                            ],
                            "droppedAttributesCount": 0,
                            "droppedEventsCount": 0,
                            "droppedLinksCount": 0,
                            "status": { "code": 0, "message": "" }
                        }
                    ]
                }
            ]
        }
    ]
}

Platform

The io.Connect Desktop platform publishes traces related to the platform processes and operations. All spans related to the io.Connect Desktop platform are prefixed with "interopio.desktop".

Common Span Attributes

All spans created by the io.Connect Desktop platform have the following common span attributes:

Attribute	Type	Description
`platformVersion`	`string`	The version of the platform (e.g., `"10.1.0"`).
`sid`	`string`	The impersonated (SSO) user identity, set after authentication. This may differ from `user` when one person authenticates as another.

Each span may also have additional attributes. These span-specific attributes are described in the respective span sub-sections.

All additional data point attributes provided via the platform configuration or dynamically via the Insights API will also be included in the respective data points. If the resource-level attributes are configured to be merged with the data point attributes, all resource-level attributes will also be included in every data point.

ℹ️ For details on the resource-level attributes common to all signals (metrics, traces, logs), see the Signals > Overview > Common Resource Attributes section.

interopio.desktop.app

Traces related to app lifecycle events on the platform level.

interopio.desktop.app.restore

Span is created when an app instance is restored.

Additional span attributes:

Field	Type	Level	Description
`activityInfo`	`object`	`DEBUG`	ActivityInfo.
`appName`	`string`	-	Name of the app. Can be used in the span filtering context.
`context`	`object`	`DEBUG`	App context.
`restoreState`	`object`	`DEBUG`	Restore state.

interopio.desktop.app.start

Span is created when an app instance starts.

Additional span attributes:

Field	Type	Level	Description
`activityInfo`	`object`	`DEBUG`	ActivityInfo.
`context`	`object`	`DEBUG`	App context.
`name`	`string`	-	Name of the app. Can be used in the span filtering context.

interopio.desktop.internal

Traces related to internal platform operations.

interopio.desktop.internal.facade.handleControl

Span is created when the handleControl() method is invoked. This span cannot be a root span and can only be nested within another span.

Additional span attributes:

Field	Type	Level	Description
`operation`	`string`	-	`ControlArguments.operation`. Can be used in the span filtering context.

interopio.desktop.layouts

Traces related to Layout management on the platform level.

interopio.desktop.layouts.convertSwimlaneToWorkspaceLayout

Span is created when a Swimlane Layout is converted to a Workspace Layout.

Additional span attributes:

Field	Type	Level	Description
`name`	`string`	-	Layout name. Can be used in the span filtering context.
`type`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.layouts.deselectDefaultLayout

Span is created when a default Layout is deselected.

interopio.desktop.layouts.hibernate

Span is created when a Layout is hibernated.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.layouts.hibernateGroup

Span is created when a group of Layouts is hibernated.

Additional span attributes:

Field	Type	Level	Description
`groupId`	`string`	-	Layout group ID. Can be used in the span filtering context.

interopio.desktop.layouts.import

Span is created when a Layout is imported.

Additional span attributes:

Field	Type	Level	Description
`count`	`number`	-	Layouts count. Can be used in the span filtering context.

interopio.desktop.layouts.refresh

Span is created when layouts are refreshed.

interopio.desktop.layouts.remove

Span is created when a Layout is removed.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.layouts.rename

Span is created when a Layout is renamed.

Additional span attributes:

Field	Type	Level	Description
`newName`	`string`	-	New name of the Layout. Can be used in the span filtering context.
`oldName`	`string`	-	Old name of the Layout. Can be used in the span filtering context.

interopio.desktop.layouts.reset

Span is created when a Layout is reset.

Additional span attributes:

Field	Type	Level	Description
`message`	`object`	-	`ResetMessage`. Can be used in the span filtering context.

interopio.desktop.layouts.restore

Span is created when a Layout is restored.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.
`options`	`object`	`DEBUG`	Restore options.

interopio.desktop.layouts.restoreGlobal

Span is created when the Global Layout is restored.

Additional span attributes:

Field	Type	Level	Description
`currentInstances`	`any`	-	Current instances. Can be used in the span filtering context.
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.

interopio.desktop.layouts.restoreLayout

Span is created when a specific Layout is restored.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Name of the Layout to restore. Can be used in the span filtering context.

interopio.desktop.layouts.resume

Span is created when a Layout is resumed.

Additional span attributes:

Field	Type	Level	Description
`cleanUp`	`boolean`	`INFO`	Whether to clean up.
`context`	`object`	`DIAGNOSTIC`	Context for the Layout.
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.layouts.resumeGroup

Span is created when a group of Layouts is resumed.

Additional span attributes:

Field	Type	Level	Description
`groupId`	`string`	-	Layout group ID. Can be used in the span filtering context.

interopio.desktop.layouts.save

Span is created when a Layout is saved.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.
`options`	`object`	`DEBUG`	Save options.

interopio.desktop.layouts.saveDefaultLayout

Span is created when the default Layout is saved.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.layouts.saveLayout

Span is created when a specific Layout is saved in the store.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.layouts.selectDefaultLayout

Span is created when a default Layout is selected.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.

interopio.desktop.layouts.setCurrentLayout

Span is created when the current Layout is set.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.

interopio.desktop.layouts.updateDefaultContext

Span is created when the default context for a Layout component is updated.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	Context to update.
`windowId`	`string`	-	ID of the window. Can be used in the span filtering context.

interopio.desktop.layouts.updateLayoutComponentContext

Span is created when the context for a Layout component is updated.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	Context to update.
`windowId`	`string`	-	ID of the window. Can be used in the span filtering context.

interopio.desktop.layouts.updateMetadata

Span is created when Layout metadata is updated.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`layoutType`	`string`	-	Layout type. Can be used in the span filtering context.

interopio.desktop.startup

Span is created when the platform starts and serves as the parent span for all individual startup spans.

interopio.desktop.startup.askSplashToPingGW

Span is created when the splash screen is asked to ping the io.Connect Gateway.

interopio.desktop.startup.authenticateAndSetupJsClient

Span is created when the JavaScript client is authenticated and configured.

interopio.desktop.startup.bootstrapper

Span is created as the top-level bootstrapper span during startup.

interopio.desktop.startup.checkForAutoUpdates

Span is created when the system checks for auto-updates.

interopio.desktop.startup.checkIfGWisNotOccupied

Span is created when the system checks if the io.Connect Gateway is available.

interopio.desktop.startup.connectToTheGW

Span is created when the app attempts to establish a connection to the io.Connect Gateway.

interopio.desktop.startup.createApplicationFolders

Span is created when necessary app folders are created during startup.

interopio.desktop.startup.initApplications

Span is created when apps setup begins.

interopio.desktop.startup.initApplicationStores

Span is created when app stores are initialized.

interopio.desktop.startup.initAppLogger

Span is created when the AppLogger is initialized.

interopio.desktop.startup.initAppPosManager

Span is created when the AppPositionManager is initialized.

interopio.desktop.startup.initAppPrefs

Span is created when the app preferences are initialized during startup.

interopio.desktop.startup.initAppsApiTracker

Span is created when API tracking for apps is initialized.

interopio.desktop.startup.initChannels

Span is created when Channels are initialized.

interopio.desktop.startup.initCommands

Span is created when Commands Manager is initialized.

interopio.desktop.startup.initExtensions

Span is created when system extensions are initialized.

interopio.desktop.startup.initGDAgmFacade

Span is created when the GDAgm facade is initialized.

interopio.desktop.startup.initGlobalRestoreSplash

Span is created when the global restore splash is initialized during startup.

interopio.desktop.startup.initGtf

Span is created when the GtfManager is initialized.

interopio.desktop.startup.initHotkeys

Span is created when the initHotkeys() method initializes keyboard shortcuts during startup.

interopio.desktop.startup.initializeAuthController

Span is created when the authentication controller is initialized.

interopio.desktop.startup.initializeThemesSupport

Span is created when ThemesManager is initialized.

interopio.desktop.startup.initInterception

Span is created when request interception manager is initialized.

interopio.desktop.startup.initIssueReporting

Span is created when the IssueReportingManager is initialized during startup.

interopio.desktop.startup.initLayouts

Span is created when Layouts are initialized.

interopio.desktop.startup.initLocalGwManager

Span is created when the local io.Connect Gateway manager is initialized.

interopio.desktop.startup.initLogStreaming

Span is created when log streaming is set up.

interopio.desktop.startup.initMetrics

Span is created when system metrics are initialized.

interopio.desktop.startup.initNativeModules

Span is created when native modules are initialized.

interopio.desktop.startup.initNotifications

Span is created when Notifications is initialized.

interopio.desktop.startup.initPerfCollector

Span is created when the performance data collector is initialized.

interopio.desktop.startup.initProtocolHandler

Span is created when the protocol handler is initialized.

interopio.desktop.startup.initRunningInstances

Span is created when running instances manager is initialized.

interopio.desktop.startup.initSearchProvider

Span is created when the search provider is initialized.

interopio.desktop.startup.initServer

Span is created when the server is initialized.

interopio.desktop.startup.initSsoAuthController

Span is created when the Single Sign-On (SSO) authentication controller is initialized.

interopio.desktop.startup.initSystemAppStores

Span is created when system app stores are initialized.

interopio.desktop.startup.initTelemetry

Span is created when telemetry manager is initialized.

interopio.desktop.startup.initWebGroups

Span is created when web groups are initialized.

interopio.desktop.startup.initWorkspaces

Span is created when Workspace management is initialized.

interopio.desktop.startup.pingGW

Span is created when the system pings the io.Connect Gateway.

interopio.desktop.startup.restoreGlobalDefaultLayout

Span is created when the default Global Layout is restored.

interopio.desktop.startup.retrieveUsername

Span is created when the username is retrieved during startup.

interopio.desktop.startup.setupCrashReporting

Span is created when crash reporting is set up.

interopio.desktop.startup.setupDisplayManager

Span is created when the DisplayManager is configured.

interopio.desktop.startup.setupGLUE

Span is created when an instance of the Glue library is set up in the system.

interopio.desktop.startup.setupProtocolHandlerConfig

Span is created when the protocol handler configuration is set up.

interopio.desktop.startup.setupWebGroups

Span is created when web groups are set up.

interopio.desktop.startup.setupWindows

Span is created when WindowManager is set up during startup.

interopio.desktop.startup.showTray

Span is created when the tray icon is created.

interopio.desktop.startup.startAutoStartAppsByStage

Span is created when apps configured for auto-start are launched.

Additional span attributes:

Field	Type	Level	Description
`stage`	`string`	-	Auto-start stage. Can be used in the span filtering context.

interopio.desktop.startup.startSystemAppsCoreStage

Span is created when the core stage of system apps is started.

interopio.desktop.startup.updateGlueJs

Span is created when updateGlueJs is invoked during startup.

interopio.desktop.startup.verifyLic

Span is created when the license is verified during startup.

interopio.desktop.startup.waitForGWEndpoint

Span is created while waiting for the io.Connect Gateway endpoint to be available.

Additional span attributes:

Field	Type	Level	Description
`port`	`number` \| `string`	-	Port used by the io.Connect Gateway. Can be used in the span filtering context.

interopio.desktop.userJourney

These spans represent the user's activity in terms of focusing and dismissing interop-enabled apps.

interopio.desktop.userJourney.onFocus

Traced when an io.Connect Window receives or loses focus.

Additional span attributes:

Field	Type	Level	Description
`appInstanceId`	`string`	-	ID of app instance whose window is affected. Can be used in the span filtering context.
`appName`	`string`	-	Name of app whose window is affected. Can be used in the span filtering context.
`bounds`	`object`	-	Window bounds. Can be used in the span filtering context.
`focused`	`boolean`	-	Indicates whether the event represents the window receiving or losing focus. Can be used in the span filtering context.
`title`	`string`	-	Window title. Can be used in the span filtering context.
`windowId`	`string`	-	ID of window that is affected. Can be used in the span filtering context.

interopio.desktop.userJourney.onLostFocus

Traced when an io.Connect Window loses focus.

Additional span attributes:

Field	Type	Level	Description
`appInstanceId`	`string`	-	ID of app instance whose window lost focus. Can be used in the span filtering context.
`appName`	`string`	-	Name of app whose window lost focus. Can be used in the span filtering context.
`bounds`	`object`	-	Window bounds. Can be used in the span filtering context.
`focused`	`boolean`	-	Always `false`. Can be used in the span filtering context.
`title`	`string`	-	Window title. Can be used in the span filtering context.
`windowId`	`string`	-	ID of window that lost focus. Can be used in the span filtering context.

interopio.desktop.userJourney.start

A single span with this name is created when the platform is started, and it's used as a parent span to all the individual userJourney spans.

interopio.desktop.workspaces

Traces related to Workspace management on the platform level.

interopio.desktop.workspaces.addSnapRefusedWindowToWorkspace

Span is created when a snap-refused window is added to a Workspace.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`sourceWindowId`	`string`	-	ID of the source window. Can be used in the span filtering context.
`targetWindowId`	`string`	-	ID of the target window. Can be used in the span filtering context.

interopio.desktop.workspaces.addWindow

Span is created when a window is added to a Workspace.

Additional span attributes:

Field	Type	Level	Description
`application`	`string`	-	Name of the app. Can be used in the span filtering context.
`id`	`string`	-	Window ID. Can be used in the span filtering context.
`parentId`	`string`	-	Parent container ID. Can be used in the span filtering context.

interopio.desktop.workspaces.addWindowToWorkspaceWithOwner

Span is created when a window is added to a Workspace with owner.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`sourceWindowId`	`string`	-	ID of the source window. Can be used in the span filtering context.
`targetWindowId`	`string`	-	ID of the target window. Can be used in the span filtering context.

interopio.desktop.workspaces.bundleItem

Span is created when a Workspace item is bundled.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.
`type`	`string`	-	Bundle type. Can be used in the span filtering context.

interopio.desktop.workspaces.bundleWorkspace

Span is created when a Workspace is bundled.

Additional span attributes:

Field	Type	Level	Description
`type`	`string`	-	Bundle type. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.canCloseWindows

Span is created when checking if windows can be closed.

Additional span attributes:

Field	Type	Level	Description
`gdWindowIds`	`array`	-	IDs of the windows to check. Can be used in the span filtering context.

interopio.desktop.workspaces.canStopInstances

Span is created when checking if instances can be stopped.

interopio.desktop.workspaces.changeFrameState

Span is created when the state of a frame is changed.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`requestedState`	`string`	-	Requested frame state. Can be used in the span filtering context.

interopio.desktop.workspaces.changeFrameVisibility

Span is created when the visibility of a frame is changed.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.close

Span is created when a Workspace is closed.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.closeFrame

Span is created when a frame is closed.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`saveAppDefault`	`boolean`	-	Whether to save the app default. Can be used in the span filtering context.

interopio.desktop.workspaces.closeItem

Span is created when a Workspace item is closed.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.
`options`	`object`	-	Close options. Can be used in the span filtering context.

interopio.desktop.workspaces.closeWindow

Span is created when a window in a Workspace is closed.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`windowId`	`string`	-	ID of the window. Can be used in the span filtering context.

interopio.desktop.workspaces.create

Span is created when a Workspace is created.

Additional span attributes:

Field	Type	Level	Description
`appName`	`string`	-	Name of app. Can be used in the span filtering context.
`frameId`	`string`	-	Frame ID. Can be used in the span filtering context.
`layoutName`	`string`	-	Layout name. Can be used in the span filtering context.
`loadingStrategy`	`"direct"` \| `"delayed"` \| `"lazy"`	-	Loading strategy. Can be used in the span filtering context.
`restoreAppName`	`string`	-	Restore app name. Can be used in the span filtering context.
`restoreFrameId`	`string`	-	Restore frame ID. Can be used in the span filtering context.
`restoreLoadingStrategy`	`"direct"` \| `"delayed"` \| `"lazy"`	-	Restore loading strategy. Can be used in the span filtering context.
`restoreTitle`	`string`	-	Restore title. Can be used in the span filtering context.
`title`	`string`	-	Workspace title. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.createEmptyFrame

Span is created when an empty frame is created.

Additional span attributes:

Field	Type	Level	Description
`newFrame`	`boolean`	-	Whether to create a new frame. Can be used in the span filtering context.
`reuseFrameId`	`string`	-	ID of the frame to reuse. Can be used in the span filtering context.

interopio.desktop.workspaces.createEmptyWorkspace

Span is created when an empty Workspace is created.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.createFrame

Span is created when a frame is created.

interopio.desktop.workspaces.ejectAndMoveWindow

Span is created when a window is ejected and moved.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.
`windowId`	`string`	-	ID of the window. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.ejectAndMoveWorkspace

Span is created when a Workspace is ejected and moved.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.ejectWindow

Span is created when a window is ejected from a Workspace.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.focusItem

Span is created when a Workspace item is focused.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.focusLastFocusedWindow

Span is created when the last focused window is focused.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.focusWindowAndWorkspace

Span is created when a window and its Workspace are focused.

Additional span attributes:

Field	Type	Level	Description
`placementId`	`string`	-	Placement ID. Can be used in the span filtering context.

interopio.desktop.workspaces.focusWindowAndWorkspaceIfNotMinimized

Span is created when a window and its Workspace are focused if the frame is not minimized.

Additional span attributes:

Field	Type	Level	Description
`activateFrame`	`boolean`	-	Whether to activate the frame. Can be used in the span filtering context.
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.getDecorationsSize

Span is created when the decorations size is retrieved.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.getPlacementIdForLoadingWindow

Span is created when the placement ID is retrieved for a loading window.

Additional span attributes:

Field	Type	Level	Description
`windowId`	`string`	-	ID of the window. Can be used in the span filtering context.

interopio.desktop.workspaces.getTaskbarIcon

Span is created when the taskbar icon is retrieved.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.handleRegisterShortcut

Span is created when a shortcut is registered.

Additional span attributes:

Field	Type	Level	Description
`callbackId`	`string`	-	Callback ID. Can be used in the span filtering context.
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`shortcut`	`string`	-	Shortcut key combination. Can be used in the span filtering context.

interopio.desktop.workspaces.handleSetMaximizationBoundary

Span is created when the maximization boundary is set.

Additional span attributes:

Field	Type	Level	Description
`enabled`	`boolean`	-	Whether the maximization boundary is enabled. Can be used in the span filtering context.
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.handleUnregisterShortcut

Span is created when a shortcut is unregistered.

Additional span attributes:

Field	Type	Level	Description
`callbackId`	`string`	-	Callback ID. Can be used in the span filtering context.
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`shortcut`	`string`	-	Shortcut key combination. Can be used in the span filtering context.

interopio.desktop.workspaces.hibernate

Span is created when a Workspace is hibernated.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.hibernateWorkspace

Span is created when a Workspace is hibernated.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.hideWindowLoadingAnimation

Span is created when the window loading animation is hidden.

Additional span attributes:

Field	Type	Level	Description
`workspaceWindowId`	`string`	-	ID of the Workspace window. Can be used in the span filtering context.

interopio.desktop.workspaces.hideWorkspaceLoadingAnimation

Span is created when the Workspace loading animation is hidden.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.initFrame

Span is created when the Workspace frame is initialized.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	Frame ID. Can be used in the span filtering context.
`workspaces`	`string[]`	-	List of Workspace names. Can be used in the span filtering context.

interopio.desktop.workspaces.insertFrame

Span is created when a frame is inserted.

Additional span attributes:

Field	Type	Level	Description
`index`	`number`	-	Insertion index. Can be used in the span filtering context.
`sourceFrameId`	`string`	-	ID of the source frame. Can be used in the span filtering context.
`targetFrameId`	`string`	-	ID of the target frame. Can be used in the span filtering context.

interopio.desktop.workspaces.loadWindow

Span is created when a Workspace window is loaded.

Additional span attributes:

Field	Type	Level	Description
`appName`	`string`	`INFO`	App name.
`itemId`	`string`	-	Window ID. Can be used in the span filtering context.
`windowId`	`string`	`INFO`	Window ID.

interopio.desktop.workspaces.lockContainer

Span is created when a container is locked.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.lockWindow

Span is created when a window is locked within a Workspace.

Additional span attributes:

Field	Type	Level	Description
`windowPlacementId`	`string`	-	Placement ID of the window. Can be used in the span filtering context.

interopio.desktop.workspaces.lockWorkspace

Span is created when a Workspace is locked.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.maximizeContainer

Span is created when a container is maximized.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.maximizeItem

Span is created when a Workspace item is maximized.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.moveFrame

Span is created when a frame is moved.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.moveWindow

Span is created when a window is moved within a Workspace.

Additional span attributes:

Field	Type	Level	Description
`containerId`	`string`	-	ID of the target container. Can be used in the span filtering context.
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.onSelectionChanged

Span is created when onSelectionChanged method is invoked.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.open

Span is created when a Workspace Layout is opened.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`layoutName`	`string`	-	Name of the Layout. Can be used in the span filtering context.
`restoreAppName`	`string`	-	App name for restore. Can be used in the span filtering context.
`restoreFrameId`	`string`	-	ID of the frame for restore. Can be used in the span filtering context.
`restoreLoadingStrategy`	`string`	-	Loading strategy for restore. Can be used in the span filtering context.
`restoreTitle`	`string`	-	Title for restore. Can be used in the span filtering context.

interopio.desktop.workspaces.pinWorkspace

Span is created when a Workspace is pinned.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.preventableCloseFrame

Span is created when a preventable frame close is attempted.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`saveAppDefault`	`boolean`	-	Whether to save the app default. Can be used in the span filtering context.

interopio.desktop.workspaces.processCanCloseFrameInfo

Span is created when processing can-close frame info.

interopio.desktop.workspaces.resizeItem

Span is created when a Workspace item is resized.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.restoreContainer

Span is created when a container is restored.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.restoreItem

Span is created when a Workspace item is restored.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.

interopio.desktop.workspaces.restoreLayout

Span is created when a Workspace Layout is restored.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`layoutName`	`string`	-	Name of the Layout. Can be used in the span filtering context.

interopio.desktop.workspaces.resume

Span is created when a Workspace is resumed.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.resumeWorkspace

Span is created when a Workspace is resumed from hibernation.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.setItemTitle

Span is created when the title of a Workspace item is set.

Additional span attributes:

Field	Type	Level	Description
`itemId`	`string`	-	ID of the item. Can be used in the span filtering context.
`title`	`string`	-	New title. Can be used in the span filtering context.

interopio.desktop.workspaces.setLoadingStrategy

Span is created when the loading strategy is set.

Additional span attributes:

Field	Type	Level	Description
`strategy`	`string`	-	Loading strategy. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.setTaskbarIcon

Span is created when the taskbar icon is set.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.setWindowDragMode

Span is created when the window drag mode is set.

Additional span attributes:

Field	Type	Level	Description
`dragMode`	`string`	-	Drag mode. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.setWorkspaceIcon

Span is created when the Workspace icon is set.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.showDialog

Span is created when a dialog is shown in a frame.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.showPopup

Span is created when a popup is shown in a frame.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`windowId`	`string`	-	ID of the window. Can be used in the span filtering context.

interopio.desktop.workspaces.showPreventCloseDialog

Span is created when a prevent-close dialog is shown.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.

interopio.desktop.workspaces.showPreventCloseDialogForFrames

Span is created when a prevent-close dialog is shown for multiple frames.

interopio.desktop.workspaces.showWorkspaceLoadingAnimation

Span is created when the Workspace loading animation is shown.

Additional span attributes:

Field	Type	Level	Description
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.startApplication

Span is created when an app instance starts within a Workspace.

Additional span attributes:

Field	Type	Level	Description
`appName`	`string`	-	Name of app. Can be used in the span filtering context.
`instanceId`	`string`	-	ID of app instance. Can be used in the span filtering context.
`title`	`string`	-	Title of app. Can be used in the span filtering context.

interopio.desktop.workspaces.unpinWorkspace

Span is created when a Workspace is unpinned.

Additional span attributes:

Field	Type	Level	Description
`frameId`	`string`	-	ID of the frame. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

interopio.desktop.workspaces.updateLayoutName

Span is created when a Workspace Layout name is updated.

Additional span attributes:

Field	Type	Level	Description
`layoutName`	`string`	-	New Layout name. Can be used in the span filtering context.
`workspaceId`	`string`	-	Workspace ID. Can be used in the span filtering context.

@interopio/desktop

The @interopio/desktop library publishes traces related to the internal library operations and API usage. All spans related to the @interopio/desktop library are prefixed with "interopio.api".

Common Span Attributes

All spans from the @interopio/desktop library have the following common span attributes:

Attribute	Type	Description
`interopioCoreVersion`	`string`	The version of the `@interopio/core` library.
`interopioLibVersion`	`string`	The version of the `@interopio/desktop` library.
`platformVersion`	`string`	The version of the platform.
`sid`	`string`	The impersonated (SSO) user identity.
`tracingAppInstanceId`	`string`	The io.Connect app instance ID (e.g., `"44116_2"`).

Each span may also have additional attributes. These span-specific attributes are described in the respective span sub-sections.

All additional data point attributes provided via the platform configuration or dynamically via the Insights API will also be included in the respective data points. If the resource-level attributes are configured to be merged with the data point attributes, all resource-level attributes will also be included in every data point.

ℹ️ For details on the resource-level attributes common to all signals (metrics, traces, logs), see the Signals > Overview >Common Resource Attributes section.

interopio.api

Top-level library spans.

interopio.api.application.close

Span is created when the app is closed. Only emitted when close tracing is enabled.

interopio.api.startup

Span is created when the library starts. It wraps the entire initialization and resolves when the library is ready.

interopio.api.appManager

Traces related to using the App Management API accessible via the io.appManager object.

interopio.api.appManager.application.start

Traces the execution of the application.start() method.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	The starting context of the instance. Can be used in the span filtering context.
`options`	`object`	`DEBUG`	`IOConnectDesktop.AppManager.ApplicationStartOptions`.

interopio.api.appManager.callbacks.onAppAdded

Traces the execution of the onAppAdded() callback.

Additional span attributes:

Field	Type	Level	Description
`applicationName`	`string`	`INFO`	Name of the app.

interopio.api.appManager.callbacks.onAppAvailable

Traces the execution of the onAppAvailable() callback.

Additional span attributes:

Field	Type	Level	Description
`applicationName`	`string`	`INFO`	Name of the app.

interopio.api.appManager.callbacks.onAppChanged

Traces the execution of the onAppChanged() callback.

Additional span attributes:

Field	Type	Level	Description
`applicationName`	`string`	`INFO`	Name of the app.

interopio.api.appManager.callbacks.onAppRemoved

Traces the execution of the onAppRemoved() callback.

Additional span attributes:

Field	Type	Level	Description
`applicationName`	`string`	`INFO`	Name of the app.

interopio.api.appManager.callbacks.onAppUnavailable

Traces the execution of the onAppUnavailable() callback.

Additional span attributes:

Field	Type	Level	Description
`applicationName`	`string`	`INFO`	Name of the app.

interopio.api.appManager.callbacks.onInstanceAgmServerReady

Traces the execution of the onInstanceAgmServerReady() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	The starting context of the instance.
`title`	`string`	`INFO`	Window title of the instance.
`url`	`string`	`INFO`	Window URL of the instance.
`windowId`	`string`	`INFO`	Window ID of the instance.

interopio.api.appManager.callbacks.onInstanceStarted

Traces the execution of the onInstanceStarted() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	The starting context of the instance.
`title`	`string`	`INFO`	Window title of the instance.
`url`	`string`	`INFO`	Window URL of the instance.
`windowId`	`string`	`INFO`	Window ID of the instance.

interopio.api.appManager.callbacks.onInstanceStartFailed

Traces the execution of the onInstanceStartFailed() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	The starting context of the instance.
`title`	`string`	`INFO`	Window title of the instance.
`url`	`string`	`INFO`	Window URL of the instance.
`windowId`	`string`	`INFO`	Window ID of the instance.

interopio.api.appManager.callbacks.onInstanceStopped

Traces the execution of the onInstanceStopped() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	The starting context of the instance.
`title`	`string`	`INFO`	Window title of the instance.
`url`	`string`	`INFO`	Window URL of the instance.
`windowId`	`string`	`INFO`	Window ID of the instance.

interopio.api.appManager.callbacks.onInstanceUpdated

Traces the execution of the onInstanceUpdated() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`DIAGNOSTIC`	The starting context of the instance.
`title`	`string`	`INFO`	Window title of the instance.
`url`	`string`	`INFO`	Window URL of the instance.
`windowId`	`string`	`INFO`	Window ID of the instance.

interopio.api.appManager.events.onAppAdded

Traces the execution of the onAppAdded() method.

interopio.api.appManager.events.onAppAvailable

Traces the execution of the onAppAvailable() method.

interopio.api.appManager.events.onAppChanged

Traces the execution of the onAppChanged() method.

interopio.api.appManager.events.onAppRemoved

Traces the execution of the onAppRemoved() method.

interopio.api.appManager.events.onAppUnavailable

Traces the execution of the onAppUnavailable() method.

interopio.api.appManager.events.onInstanceAgmServerReady

Traces the execution of the onInstanceAgmServerReady() method.

interopio.api.appManager.events.onInstanceStarted

Traces the execution of the onInstanceStarted() method.

interopio.api.appManager.events.onInstanceStartFailed

Traces the execution of the onInstanceStartFailed() method.

interopio.api.appManager.events.onInstanceStopped

Traces the execution of the onInstanceStopped() method.

interopio.api.appManager.events.onInstanceUpdated

Traces the execution of the onInstanceUpdated() method.

interopio.api.appManager.exit

Traces the execution of the exit() method.

Additional span attributes:

Field	Type	Level	Description
`options`	`object`	`INFO`	`IOConnectDesktop.AppManager.ExitOpts`. Can be used in the span filtering context.

interopio.api.appManager.handleAppAdded

Traces when an app is added.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`AppProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleAppReady

Traces when an app is ready.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`AppProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleAppRemoved

Traces when an app is removed.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`AppProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleAppUpdated

Traces when an app is updated.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`AppProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleInstanceAgmServerReady

Traces when AGM server is ready.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`InstanceProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleInstanceStarted

Traces when an instance is started.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`InstanceProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleInstanceStartFailed

Traces when an instance start has failed.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`InstanceProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleInstanceStopped

Traces when an instance is stopped.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`InstanceProps` object. Can be used in the span filtering context.

interopio.api.appManager.handleInstanceUpdated

Traces when an instance is updated.

Additional span attributes:

Field	Type	Level	Description
`props`	`object`	`INFO`	`InstanceProps` object. Can be used in the span filtering context.

interopio.api.appManager.restart

Traces the execution of the restart() method.

Additional span attributes:

Field	Type	Level	Description
`options`	`object`	`INFO`	`IOConnectDesktop.AppManager.ExitOpts`. Can be used in the span filtering context.

interopio.api.bus

Traces related to using the Pub/Sub API accessible via the io.bus object.

interopio.api.bus.publish

Traces when data is published via Pub/Sub.

Additional span attributes:

Field	Type	Level	Description
`data`	`object`	`DIAGNOSTIC`	The data being pushed.
`routingKey`	`string`	`INFO`	Routing key for the publish operation.
`target`	`string`	`INFO`	Target for the publish operation.
`topic`	`string`	`INFO`	The topic being pushed to. Can be used in the span filtering context.

interopio.api.bus.subscribe

Traces when a client subscribes to a topic.

Additional span attributes:

Field	Type	Level	Description
`routingKey`	`string`	`INFO`	Routing key for the subscription.
`subscription_id`	`string`	`INFO`	Subscription ID.
`target`	`string`	`INFO`	Target for the subscription.
`topic`	`string`	`INFO`	The topic being subscribed to. Can be used in the span filtering context.

interopio.api.bus.subscribe.callback

Traces when a subscribed topic receives data.

Additional span attributes:

Field	Type	Level	Description
`data`	`object`	`DIAGNOSTIC`	The data received.
`subscription_id`	`string`	`INFO`	Subscription ID.
`topic`	`string`	`INFO`	The topic subscribed to. Can be used in the span filtering context.

interopio.api.channels

Traces related to using the Channels API accessible via the io.channels object.

interopio.api.channels.add

Traces the execution of the add() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel.
`info`	`object`	`DIAGNOSTIC`	`IOConnectDesktop.Channels.ChannelContext`. Can be used in the span filtering context.

interopio.api.channels.callbacks.onChanged

Traces the execution of the onChanged() callback.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel.

interopio.api.channels.callbacks.onChannelsChanged

Traces the execution of the onChannelsChanged() callback.

Additional span attributes:

Field	Type	Level	Description
`channels`	`array`	`INFO`	List of channel names.

interopio.api.channels.events.onChanged

Traces the execution of the onChanged() method.

interopio.api.channels.events.onChannelsChanged

Traces the execution of the onChannelsChanged() method.

interopio.api.channels.join

Traces the execution of the join() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.
`windowId`	`string`	`DIAGNOSTIC`	The ID of the window to join the channel.

interopio.api.channels.joinNoSelectorSwitch

Traces the execution of the joinNoSelectorSwitch() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.

interopio.api.channels.leave

Traces the execution of the leave() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.
`windowId`	`string`	`DIAGNOSTIC`	The ID of the window to leave the channel.

interopio.api.channels.leaveNoSelectorSwitch

Traces the execution of the leaveNoSelectorSwitch() method.

interopio.api.channels.publish

Traces the execution of the publish() method.

Additional span attributes:

Field	Type	Level	Description
`data`	`object`	`DIAGNOSTIC`	Data that will update the channel context.
`options`	`string` \| `object`	`DIAGNOSTIC`	Accepts a `string` or a `PublishOptions` as a value. Name of the Channel to update, or object. Can be used in the span filtering context.

interopio.api.channels.remove

Traces the execution of the remove() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.

interopio.api.channels.restrict

Traces the execution of the restrict() method.

Additional span attributes:

Field	Type	Level	Description
`restriction`	`object`	`INFO`	`IOConnectDesktop.Channels.ChannelRestrictions`. Can be used in the span filtering context.

interopio.api.channels.restrictAll

Traces the execution of the restrictAll() method.

Additional span attributes:

Field	Type	Level	Description
`restriction`	`object`	`INFO`	`IOConnectDesktop.Channels.ChannelRestrictions`. Can be used in the span filtering context.

interopio.api.channels.setPath

Traces the execution of the setPath() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.
`paths`	`object`	`DIAGNOSTIC`	`IOConnectDesktop.Contexts.PathValue`.

interopio.api.channels.setPaths

Traces the execution of the setPaths() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.
`paths`	`IOConnectDesktop.Contexts.PathValue[]`	`DIAGNOSTIC`	Array of path value objects.

interopio.api.channels.subscribe

Traces the execution of the subscribe() method.

interopio.api.channels.subscribe.callback

Traces the execution of the subscribe() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`INFO`	`IOConnectDesktop.Channels.ChannelContext`.
`data`	`object`	`DIAGNOSTIC`	Data that will update the channel context.
`options`	`object`	`INFO`	`IOConnectDesktop.Channels.FDC3Options`.
`updaterId`	`string`	`DIAGNOSTIC`	ID of the updater.

interopio.api.channels.subscribeFor

Traces the execution of the subscribeFor() method.

Additional span attributes:

Field	Type	Level	Description
`channelName`	`string`	`INFO`	Name of the channel. Can be used in the span filtering context.

interopio.api.channels.subscribeFor.callback

Traces the execution of the subscribeFor() callback.

Additional span attributes:

Field	Type	Level	Description
`context`	`object`	`INFO`	`IOConnectDesktop.Channels.ChannelContext`.
`data`	`object`	`DIAGNOSTIC`	Data that will update the channel context.
`options`	`object`	`INFO`	`IOConnectDesktop.Channels.FDC3Options`.
`updaterId`	`string`	`DIAGNOSTIC`	ID of the updater.

interopio.api.contexts

Traces related to using the Shared Contexts API accessible via the io.contexts object.

interopio.api.contexts.bridge.create

Traces when a shared context is created using the create() method.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context. Can be used in the span filtering context.
`data`	`object`	`DIAGNOSTIC`	Initial data for the shared context.

interopio.api.contexts.bridge.destroy

Traces when a shared context is destroyed.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context being destroyed. Can be used in the span filtering context.

interopio.api.contexts.bridge.get

Traces when a shared context is retrieved using the get() method.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context. Can be used in the span filtering context.

interopio.api.contexts.bridge.set

Traces when a shared context is updated using the set() method.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context. Can be used in the span filtering context.
`data`	`object`	`DIAGNOSTIC`	Data the shared context is set to.

interopio.api.contexts.bridge.setPaths

Traces when a shared context is updated using the setPath() or setPaths() methods.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context being updated. Can be used in the span filtering context.
`data`	`object`	`DIAGNOSTIC`	Resulting data in the shared context.
`pathValues`	`object`	`DEBUG`	Path values object used to update.

interopio.api.contexts.bridge.subscribe

Traces when a shared context is being subscribed to using the subscribe() method.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context subscribed to. Can be used in the span filtering context.
`contextExists`	`boolean`	`INFO`	Whether the shared context exists at the time of subscription.

interopio.api.contexts.bridge.subscribe.callback

Traces when a subscribed callback is invoked.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context being updated. Can be used in the span filtering context.
`data`	`object`	`DIAGNOSTIC`	The resulting data of the shared context after the update.
`delta`	`object`	`DEBUG`	The delta object used to update the shared context.
`removed`	`string[]`	`DEBUG`	Array of removed keys from the shared context.

interopio.api.contexts.bridge.update

Traces when a shared context is updated using the update() method.

Additional span attributes:

Field	Type	Level	Description
`context`	`string`	`INFO`	Name of the shared context. Can be used in the span filtering context.
`data`	`object`	`DIAGNOSTIC`	Resulting data in the shared context.
`delta`	`object`	`DEBUG`	Delta object applied to the shared context.