Telemetry
Telemetry (anonymous data collection) in Cover CLI
Diffblue Cover CLI captures anonymous usage data to help improve Cover services and features. You can select one or more of the following endpoints to send this data to, each of which can also be disabled:
- Diffblue - Anonymous usage data is sent to Diffblue by default, unless disabled.
- Mixpanel - Cover telemetry uses the Mixpanel analytics service. If you have your own Mixpanel instance, you can add your Mixpanel project endpoint to your telemetry configuration.
- Reports - Provides telemetry data to your Cover Reports instance (if required), allowing you to monitor Diffblue Cover usage across your organization.
Telemetry endpoints are configured using the
telemetry.properties
file in your Cover CLI installation. Edit/add the following sections to configure your endpoint(s):Default
- This section is for the Diffblue endpoint. The only configurable field for this section isbackend
- set tomixpanel
to enable data collection, ornone
to disable.mymixpanel
- Your Mixpanel instance.reports
- Your Cover Reports instance.
#Default section
name=Diffblue Mixpanel
backend=mixpanel
api_url=https://api-eu.mixpanel.com
server_app_key=5a9XXXXXXXXXXXXXXXXXX8d7
#Named section 'mymixpanel'
name[mymixpanel]=My MixPanel
backend[mymixpanel]=mixpanel
api_url[mymixpanel]=https://mixpanel.mycompany.com
server_app_key[mymixpanel]=342XXXXXXXXXXXXXXXXXX8a6
#Named section 'reports'
name[reports]=Cover Reports
backend[reports]=cover-reports
api_url[reports]=http://cover-reports.mycompany.com:8080/telemetry/event
Field | Description |
---|---|
name | Useful name. For Diffblue, leave this set to Diffblue Mixpanel . |
backend | Data endpoint type:
|
api_url | Endpoint URL to send data to:
|
server_app_key | Your Mixpanel project token. For Diffblue, leave this set to the default value. |
In your Cover CLI installation folders, edit the
telemetry.properties
file and set backend
to none
for each endpoint you'd like to disable (see above). You can also simply delete the section if you'd prefer.Larger organizations may find it useful to create an in-house distribution of Cover CLI with telemetry set to your configuration, with endpoints enabled, disabled, and configured as needed:
- 1.Make a copy of the distribution zip file (
diffblue-cover-cli-<release-version>.zip
). - 2.Edit the
telemetry.properties
file in the zip and set your endpoints as needed (see above). - 3.Your edited zip can now be distributed as needed - install your Cover CLI distribution as detailed in Get started - Cover CLI.
Last modified 14d ago