Data collection for the CloudBees Analytics Plugin

The CloudBees Analytics Plugin collects telemetry and metrics for analysis to help CloudBees make decisions about future product enhancements. The collected data is used to evaluate patterns of usage of our products.

Data collection is enabled by default, but you can disable it at any time.

Data collected with every event

The following data is sent with every event that is captured:

Description Anonymized

Instance ID

Yes

Product name

No

Product version

No

Organization licensed to use the product

This does not apply to CloudBees Jenkins Distribution.

No

Instance check-in data

This event is sent at each initialization and every 24 hours after.

Description Anonymized

The first installation date.

No

The length of time the instance has been running since the last reboot.

No

The number of licensed users.

No

The operating system where the instance is running.

No

The cloud provider where the instance is running.

No

The cloud orchestrator used in the cluster.

No

The distributable used in the cluster.

No

User signup data

This event is sent when the product is being licensed.

Description Anonymized

The browser used to request the license.

No

The version of the browser used to request the license.

No

The operating system where the instance is running.

No

The cloud provider where the instance is running.

No

The cloud orchestrator used in the cluster.

No

The distributable used in the cluster.

No

Setup wizard data

A new event is sent when the user starts a new step of the Setup Wizard to identify the selections made during the installation.

  • Admin password step displayed

  • Login failed

  • Choose license type step displayed

  • Online evaluation license step displayed

  • Offline license step displayed

  • Manual license step displayed

  • License submit failed

  • Plugins installation options step displayed

  • Plugins selection step displayed

  • Custom plugins installation selected

  • Recommended plugins installation selected

  • Install plugins requested

  • Upgrade skipped

  • Admin user creation step displayed

  • Admin user created

  • Admin user creation failed

  • Confirm URL step displayed

  • Instance ready step displayed

  • Setup completed

Jenkins build completed data

This event is sent every time a build completes in Jenkins.

Description Anonymized

The build duration in milliseconds.

No

The build number.

No

The result of the build.

No

The fully-qualified class name of the run that triggered the event (to identify the job type).

No

The fully-qualified class name of the multibranch project factory (to track usage of marker files vs normal multibranch projects)

No

For pipelines that are part of multibranch projects, the fully-qualified class name of the SCM used to check out the multibranch project from source control

No

A hashed name of the job from which the build was created.

Yes

(Optional) The durability level that was used for the build in Pipeline jobs.

No

(Optional) The fully-qualified class name of the FlowDefinition for the Pipeline (to identify the Pipeline type).

No

Whether the sandbox was enabled for the build in Pipeline jobs.

No

(Optional) A hashed multibranch Pipeline job name.

Yes

(Optional) A hashed organization folder name (only set on builds of jobs that are part of a multibranch project that is part of an organization folder).

Yes

(Optional) Either Scripted or Declarative, depending on the Pipeline.

No

(Optional) If a freestyle build, the count of upstream projects that feed into the build.

No

(Optional) If a freestyle build, the count of downstream projects that should be built when the build completes.

No

Jenkins Pipeline step completed

This data is sent along with the Jenkins Build Completed event for Pipeline builds for every Pipeline step executed as part of the build.

Description Anonymized

The number of the build that ran in the Pipeline step.

No

A hashed version of the name of the job that owns the build that ran the step.

Yes

A list of the names, but not the values, of the arguments passed to the step by the user.

No

The name of the step as written by a user in a Pipeline script.

No

The amount of time that the step spent paused while executing.

No

The artifact ID of the plugin in which the step is defined (to identify which steps are being used).

No

Jenkins Declarative Pipeline syntax used

This data is sent along with the Jenkins Build Completed event for every type of syntax used in Declarative Pipelines.

Description Anonymized

The number of the build that ran the step.

No

A hashed name of the job from which the build that ran the step was created.

Yes

The name of the Declarative syntax used. For example, agent,tools,stages,matrix, etc. Refer to the Pipeline syntax reference guide for the complete list of syntax.

No

The type of syntax that was used. The following syntax types are supported by Declarative:

  • AGENT-TYPE

  • DIRECTIVE

  • POST_CONDITION

  • SECTION

  • WHEN_CONDITION

Refer to the Pipeline syntax reference guide for detailed explanations of each type.

No

Jenkins freestyle task completed

This data is sent along with the Jenkins Build Completed event for every task executed as part of a freestyle build.

Description Anonymized

The number of the build that ran the step in.

No

A hashed name of the job from which the build was created.

Yes

The fully-qualified class name of the freestyle task. For example, hudson.tasks.Shell.

No

The type of freestyle task: * build wrapper: pre/post actions performed for the build process * builder:BuildSteps that perform the actual build * publisher:BuildSteps that run after a build has been completed

No

Jenkins SCM checked out

This data is sent along with the Jenkins Build Completed event for every SCM that is checked out as part of the build.

Description Anonymized

The number of the build in which the step ran.

No

A hashed name of the job from which the build was created.

Yes

The fully-qualified class name of the object used to check out from source control (to identify which SCM is used).

No

The context in which the checkout was performed. For example, checkout performed in a build that is not in a Pipeline, checkout step within a Pipeline build, etc.).

No

CloudBees High Availability (HA) usage

This event is sent at each initialization and every 7 days after.

This only applies to CloudBees Core on traditional platforms.
Description Anonymized

True if the instance has configured CloudBees HA, otherwise False is sent.

No

Plugin version data

This event is sent for each installed plugin at each initialization and every 7 days after.

Description Anonymized

The artifact ID of the plugin.

No

The version of the plugin.

No

CasC for Masters usage

This event is sent at each initialization and every 7 days after.

Description Anonymized

Has the current master been provisioned using CasC for Masters? (yes/no value)

No

Disabling data collection for the CloudBees Analytics Plugin

You can disable data collection from within Jenkins.

To disable data collection:

  1. From Jenkins, go to Manage Jenkins > Configure System.

  2. Under Usage Statistics, deselect Help make CloudBees <product name> better by sending telemetry and metrics to evaluate patterns of usage.

    The <product name> will depend on what product you are using. CloudBees by default will display.

Alternatively, disable the data collection by adding the -Dcom.cloudbees.analytics.gatherer.Sender.disabled=true system property to your launch scripts.