Understanding the CloudBees Analytics data model
This section describes the CloudBees Analytics data model. It is comprised of several interrelated schemas that are externalized as report object types.
Data model overview
The data in each type is sourced as described in the below table. Click on an object type for complete details about its structure.
Report type | Object name | Description |
---|---|---|
build |
For events related CloudBees CI builds starting and finishing. It is used on the Workload Insights dashboard. |
|
controller_event |
For events related to CloudBees CI controllers starting and for CloudBees Software Delivery Automation configuration on a controller being updated. It is used on the Workload Insights dashboard. |
|
ci_plugin |
For events related to plugins being installed, uninstalled, or otherwise modified on CloudBees CI controllers. It is used on the Plugin Usage dashboard. |
|
ci_plugin_usage |
For events related to plugins being used in various ways in CloudBees CI. It is used on the Plugin Usage dashboard. |
|
ci_queue_event |
For events related to activity in the build queue in CloudBees CI, such as new jobs entering the queue, queued jobs starting, or queued jobs being cancelled. It is used on the Workload Insights dashboard. |
Report object type reference
You use attributes for CloudBees Analytics report objects when creating custom reports and dashboards. The following tables list the attributes for the CloudBees Analytics report object types.
Build
* Object Type: build * Report object name: Build * Description: Build data from CloudBees CI | |||
---|---|---|---|
Attribute |
Display Name |
Type |
Description |
|
Build Number |
|
Unique build number or identifier assigned to the build by CloudBees CI. |
|
Build Status |
|
Current status of the build: |
|
Detail name |
|
The full display name from the CloudBees CI job. |
|
CI Job Name |
|
The full job name from the CloudBees CI job. |
|
Controller URL |
String |
CloudBees CI controller or CloudBees CI operations center URL |
|
Controller Name |
String |
CloudBees CI controller name |
|
Duration |
|
Duration of the build in milliseconds |
|
End Time |
|
End date and time for the build. The format is ISO 8601 in UTC time. For example, |
|
QueueTime |
|
Time the job entered the queue. The format is ISO 8601 in UTC time. For example, |
|
Build System Type |
|
Name of the continuous integration system. For example, |
|
Start Time |
|
Starting date and time for the build. The format is ISO 8601 in UTC time. For example, |
Controller Events
-
Object Type: controller_event
-
Report object name: Controller Events
-
Description: Controller event data from CloudBees CI
Attribute | Display Name | Type | Description |
---|---|---|---|
|
Controller URL |
String |
CloudBees CI controller or CloudBees CI operations center URL |
|
Controller name |
String |
CloudBees CI controller name |
|
Event |
STRING |
enumerationValues = |
|
DATETIME |
||
|
DATETIME |
||
|
DATETIME |
CI Plugin
-
Object Type: ci_plugin
-
Report object name: CI Plugin
-
Description: Plugin information from CloudBees CI
Attribute | Display Name | Type | Description |
---|---|---|---|
|
Controller URL |
String |
CloudBees CI controller or CloudBees CI operations center URL |
|
Controller name |
String |
CloudBees CI controller name |
|
STRING |
||
|
STRING |
||
|
Plugin ID |
String |
The CloudBees CI plugin ID |
|
Plugin name |
STRING |
Name of the CloudBees CI plugin |
|
Plugin version |
String |
Version of the CloudBees CI plugin |
|
Timestamp |
Date |
Date and time of plugin event |
|
Is supported by CloudBees |
Boolean |
Whether CloudBees CI plugin is supported in CloudBees Assurance Program. |
|
Is proprietary |
Boolean |
Whether CloudBees CI plugin is a CloudBees proprietary plugin |
|
Event type |
enumerationValues: |
Lifecycle type of the plugin |
CI Plugin usage
-
Object Type: CI Plugin Usage
-
Report object name: ci_plugin_usage
-
Description: Plugin usage data from CloudBees CI
Attribute | Display Name | Type | Description |
---|---|---|---|
|
Controller URL |
STRING |
CloudBees CI controller or CloudBees CI operations center URL |
|
Controller name |
STRING |
CloudBees CI controller name |
|
STRING |
Description of the report |
|
|
Plugin ID |
STRING |
The CloudBees CI plugin ID |
|
Plugin name |
STRING |
The name of the CloudBees CI plugin |
|
Plugin version |
STRING |
Version of the CI plugin |
|
Timestamp |
DATETIME |
Plugin event date and time. |
|
Is supported by CloudBees |
Boolean |
Whether CloudBees CI plugin is supported in CloudBees Assurance Program |
|
Is proprietary |
Boolean |
Whether CloudBees CI plugin is proprietary |
|
Job full name |
STRING |
Full name of the CloudBees CI job |
|
Build URL |
STRING |
Relative build URL to the Jenkins root URL |
|
Job URL |
STRING |
Relative job URL to the Jenkins root URL |
|
Item full name |
STRING |
Full name of the configuration item |
|
Dependent plugin ID |
STRING |
CloudBees CI dependent plugin ID |
|
Dependent plugin name |
STRING |
Name of the dependent plugin |
|
Dependent version |
STRING |
Version of the CloudBees CI dependent plugin |
|
Usage type |
enumerationValues: |
Usage type of the plugin |
CI Queue Event
-
Object Type: ci_queue_event
-
Report object name: CI Queue Event
-
Description: CloudBees CI queue event data
Attribute | Display Name | Type | Description |
---|---|---|---|
|
Controller URL |
String |
CloudBees CI controller or CloudBees CI operations center URL |
|
Controller name |
String |
CI controller name |
|
Event type |
STRING |
enumerationValues = |
|
Queue Item ID |
STRING |
|
|
Queue Size |
NUMBER |
The size of the queue. |
|
DATETIME |
Date and time of the event. |
|
|
Queued at |
DATETIME |
The time that the job or task was added to the queue. |
|
Start time |
DATETIME |
The time that a queued job or task left the queue and started executing. |
|
Cancelled time |
DATETIME |
The time that a queued job or task was cancelled. |