Skip to content

Change "Enable Service Ping" in admin setting to "Include Optional data in Service Ping"

Problem

The admin setting is currently titled "Enable service ping" although it only controls optional data and not other data types. This can be confusing since the service ping payload also contains 3 other types of data apart from optional data (operational, standard and subscription).

Desired Outcome

  • Change "Enable Service Ping" in admin setting to "Include optional data in service ping?" with a more information symbol pointing to our legal document
  • Instructions in our docs and handbook that points to "Enable Service Ping" setting is edited to the new text. For example, here

Proposed Solution

Instead of the current Enable Service Ping checkbox in admin setting include the following checkboxes:

If the license or state of the Instance (e.g. Community Edition / 1 person instance) prevents Service Ping from being sent (operational_metrics = False) by default:

  • Enable Service Ping Checked by default. When enabled, it automatically enables the Include optional data in Service Ping button

In any case:

  • Include Optional data in Service Ping: Disabled if Enable Service Ping is present and not checked, automatically checked if Enable Service Ping is checked or the license mandates Service Ping, but admin can uncheck. If unchecked, exclude optional data from Service Ping

The buttons to be followed up by a more information icon that links to our legal documentation so users have ready access to information about what we are collecting and why

Open Questions

Do we need another official instance setting apart from ::Gitlab::CurrentSettings.usage_ping_enabled? to ensure this functionality

Edited by Sebastian Rehm