Revision control
Copy as Markdown
# 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
# This file defines the metrics that are recorded by the Glean SDK. They are
# automatically converted to Rust code at build time using the `glean_parser`
# PyPI package.
---
test.metrics:
sample_boolean:
type: boolean
description: |
Just testing booleans
bugs:
data_reviews:
- N/A
notification_emails:
- CHANGE-ME@example.com
expires: never
send_in_pings:
- prototype
- usage-reporting
sample_labeled_counter: &defaults
type: labeled_counter
description: |
Just testing labeled_counter.
bugs:
data_reviews:
- N/A
notification_emails:
- nobody@example.com
expires: never
send_in_pings:
- prototype
no_lint:
- COMMON_PREFIX
timings:
<<: *defaults
type: timing_distribution
time_unit: millisecond
sample_labeled_custom_distribution:
<<: *defaults
type: labeled_custom_distribution
range_min: 0
range_max: 100
bucket_count: 10
histogram_type: linear
labels:
- aLabel
- 2label
sample_labeled_memory_distribution:
<<: *defaults
type: labeled_memory_distribution
memory_unit: kilobyte
labels:
- aLabel
- 2label
sample_labeled_timing_distribution:
<<: *defaults
type: labeled_timing_distribution
time_unit: millisecond
labels:
- aLabel
- 2label
sample_labeled_quantity:
<<: *defaults
type: labeled_quantity
unit: prtime
labels:
- aLabel
- 2label
sample_event_no_keys:
<<: *defaults
type: event
sample_event:
<<: *defaults
type: event
extra_keys:
key_one:
type: quantity
description: "This is key one"
And1WithUnusualCASING:
type: boolean
description: "This is key two"
party:
balloons:
type: object
description: |
Just testing objects
bugs:
data_reviews:
- N/A
notification_emails:
- CHANGE-ME@example.com
expires: never
send_in_pings:
- prototype
structure:
type: array
items:
type: object
properties:
colour:
type: string
diameter:
type: number
drinks:
type: object
description: |
Just testing objects
bugs:
data_reviews:
- N/A
notification_emails:
- CHANGE-ME@example.com
expires: never
send_in_pings:
- prototype
structure:
type: array
items:
type: object
properties:
name:
type: string
ingredients:
type: array
items:
type: string
glean.attribution:
ext:
type: object
lifetime: user
# Permit long description lines
# yamllint disable
description: |
Extended attribution information.
Mapped to client_info.attribution.ext in datasets.
* `experiment`: name/id of the enrolled funnel experiment
* `ua`: identifier derived from the user agent downloading the installer
e.g. chrome, Google Chrome 123
* `dltoken`: Unique token created at Firefox download time.
e.g. c18f86a3-f228-4d98-91bb-f90135c0aa9c
* `msstoresignedin`: only present if the installation was done through the Microsoft Store,
and was able to retrieve the "campaign ID" it was first installed with.
This value is "true" if the user was signed into the Microsoft Store
when they first installed, and false otherwise.
* `dlsource`: identifier that indicate where installations of Firefox originate
# yamllint enable
bugs:
data_reviews:
notification_emails:
- CHANGE-ME@example.com
send_in_pings:
- metrics
- baseline
- events
expires: never
no_lint:
- BASELINE_PING
structure:
type: object
properties:
experiment:
type: string
ua:
type: string
dltoken:
type: string
msstoresignedin:
type: boolean
dlsource:
type: string
glean.distribution:
ext:
type: object
lifetime: user
description: |
Extended distribution information.
Mapped to client_info.distribution.ext in datasets.
* `distributionVersion`: pref `distribution.version`, `null` on failure
* `partnerId`: pref `mozilla.partner.id`, `null` on failure
* `distributor`: pref `app.distributor`, `null` on failure
* `distributorChannel`: pref `app.distributor.channel`, `null` on failure
* `partnerNames`: list from prefs `app.partner.<name>=<name>`
bugs:
data_reviews:
notification_emails:
- CHANGE-ME@example.com
send_in_pings:
- metrics
- baseline
- events
expires: never
no_lint:
- BASELINE_PING
structure:
type: object
properties:
distributionVersion:
type: string
partnerId:
type: string
distributor:
type: string
distributorChannel:
type: string
partnerNames:
type: array
items:
type: string
test.dual_labeled:
static_static:
type: dual_labeled_counter
description: >
A dual labeled counter with static keys and categories
dual_labels:
key:
description: >
The key for the dual labeled counter
labels:
- key1
- key2
category:
description: >
The category for the dual labeled counter
labels:
- category1
- category2
bugs:
data_reviews:
notification_emails:
- CHANGE-ME@example.com
expires: never
dynamic_static:
type: dual_labeled_counter
description: >
A dual labeled counter with static keys and dynamic categories
dual_labels:
key:
description: >
The key for the dual labeled counter
labels:
- key1
- key2
category:
description: >
The category for the dual labeled counter
bugs:
data_reviews:
notification_emails:
- CHANGE-ME@example.com
expires: never
static_dynamic:
type: dual_labeled_counter
description: >
A dual labeled counter with dynamic keys and static categories
dual_labels:
key:
description: >
The key for the dual labeled counter
category:
description: >
The category for the dual labeled counter
labels:
- category1
- category2
bugs:
data_reviews:
notification_emails:
- CHANGE-ME@example.com
expires: never
dynamic_dynamic:
type: dual_labeled_counter
description: >
A dual labeled counter with dynamic keys and dynamic categories
dual_labels:
key:
description: >
The key for the dual labeled counter
category:
description: >
The category for the dual labeled counter
bugs:
data_reviews:
notification_emails:
- CHANGE-ME@example.com
expires: never