tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

metrics.yaml (3476B)


      1 # This Source Code Form is subject to the terms of the Mozilla Public
      2 # License, v. 2.0. If a copy of the MPL was not distributed with this
      3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
      4 
      5 # Adding a new metric? We have docs for that!
      6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
      7 
      8 ---
      9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
     10 $tags:
     11  - 'Toolkit :: Telemetry'
     12 
     13 glean.attribution:
     14  ext:
     15    type: object
     16    lifetime: user
     17    # Permit long description lines
     18    # yamllint disable
     19    description: |
     20      Extended attribution information.
     21      Mapped to client_info.attribution.ext in datasets.
     22      * `experiment`: name/id of the enrolled funnel experiment
     23      * `variation`: name/id of the variation cohort used in the enrolled funnel experiment
     24      * `ua`: identifier derived from the user agent downloading the installer
     25              e.g. chrome, Google Chrome 123
     26      * `dltoken`: Unique token created at Firefox download time.
     27                   e.g. c18f86a3-f228-4d98-91bb-f90135c0aa9c
     28      * `msstoresignedin`: only present if the installation was done through the Microsoft Store,
     29                           and was able to retrieve the "campaign ID" it was first installed with.
     30                           This value is "true" if the user was signed into the Microsoft Store
     31                           when they first installed, and false otherwise.
     32      * `dlsource`: identifier that indicate where installations of Firefox originate
     33    # yamllint enable
     34    bugs:
     35      - https://bugzilla.mozilla.org/1955429
     36    data_reviews:
     37      - https://bugzilla.mozilla.org/1955429
     38    notification_emails:
     39      - chutten@mozilla.com
     40    send_in_pings:
     41      - metrics
     42      - baseline
     43      - events
     44    expires: never
     45    structure:
     46      type: object
     47      properties:
     48        experiment:
     49          type: string
     50        variation:
     51          type: string
     52        ua:
     53          type: string
     54        dltoken:
     55          type: string
     56        msstoresignedin:
     57          type: boolean
     58        dlsource:
     59          type: string
     60    send_in_pings:
     61      - metrics
     62      - update
     63      - baseline
     64      - events
     65    no_lint:
     66      - BASELINE_PING
     67 
     68 glean.distribution:
     69  ext:
     70    type: object
     71    lifetime: user
     72    description: |
     73      Extended distribution information.
     74      Mapped to client_info.distribution.ext in datasets.
     75      * `distributionVersion`: pref `distribution.version`, `null` on failure
     76      * `partnerId`: pref `mozilla.partner.id`, `null` on failure
     77      * `distributor`:  pref `app.distributor`, `null` on failure
     78      * `distributorChannel`: pref `app.distributor.channel`, `null` on failure
     79      * `partnerNames`: list from prefs `app.partner.<name>=<name>`
     80    bugs:
     81      - https://bugzilla.mozilla.org/1955429
     82    data_reviews:
     83      - https://bugzilla.mozilla.org/1955429
     84    notification_emails:
     85      - chutten@mozilla.com
     86    send_in_pings:
     87      - metrics
     88      - baseline
     89      - events
     90    expires: never
     91    structure:
     92      type: object
     93      properties:
     94        distributionVersion:
     95          type: string
     96        partnerId:
     97          type: string
     98        distributor:
     99          type: string
    100        distributorChannel:
    101          type: string
    102        partnerNames:
    103          type: array
    104          items:
    105            type: string
    106    send_in_pings:
    107      - metrics
    108      - update
    109      - baseline
    110      - events
    111    no_lint:
    112      - BASELINE_PING