# 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/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Toolkit :: Places'

places:
  places_database_corruption_handling_stage:
    type: labeled_string
    description: >
      PLACES - stage reached when trying to fix a database corruption, see
      Places::Database::eCorruptDBReplaceStage.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895851
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1356812
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1895851
    data_sensitivity:
      - technical
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  sponsored_visit_no_triggering_url:
    type: counter
    description: >
      Number of sponsored visits that could not find their triggering URL
      in history. We expect this to be a small number just due to the
      navigation layer manipulating URLs. A large or growing value may be
      a concern.
      This metric was generated to correspond to the Legacy Telemetry
      scalar places.sponsored_visit_no_triggering_url.
    bugs:
      - https://bugzil.la/1787961
    data_reviews:
      - https://bugzil.la/1787961
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    telemetry_mirror: PLACES_SPONSORED_VISIT_NO_TRIGGERING_URL

  pages_need_frecency_recalculation:
    type: quantity
    description: >
      Number of pages that need a frecency recalculation.
    bugs:
      - https://bugzil.la/1811209
    data_reviews:
      - https://bugzil.la/1811209
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never
    unit: pages

  previousday_visits:
    type: quantity
    description: >
      Number of history entries for the previous day.
      This metric was generated to correspond to the Legacy Telemetry
      scalar places.previousday_visits.
    bugs:
      - https://bugzil.la/1824380
    data_reviews:
      - https://bugzil.la/1824380
    notification_emails:
      - firefox-view-engineers@mozilla.com
    expires: never
    unit: history entries
    telemetry_mirror: PLACES_PREVIOUSDAY_VISITS

  pages_count:
    type: custom_distribution
    description: >
      PLACES: Number of unique pages
    range_min: 1000
    range_max: 150000
    bucket_count: 20
    histogram_type: exponential
    unit: pages
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  most_recent_expired_visit:
    type: timing_distribution
    description: >
      PLACES: the most recent expired visit in days
    time_unit: day
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  bookmarks_count:
    type: custom_distribution
    description: >
      PLACES: Number of bookmarks
    range_min: 100
    range_max: 8000
    bucket_count: 15
    histogram_type: exponential
    unit: bookmarks
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  tags_count:
    type: custom_distribution
    description: >
      PLACES: Number of tags
    range_min: 1
    range_max: 200
    bucket_count: 10
    histogram_type: exponential
    unit: tags
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  keywords_count:
    type: custom_distribution
    description: >
      PLACES: Number of keywords
    range_min: 1
    range_max: 200
    bucket_count: 10
    histogram_type: exponential
    unit: keywords
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  backups_daysfromlast:
    type: timing_distribution
    description: >
      PLACES: Days from last backup
    time_unit: day
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  backups_bookmarkstree:
    type: timing_distribution
    description: >
      PLACES: Time to build the bookmarks tree
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  backups_tojson:
    type: timing_distribution
    description: >
      PLACES: Time to convert and write the backup
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  export_tohtml:
    type: timing_distribution
    description: >
      PLACES: Time to convert and write bookmarks.html
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  sorted_bookmarks_perc:
    type: custom_distribution
    description: >
      PLACES: Percentage of bookmarks organized in folders
    range_min: 1
    range_max: 100
    bucket_count: 10
    histogram_type: linear
    unit: percent
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  tagged_bookmarks_perc:
    type: custom_distribution
    description: >
      PLACES: Percentage of tagged bookmarks
    range_min: 1
    range_max: 100
    bucket_count: 10
    histogram_type: linear
    unit: percent
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  database_filesize:
    type: memory_distribution
    description: >
      PLACES: Database filesize (MB)
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  database_favicons_filesize:
    type: memory_distribution
    description: >
      PLACES: Favicons database filesize (MB)
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1346554
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1346554
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  database_semantic_history_filesize:
    type: memory_distribution
    description: >
      PLACES: Semantic History database filesize (MB)
    memory_unit: megabyte
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1965010
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1965010
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  database_semantic_history_wasted_percentage:
    type: quantity
    unit: percent
    description: >
      PLACES: Semantic History database wasted space in percentage (0-100)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1979080
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1979080
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  database_semantic_history_defragment_time:
    type: timing_distribution
    description: >
      PLACES: Time to defragment the semantic database (ms)
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1979080
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1979080
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  database_semantic_history_reindex_time:
    type: timing_distribution
    description: >
      PLACES: Time to reindex the semantic database during a migration (ms)
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2039131
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2039131
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  database_semantic_history_num_entries:
    type: quantity
    description: >
      PLACES: Number of entries (embeddings) stored in the semantic history
      database. Reported occasionally (approx after every 40 major updates).
    unit: entries
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2048511
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2048511
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  expiration_steps_to_clean:
    type: custom_distribution
    description: >
      PLACES: Expiration steps to cleanup the database
    range_min: 0
    range_max: 10
    bucket_count: 11
    histogram_type: linear
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  idle_frecency_decay_time:
    type: timing_distribution
    description: >
      PLACES: Time to decay all frecencies values on idle (ms)
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  idle_maintenance_time:
    type: timing_distribution
    description: >
      PLACES: Time to execute maintenance tasks on idle (ms)
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  frecency_recalc_chunk_time:
    type: timing_distribution
    description: >
      PLACES: Time to recalculate frecency for a chunk of pages (ms)
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1811209
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1811209
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1822848
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  annos_pages_count:
    type: custom_distribution
    description: >
      PLACES: Number of pages annotations
    range_min: 50
    range_max: 5000
    bucket_count: 10
    histogram_type: exponential
    unit: pages
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  maintenance_daysfromlast:
    type: timing_distribution
    description: >
      PLACES: Days from last maintenance
    time_unit: day
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1944631
    notification_emails:
      - fx-search-telemetry@mozilla.com
    expires: never

  semantic_history_find_chunks_time:
    type: timing_distribution
    description: >
      Time to find URLs to calculate embeddings for.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971120
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971120
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  semantic_history_max_chunks_count:
    type: quantity
    description: >
      Max number of chunks of embeddings to calculate.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971120
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971120
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never
    unit: history chunks

  semantic_history_chunk_calculate_time:
    type: timing_distribution
    description: >
      Time to calculate a chunk of embeddings.
    time_unit: millisecond
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971120
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1971120
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

  semantic_history_indexing_stopped:
    type: labeled_counter
    description: >
      Number of times background semantic-history indexing stopped advancing
      because recent chunks were too slow. The "failsafe" label counts the hard
      brake; the "soft" label counts stops gated on the minimum number of
      embeddings.
    labels:
      - failsafe
      - soft
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2048511
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2048511
    data_sensitivity:
      - technical
    notification_emails:
      - mak@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never

page_icon:
  small_icon_count:
    type: counter
    description: >
      Number of times the page-icon protocol serves an icon smaller than requested.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911375
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911375
    data_sensitivity:
      - interaction
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never
  fit_icon_count:
    type: counter
    description: >
      Number of times the page-icon protocol serves an icon equal to or larger than requested.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911375
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1911375
    data_sensitivity:
      - interaction
    notification_emails:
      - mbonardo@mozilla.com
      - fx-search-telemetry@mozilla.com
    expires: never