Insights
Overview
Insights
Overview
Gitpod Insights is a feature that allows organization owners to monitor the usage and adoption of Gitpod in their organization.
The Insights page is accessible to organization owners from the Organization Menu in the top-left corner of the Gitpod dashboard and offers the following:
- A list of all workspaces created in your organization (sorted from most to least recently created) with the following details:
- Workspace owner (user)
- Workspace ID
- Workspace Class and type (meaning workspace or prebuild)
- Context URL
- An expandable section with details about all workspace starts
- A button for exporting the insights data to a CSV file with additional details, including:
- Detailed timestamps for events such as the workspace creation, deployment, start and stop
- Workspace metrics such as the size of the workspace image
- The configured workspace timeout
- The editor and its version selected when the workspace was created
- (If applicable) the ID of the prebuild that was used to start the workspace
- (If applicable) the ID of the imported repository
A detailed list of all properties in the CSV export can be found below:
| Property | Description |
|---|---|
id | The unique identifier for the session |
creationTime | The timestamp when the workspace was created |
deployedTime | The timestamp when the workspace was deployed |
startedTime | The timestamp when the workspace entered the running state |
stoppingTime | The timestamp when the workspace transitioned into the stopping state |
stoppedTime | The timestamp when the workspace transitioned into the stopped state |
workspaceID | The unique identifier for the workspace |
configurationID | The unique identifier for the imported repository |
prebuildID | The unique identifier for the prebuild |
userID | The unique identifier for the user who created the workspace |
userName | The name of the user who created the workspace |
contextURL | The full context URL (e.g. https://github.com/gitpod-io/gitpod/pull/316) |
contextURL_cloneURL | The clone URL of the context (e.g. https://github.com/gitpod-io/gitpod.git) |
contextURLSegment_1 | The first parsed segment of the context URL (e.g. gitpod-io/subgroup for https://github.com/gitpod-io/subgroup/gitpod) |
contextURLSegment_2 | The second parsed segment of the context URL (e.g. gitpod for https://github.com/gitpod-io/subgroup/gitpod) |
workspaceType | The type of workspace (can be workspace or prebuild) |
workspaceClass | The class of the workspace |
workspaceImageSize | The size of the workspace image |
workspaceImageTotalSize | The total size of the workspace image |
timeout | The configured workspace timeout in seconds |
editor | The ID of the editor selected when the workspace was created |
editorVersion | The version of the editor selected when the workspace was created (can be stable or latest) |
contentInitGitDuration | The duration of the git initializer step in seconds. This is set whenever a git clone is issued (mostly on first workspace start). |
contentInitGitSize | The size of the git initializer step result in bytes. This is set whenever a git clone is issued (mostly on first workspace start). |
contentInitPrebuildDuration | The duration of the prebuild initializer step in seconds. This is set if the workspace is based on a prebuild. |
contentInitPrebuildSize | The size of the prebuild initializer step result in bytes. This is set if the workspace is based on a prebuild. |
contentInitBackupDuration | The duration of the backup initializer step in seconds. This is set on subsequent workspace starts, when the file system is restored from backup. |
contentInitBackupSize | The size of the backup initializer step result in bytes. This is set on subsequent workspace starts, when the file system is restored from backup. |
contentInitSnapshotDuration | The duration of the snapshot initializer step in seconds. This used for workspaces started from snapshots. |
contentInitSnapshotSize | The size of the snapshot initializer step result in bytes. This used for workspaces started from snapshots. |
contentInitFileDownloadDuration | The duration of the file download initializer step in seconds. This is set for injecting additionalFiles into the workspace. |
contentInitFileDownloadSize | The size of the file download initializer step result in bytes. This is set for injecting additionalFiles into the workspace. |
contentInitCompositeDuration | The duration of the composite initializer step in seconds. This reports the total if multiple steps are run to initialize the workspace content. |
contentInitCompositeSize | The size of the composite initializer step result in bytes. This reports the total if multiple steps are run to initialize the workspace content. |
For even more information about the underlying workspace session data, please refer to our ListWorkspaceSessions API.