# This Source Code Form is subject to the terms of the Mozilla Public

# License, v. 2.0. If a copy of the MPL was not distributed with this

# file, You can obtain one at http://mozilla.org/MPL/2.0/.

partner_link:

  click:

    objects: ["newtab", "urlbar"]

    release_channel_collection: opt-out

    products:

      - "firefox"

    record_in_processes: ["main"]

    description: >

      This is recorded when clicking a partner link. The value is the partner.

    bug_numbers: [1637217, 1644442, 1643426]

    notification_emails:

      - "[email protected]"

    expiry_version: never

  attribution:

    objects: ["success", "failure", "abort"]

    release_channel_collection: opt-out

    products:

      - "firefox"

    record_in_processes: ["main"]

    description: >

      This is recorded when sending an attribution request for a partner link. The value is the partner.

    bug_numbers: [1637217, 1644442, 1643426]

    notification_emails:

      - "[email protected]"

    expiry_version: never

activity_stream:

  event:

    objects: [

      "ARCHIVE_FROM_POCKET",

      "BLOCK",

      "BOOKMARK_ADD",

      "BOOKMARK_DELETE",

      "CLICK",

      "CLICK_PRIVACY_INFO",

      "CLOSE_NEWTAB_PREFS",

      "SHOW_PERSONALIZE",

      "HIDE_PERSONALIZE",

      "DELETE",

      "DELETE_FROM_POCKET",

      "DELETE_CONFIRM",

      "DIALOG_CANCEL",

      "DIALOG_OPEN",

      "DRAG",

      "DROP",

      "IMPRESSION",

      "MIGRATION_CANCEL",

      "MIGRATION_START",

      "OPEN_NEWTAB_PREFS",

      "OPEN_NEW_WINDOW",

      "OPEN_PRIVATE_WINDOW",

      "PIN",

      "PREF_CHANGED",

      "PREVIEW_REQUEST",

      "SAVE_TO_POCKET",

      "SEARCH",

      "SEARCH_EDIT_ADD",

      "SEARCH_EDIT_CLOSE",

      "SEARCH_EDIT_DELETE",

      "SEARCH_HANDOFF",

      "SHOW_PRIVACY_INFO",

      "SKIPPED_SIGNIN",

      "SUBMIT_EMAIL",

      "DISCLAIMER_ACKED",

      "MENU_ADD_SEARCH",

      "MENU_ADD_TOPSITE",

      "MENU_COLLAPSE",

      "MENU_EXPAND",

      "MENU_MANAGE",

      "MENU_MOVE_DOWN",

      "MENU_MOVE_UP",

      "MENU_PRIVACY_NOTICE",

      "MENU_REMOVE",

      "TOP_SITES_EDIT",

      "TOP_SITES_EDIT_CLOSE",

      "TOPSITE_SPONSOR_INFO",

      "UNPIN"]

    release_channel_collection: opt-out

    products:

      - "firefox"

      - "fennec"

    record_in_processes: ["main"]

    description: >

      This is recorded with every user interaction on Activity Stream elements.

    bug_numbers: [1429497, 1429489, 1514732]

    notification_emails:

      - "[email protected]"

      - "[email protected]"

      - "[email protected]"

    expiry_version: never

    extra_keys:

      addon_version: The Activity Stream addon version.

      session_id: The ID of the Activity Stream session in which the event occurred

      page: about:home or about_newtab - the page where the event occurred

      user_prefs: An integer representaing a user's A-S settings.

      action_position: The index of card receiving interactions.

  end:

    objects: ["session"]

    release_channel_collection: opt-out

    products:

      - "firefox"

      - "fennec"

    record_in_processes: ["main"]

    description: >

      This is recorded with every session ended in Activity Stream.

    bug_numbers: [1429497, 1429489]

    notification_emails:

      - "[email protected]"

      - "[email protected]"

    expiry_version: never

    extra_keys:

      addon_version: The Activity Stream addon version.

      session_id: The ID of the Activity Stream session in which the event occurred

      page: about:home or about_newtab - the page where the event occurred

      user_prefs: An integer representaing a user's A-S settings.

aboutprivatebrowsing:

  click:

    objects: ["info_link", "promo_link", "dismiss_button"]

    release_channel_collection: opt-out

    record_in_processes: ["content"]

    description: >

      This is recorded when a user clicks a link on the private browsing newtab.

    bug_numbers: [1709344, 1754635, 1781973, 1811146, 1841925]

    notification_emails:

      - "[email protected]"

      - "[email protected]"

      - "[email protected]"

    expiry_version: "124"

    products:

      - "firefox"

readermode:

  view:

    objects: ["on", "off"]

    release_channel_collection: opt-out

    record_in_processes: ["content"]

    description: >

      This is recorded any time Reader Mode is turned on or off.

    bug_numbers: [1689201]

    notification_emails:

      - "[email protected]"

      - "[email protected]"

    expiry_version: never

    extra_keys:

      subcategory: The broad event category for this probe. E.g. navigation

      reader_time: Time spent in Reader Mode session in seconds (whole number)

      scroll_position: Percentage of window scrolled in Reader Mode (whole number)

    products:

      - "firefox"

  button:

    objects: ["click"]

    release_channel_collection: opt-out

    record_in_processes: ["content"]

    description: >

      This is recorded any time a Reader Mode button is clicked.

    bug_numbers: [1693362]

    notification_emails:

      - "[email protected]"

      - "[email protected]"

    expiry_version: never

    extra_keys:

      label: The type of button clicked.

    products:

      - "firefox"

addonsManager:

  install:

    description: >

      These events are recorded during the install and update flow for extensions and themes,

      the value of the event is an install_id shared by the events related to the same install

      or update flow.

    objects:

      - "extension"

      - "theme"

      - "locale"

      - "dictionary"

      - "sitepermission"

      - "siteperm_deprecated"

      - "other"

      - "unknown"

    methods: ["install", "update"]

    extra_keys:

      addon_id: A string which identify the extension (when available)

      download_time: The number of ms needed to complete the download

      error: The AddonManager error related to an install or update failure.

      source: >

        The source that originally triggered the add-on 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".

        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")

      method: >

        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", "synthetic-install", "url", "product-updates".

      num_strings: The number of permission description strings in the extension permission doorhanger

      updated_from: Determine if an update has been requested by the user or the application ("app" / "user")

      install_origins: This flag indicates whether install_origins is defined in the addon manifest. ("1" / "0")

      step: >

        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

    notification_emails: ["[email protected]"]

    expiry_version: "122"

    products:

      - "firefox"

      - "fennec"

      - "thunderbird"

    record_in_processes: ["main"]

    bug_numbers: [1433335, 1515697, 1523641, 1549770, 1590736, 1630596, 1672570, 1714251, 1749878, 1781974, 1817100]

    release_channel_collection: opt-out

  install_stats:

    description: >

      These events are recorded at the end of the install flow, but only when

      the source that originally triggered the add-on installation is "amo",

      "rtamo" or "disco". The value of an event is the SHA256 hash of the

      addon_id.

    objects:

      - "extension"

      - "theme"

      - "locale"

      - "dictionary"

      - "sitepermission"

      - "siteperm_deprecated"

      - "other"

      - "unknown"

    extra_keys:

      addon_id: >

        A string which identifies the add-on. This value might be trimmed.

      taar_based: >

        This extra key is only set for install flows related to the discovery

        addon. When available it is going to be a string set to "1" for

        TAAR based recommendations, "0" for manually curated and unset if

        not relevant for the particular install flow.

      utm_campaign: >

        The specific product promotion or strategic campaign that drives

        traffic to the install page.

      utm_content: >

        The specific item that a person clicks on to access the install page

        (such as an A/B test, a website banner, or a specific ad).

      utm_medium: The channel used to share the install page.

      utm_source: >

        The name of the product, domain of the website that drives traffic to

        the install page.

    notification_emails: ["[email protected]"]

    expiry_version: never

    products:

      - "firefox"

    record_in_processes: ["main"]

    bug_numbers: [1653020, 1699225]

    release_channel_collection: opt-out

  manage:

    description: >

      This events are recorded when an installed add-ons is being disable/enabled/uninstalled,

      the value of the event is the addon_id (which also allow to correlate multiple events

      related to each other).

    objects:

      - "extension"

      - "theme"

      - "locale"

      - "dictionary"

      - "sitepermission"

      - "siteperm_deprecated"

      - "other"

      - "unknown"

    methods: ["disable", "enable", "sideload_prompt", "uninstall"]

    extra_keys:

      source: >

        The source from which the addon has been installed (See extra_keys.source description from

        addonsManager.install telemetry event definition).

      method: >

        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).

      num_strings: The number of permission description strings in the extension permission doorhanger

    notification_emails: ["[email protected]"]

    expiry_version: "122"

    products:

      - "firefox"

      - "fennec"

      - "thunderbird"

    record_in_processes: ["main"]

    bug_numbers: [1433335, 1515697, 1523641, 1549770, 1590736, 1630596, 1672570, 1714251, 1749878, 1781974, 1817100]

    release_channel_collection: opt-out

  report:

    description: >

      An abuse report submitted by a user for a given extension. The object of the event

      represent the report entry point, the value is the id of the addon being reported.

    objects:

      - amo

      - menu

      - toolbar_context_menu

      - unified_context_menu

      - uninstall

    extra_keys:

      addon_type: >

        The type of the add-on being reported (missing on ERROR_ADDON_NOT_FOUND, ERROR_AMODETAILS_NOTFOUND

        and ERROR_AMODETAILS_FAILURE).

      error_type: >

        AbuseReport Error Type (included in case of submission failures). The error types include

        ERROR_ABORTED_SUBMIT, ERROR_ADDON_NOT_FOUND, ERROR_CLIENT, ERROR_NETWORK, ERROR_UNKNOWN,

        ERROR_RECENT_SUBMIT, ERROR_SERVER, ERROR_AMODETAILS_NOTFOUND, ERROR_AMODETAILS_FAILURE.

    notification_emails: ["[email protected]"]

    expiry_version: "122"

    products:

      - "firefox"

      - "fennec"

      - "thunderbird"

    record_in_processes: ["main"]

    bug_numbers: [1544927, 1580561, 1590736, 1630596, 1672570, 1714251, 1749878, 1780746, 1781974, 1817100]

    release_channel_collection: opt-out

  reportSuspiciousSite:

    description: >

      Sent when a user clicks "Report Suspicious Site" on the dropdown menu of the third-

      party xpinstall doorhanger. The object is always suspiciousSite. The value is the

      site domain, or "(unknown)" if there is no site associated with the prompt.

    objects:

      - suspiciousSite

    notification_emails: ["[email protected]"]

    expiry_version: "122"

    products:

      - "firefox"

    record_in_processes: ["main"]

    bug_numbers: [1806056, 1817100]

    release_channel_collection: opt-out

blocklist:

  addonBlockChange:

    description: >

      An add-on is blocked, or an installed add-on is unblocked.

      When an add-on install/update is blocked, its installation is aborted and the

      add-on is no longer listed in the activeAddons field of TelemetryEnvironment.

      The value is the ID of the add-on.

      The object represents the reason for triggering the blocklistState check:

      "addon_install" is when an add-on is installed.

      "addon_update" is when an add-on is updated after an update check.

      "addon_update_check" is when an add-on is blocked during the update check.

      "addon_db_modified" is when an add-on's blocklistState was altered between application restarts.

      "blocklist_update" is when an add-on's blocklistState changed due to a blocklist update. This

      may be due to the blocklist being disabled by preferences or enterprise policies, but it is

      more commonly the result of updating entries in the blocklist.

    objects: ["addon_install", "addon_update", "addon_update_check", "addon_db_modified", "blocklist_update"]

    extra_keys:

      blocklistState: >

        The blocklistState of the add-on. 0 is unblocked, 2 is blocked.

        1 is soft blocked (only if blocklist v3 was disabled in favor of v2).

      addon_version: >

        Version of the add-on. Used together with an add-on's ID (value) to identify

        add-ons to block.

      signed_date: >

        Timestamp of the add-on (when it was signed via AMO).

        This field is missing (0) for "addon_update_check".

      hours_since: >

        The number of hours that have passed since this version of the add-on was installed or updated.

        At least zero when the blocklist is updated, -1 otherwise.

      mlbf_last_time: >

        The generation time of the most recent entry in the blocklist.

        Time generated by AMO when the blocklist entry was created.

        May be 0 when the blocklist is disabled.

      mlbf_generation: >

        The generation time to identify the bloomfilter that was used for this blocklist decision.

        The bloomfilter is updated less frequently than the so-called stashes in the RemoteSettings

        collection that holds the blocklist data. The stashes take precedence over the bloomfilter

        in blocklist decisions.

        Time generated by AMO when the blocklist entry was created.

        May be 0 when the blocklist is disabled.

      mlbf_source: >

        The source of the RemoteSettings attachment that holds the bloom filter.

        This field is documented in more detail in the definition of the blocklist.mlbf_source scalar.

        Possible values are "dump_match", "cache_match", "remote_match", "dump_fallback", "cache_fallback", "unknown".

    notification_emails: ["[email protected]", "[email protected]"]

    expiry_version: "122"

    products:

      - "firefox"

    record_in_processes: ["main"]

    bug_numbers: [1662857, 1730037, 1763529, 1811159]

    release_channel_collection: opt-out

downloads:

  added:

    description: >

      Sent when downloading a new file. Possible values are in contained in DownloadList::kFileExtensions.

      All other downloads not in the listare marked as other.

    objects: ["fileExtension"]

    bug_numbers: [1627676, 1706355]

    notification_emails: ["[email protected]", "[email protected]"]