metrics.yaml

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

# This file defines the metrics that are recorded by the Glean SDK. They are
# automatically converted to platform-specific code at build time using the
# `glean_parser` PyPI package.

---
$schema: moz://mozilla.org/schemas/glean/metrics/1-0-0

# glean.internal.metrics do not need to be defined in this file.
# Otherwise, probe-scraper will fail due to the correct glean-core
# dependency

glean.session:
    session_id:
        type: uuid
        description: |
            An identifier for the current session.
            A session is a measurement window for the usage of web app.
            A session is reset:
                1. After 30 minutes of inactivity.
                   Any click, scroll or keypress on the page is considered activity.
                2. When a user loads the app with a different `utm_campaign` search param.
                3. Everyday at midnight local time.
        bugs:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_reviews:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_sensitivity:
            - technical
        notification_emails:
        - glean-team@mozilla.com
        expires: never

glean.platform:
    browser:
        type: string
        description: |
            The browser the current Glean instance is running on.
        bugs:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_reviews:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_sensitivity:
            - technical
        notification_emails:
        - glean-team@mozilla.com
        expires: never
    device_type:
        type: string
        description: |
            The type of device the current Glean instance is running on.
            This can be either 'mobile'|'tablet'|'desktop'
        bugs:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_reviews:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_sensitivity:
            - technical
        notification_emails:
        - glean-team@mozilla.com
        expires: never

glean.page:
    title:
        type: string
        description: |
            The title of the page the client is on.
        bugs:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_reviews:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_sensitivity:
            - technical
        notification_emails:
        - glean-team@mozilla.com
        expires: never
    path:
        type: string
        description: |
            The path of the page the client is on.
        bugs:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_reviews:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_sensitivity:
            - technical
        notification_emails:
        - glean-team@mozilla.com
        expires: never
    referrer:
        type: string
        description: |
            The URL of the page that linked to the current page the client is on.
        bugs:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_reviews:
            - https://bugzilla.mozilla.org/show_bug.cgi?id=actually-we-dont-have-this
        data_sensitivity:
            - technical
        notification_emails:
        - glean-team@mozilla.com
        expires: never