Merge pull request #367 from mozilla/jmendez/addon-install-telemetry

Add enterprise-specific addon install event with addon name

Author: jonathanmendez

toolkit/mozapps/extensions/AddonManager.sys.mjs

@@ -5594,6 +5594,32 @@ AMTelemetry = {
     return null;
   },
 
+  /**
+   * Retrieve the addon name for the given AddonInstall instance.
+   *
+   * @param {AddonInstall} install
+   *        The AddonInstall instance to retrieve the addon name from.
+   *
+   * @returns {string | null}
+   *          The addon name for the given AddonInstall instance (if any).
+   */
+  getAddonNameFromInstall(install) {
+    // Returns the name of the extension that is being installed, as soon as the
+    // addon is available in the AddonInstall instance (after being downloaded
+    // and validated successfully).
+    if (install.addon) {
+      return install.addon.name;
+    }
+
+    // While updating an addon, the existing addon can be
+    // used to retrieve the addon id since the first update event.
+    if (install.existingAddon) {
+      return install.existingAddon.name;
+    }
+
+    return null;
+  },
+
   /**
    * Retrieve the telemetry event's object property value for the given
    * AddonInstall instance.
@@ -5847,6 +5873,7 @@ AMTelemetry = {
     }
 
     let addonId = this.getAddonIdFromInstall(install);
+    let addonName = this.getAddonNameFromInstall(install);
     let object = this.getEventObjectFromInstall(install);
 
     let installId = String(install.installId);
@@ -5899,7 +5926,25 @@ AMTelemetry = {
       })
     );
 #ifdef MOZ_ENTERPRISE
-    GleanPings.enterprise.submit();
+    if (eventMethod == "install" && extra.step == "completed") {
+      Glean.addonsManager.installComplete.record(
+        this.formatExtraVars({
+          addon_id: extra.addon_id,
+          addon_name: addonName,
+          addon_type: object,
+          install_id: installId,
+          download_time: extra.download_time,
+          error: extra.error,
+          source: extra.source,
+          source_method: extra.method,
+          num_strings: extra.num_strings,
+          updated_from: extra.updated_from,
+          install_origins: extra.install_origins,
+          step: extra.step,
+        })
+      );
+      GleanPings.enterprise.submit();
+    }
 #endif
   },
 

toolkit/mozapps/extensions/metrics.yaml

@@ -315,10 +315,100 @@ addons_manager:
           download_started, download_completed, download_failed
         type: string
     expires: 154
+
 #ifdef MOZ_ENTERPRISE
+  install_complete:
+    type: event
+    description: |
+      This event is recorded when an extension or theme is installed
+      in enterprise builds.
+      Contains security-relevant metadata for monitoring and analysis.
+      Only collected when MOZ_ENTERPRISE is defined and enabled.
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=TBD
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=TBD
+    data_sensitivity:
+      - interaction
+    notification_emails:
+      - security-telemetry@mozilla.org
+      - enterprise-telemetry@mozilla.org
+    extra_keys:
+      addon_id:
+        description: Id of the addon (when available).
+        type: string
+      addon_name:
+        description: Name of the addon (when available).
+        type: string
+      addon_type:
+        description: |
+          Addon type, one of: extension, theme, locale, dictionary,
+          sitepermission, siteperm_deprecated, other, unknown.
+        type: string
+      install_id:
+        description: |
+          Shared by events related to the same install or update flow.
+        type: string
+      download_time:
+        description: The number of ms needed to complete the download.
+        type: quantity
+      error:
+        description: |
+          The AddonManager error related to an install or update failure.
+        type: string
+      source:
+        description: |
+          The source that originally triggered the installation, one
+          of: "about:addons", "about:debugging", "about:preferences",
+          "amo", "browser-import", "disco", "distribution",
+          "extension", "enterprise-policy", "file-url",
+          "geckoview-app", "gmp-plugin", "internal", "plugin",
+          "rtamo", "siteperm-addon-provider" "sync", "system-addon",
+          "temporary-addon", "unknown", "about:editprofile", "about:newprofile",
+          "nimbus-newtabTrainhopAddon".
+          For events with method set to "sideload", the source value
+          is derived from the XPIProvider location name (e.g. possible
+          values are "app-builtin", "app-global", "app-profile",
+          "app-system-addons", "app-system-defaults",
+          "app-system-local", "app-system-profile",
+          "app-system-share", "app-system-user", "winreg-app-user",
+          "winreg-app-gobal").
+        type: string
+      source_method:
+        description: |
+          The method used by the source to install the add-on
+          (included when the source can use more than one, e.g.
+          install events with source "about:addons" may have
+          "install-from-file" or "url" as method), one of: "amWebAPI",
+          "drag-and-drop", "installTrigger", "install-from-file",
+          "link", "management-webext-api", "sideload", "onboarding",
+          "synthetic-install", "url", "product-updates".
+        type: string
+      num_strings:
+        description: |
+          The number of permission description strings in the
+          extension permission doorhanger.
+        type: quantity
+      updated_from:
+        description: |
+          Determine if an update has been requested by the user or
+          the application ("app" / "user").
+        type: string
+      install_origins:
+        description: |
+          This flag indicates whether install_origins is defined in
+          the addon manifest. ("1" / "0")
+        type: string
+      step:
+        description: |
+          The current step in the install or update flow: started,
+          postponed, cancelled, failed, permissions_prompt, completed,
+          site_warning, site_blocked,install_disabled_warning,
+          download_started, download_completed, download_failed
+        type: string
+    expires: never
     send_in_pings:
       - enterprise
-      - default
 #endif
 
   update: *install_update_event