toolkit/components/contentrelevancy/metrics.yaml

   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   - "Application Services :: Relevancy"
  12
  13 relevancy.classify:
  14   succeed:
  15     type: event
  16     description: >
  17       Record an event of a successful user interest classification.
  18     bugs:
  19       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889404
  20     data_reviews:
  21       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889404
  22     data_sensitivity:
  23       - interaction
  24     notification_emails:
  25       - disco-team@mozilla.com
  26       - najiang@mozilla.com
  27     expires: never
  28     extra_keys:
  29       input_size:
  30         description: >
  31           The total number of input elements used for classification.
  32         type: quantity
  33       input_classified_size:
  34         description: >
  35           The total number of input elements classified with at least one conclusive interest.
  36         type: quantity
  37       input_inconclusive_size:
  38         description: >
  39           The total number of input elements classified with the inconclusive interest.
  40         type: quantity
  41       output_interest_size:
  42         description: >
  43           The total number of output interests for classification.
  44         type: quantity
  45       interest_top_1_hits:
  46         description: >
  47           The total number of input elements for the interest with the most hits.
  48           Defaults to 0. This, along with `input_size` and `input_classified_size`,
  49           can be used to calculate the top-N classification percentages and top-N
  50           hit percentages.
  51         type: quantity
  52       interest_top_2_hits:
  53         description: >
  54           The total number of input elements for the interest with the 2nd most hits.
  55           Defaults to 0. This, along with `input_size` and `input_classified_size`,
  56           can be used to calculate the top-N classification percentages and top-N
  57           hit percentages.
  58         type: quantity
  59       interest_top_3_hits:
  60         description: >
  61           The total number of input elements for the interest with the 3rd most hits.
  62           Defaults to 0. This, along with `input_size` and `input_classified_size`,
  63           can be used to calculate the top-N classification percentages and top-N
  64           hit percentages.
  65         type: quantity
  66   fail:
  67     type: event
  68     description: >
  69       Record an event of a failed / aborted user interest classification.
  70     bugs:
  71       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889404
  72     data_reviews:
  73       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889404
  74     data_sensitivity:
  75       - interaction
  76     notification_emails:
  77       - disco-team@mozilla.com
  78       - najiang@mozilla.com
  79     expires: never
  80     extra_keys:
  81       reason:
  82         description: >
  83           The reason of the failed / aborted classification.
  84           One of
  85             * `insufficient-input`
  86             * `component-errors`
  87             * `store-not-ready`
  88         type: string
  89   duration:
  90     type: timing_distribution
  91     time_unit: millisecond
  92     description: >
  93       Record the duration (in ms) of a successful classification.
  94     bugs:
  95       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889404
  96     data_reviews:
  97       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889404
  98     data_sensitivity:
  99       - interaction
 100     notification_emails:
 101       - disco-team@mozilla.com
 102       - najiang@mozilla.com
 103     expires: never