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

buildNumber

Build Number

STRING

Unique build number or identifier assigned to the build by CloudBees CI.

buildStatus

Build Status

STRING

Current status of the build: SUCCESS, FAILURE, UNSTABLE, NOT_BUILT, ABORTED, or WARNING.

ciBuildDetailName

Detail name

STRING

The full display name from the CloudBees CI job.

ciJobName

CI Job Name

STIRNG

The full job name from the CloudBees CI job.

controllerUrl

Controller URL

String

CloudBees CI controller or CloudBees CI operations center URL

controllerName

Controller Name

String

CloudBees CI controller name

duration

Duration

NUMBER

Duration of the build in milliseconds

endTime

End Time

DATETIME

End date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

queueTime

QueueTime

DATETIME

Time the job entered the queue. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

source

Build System Type

STRING

Name of the continuous integration system. For example, CloudBees CI.

startTime

Start Time

DATETIME

Starting date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

Controller Events

  • Object Type: controller_event

  • Report object name: Controller Events

  • Description: Controller event data from CloudBees CI

Attribute Display Name Type Description

controllerUrl

Controller URL

String

CloudBees CI controller or CloudBees CI operations center URL

controllerName

Controller name

String

CloudBees CI controller name

eventType

Event

STRING

enumerationValues = controllerStarted

readyAt

DATETIME

startedAt

DATETIME

timestamp

DATETIME

CI Plugin

  • Object Type: ci_plugin

  • Report object name: CI Plugin

  • Description: Plugin information from CloudBees CI

Attribute Display Name Type Description

controllerUrl

Controller URL

String

CloudBees CI controller or CloudBees CI operations center URL

controllerName

Controller name

String

CloudBees CI controller name

id

STRING

discription

STRING

pluginName

Plugin ID

String

The CloudBees CI plugin ID

pluginDisplayname

Plugin name

STRING

Name of the CloudBees CI plugin

pluginVersion

Plugin version

String

Version of the CloudBees CI plugin

ts

Timestamp

Date

Date and time of plugin event

isCAP

Is supported by CloudBees

Boolean

Whether CloudBees CI plugin is supported in CloudBees Assurance Program.

isProprietary

Is proprietary

Boolean

Whether CloudBees CI plugin is a CloudBees proprietary plugin

eventType

Event type

enumerationValues: install, uninstall, change

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

controllerUrl

Controller URL

STRING

CloudBees CI controller or CloudBees CI operations center URL

controllerName

Controller name

STRING

CloudBees CI controller name

description

STRING

Description of the report

pluginName

Plugin ID

STRING

The CloudBees CI plugin ID

pluginDisplayName

Plugin name

STRING

The name of the CloudBees CI plugin

pluginVersion

Plugin version

STRING

Version of the CI plugin

ts

Timestamp

DATETIME

Plugin event date and time.

isCAP

Is supported by CloudBees

Boolean

Whether CloudBees CI plugin is supported in CloudBees Assurance Program

isProprietary

Is proprietary

Boolean

Whether CloudBees CI plugin is proprietary

jobFullName

Job full name

STRING

Full name of the CloudBees CI job

buildUrl

Build URL

STRING

Relative build URL to the Jenkins root URL

jobUrl

Job URL

STRING

Relative job URL to the Jenkins root URL

itemFullName

Item full name

STRING

Full name of the configuration item

dependentPlugin

Dependent plugin ID

STRING

CloudBees CI dependent plugin ID

dependentpluginDisplayName

Dependent plugin name

STRING

Name of the dependent plugin

dependentVersion

Dependent version

STRING

Version of the CloudBees CI dependent plugin

usageType

Usage type

enumerationValues: pipeline, configuration, dependency

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

controllerUrl

Controller URL

String

CloudBees CI controller or CloudBees CI operations center URL

controllerName

Controller name

String

CI controller name

eventType

Event type

STRING

enumerationValues = jobQueued, taskQueued, jobCancelled, taskCancelled, runStarted, taskStarted

queueItemId

Queue Item ID

STRING

queueSize

Queue Size

NUMBER

The size of the queue.

timestamp

DATETIME

Date and time of the event.

queuedAt

Queued at

DATETIME

The time that the job or task was added to the queue.

startedAt

Start time

DATETIME

The time that a queued job or task left the queue and started executing.

cancelledAt

Cancelled time

DATETIME

The time that a queued job or task was cancelled.