Links

Telemetry

Telemetry (usage data collection) in Cover CLI.
Diffblue Cover captures telemetry (usage) data to help improve Cover services and features. Data is sent to the following endpoints:
  • Diffblue - Telemetry data is sent to Diffblue by default.
  • Cover Reports - Telemetry data can be sent to your Cover Reports instance (if required), allowing you to monitor Diffblue Cover usage across your organization.
Further information on our data collection and policies is provided in the Diffblue Privacy Notice.

Configure telemetry

Telemetry can be configured (if required) using environment variables, and/or a properties file, on the host machine (where Diffblue Cover is being used). Note that these configuration settings apply to Cover CLI and Cover Plugin.
  • Environment variables always take priority and is the recommended method for configuring telemetry - variables listed below.
  • If you use a properties file, create a telemetry.properties file in the home directory under the .diffblue folder (for example, /users/jbrown/.diffblue/telemetry.properties) and define one or more of the properties listed below.
  • If an individual environment variable or property is not found, the default value will be used.
Environment variable
Property
Description
Default
DIFFBLUE_TELEMETRY_ EXTERNAL_ENABLED
telemetry.
external.
enabled
Enable (true) or disable (false) telemetry data for Diffblue. *
true
DIFFBLUE_TELEMETRY_ REPORTS_ENABLED
telemetry.
reports.
enabled
Enable (true) or disable (false) telemetry data for Cover Reports. **
false
DIFFBLUE_TELEMETRY_ REPORTS_HOSTNAME
telemetry.
reports.
hostname
Hostname of your Cover Reports server. **
localhost
DIFFBLUE_TELEMETRY_ REPORTS_PORT
telemetry.
reports.
port
Port number of your Cover Reports instance **
8080
DIFFBLUE_TELEMETRY_ REPORTS_SCHEME
telemetry.
reports.
scheme
Protocol used to communicate with Cover Reports - http or https **
http
* Disabling the Diffblue endpoint for telemetry data is only available to Diffblue Cover Enterprise Edition customers.
** See your Cover Reports Administrator for help, if needed.
Example telemetry.properties file:
# Copyright 2021-2024 Diffblue Limited. All Rights Reserved.
# Example telemetry.properties file
telemetry.external.enabled=true
telemetry.reports.enabled=true
telemetry.reports.hostname=localhost
telemetry.reports.port=8080
telemetry.reports.scheme=http

Manage configurations

If you need to manage telemetry configuration across your organization, you can set the environment variables defined above (as needed) and apply these settings across your organization (for example, using a group policy).
From release 2024.01.02, it is no longer possible to repackage Cover CLI with telemetry disabled.