Skip to content

Commit 0fa1578

Browse files
committed
Improve metric desciptions
1 parent 9dcab5f commit 0fa1578

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

telemetry/glean/metrics.yaml

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,8 @@ ad_client:
298298
country_code:
299299
type: string
300300
description: >
301-
The client's country code.
301+
Country code (ISO 3166-1 alpha-2 format) associated with the client when the ad was requested.
302+
Should not be null.
302303
lifetime: application
303304
send_in_pings:
304305
- ad-provider-request-stats
@@ -313,7 +314,8 @@ ad_client:
313314
region_code:
314315
type: string
315316
description: >
316-
The client's region code.
317+
Region code (ISO 3166-2 format) associated with the client when the ad was requested.
318+
May be null.
317319
lifetime: application
318320
send_in_pings:
319321
- ad-provider-request-stats
@@ -328,7 +330,8 @@ ad_client:
328330
dma_code:
329331
type: string
330332
description: >
331-
The client's DMA code. May be null
333+
Designated Marketing Area code (US only) associated with the client when the ad was requested.
334+
May be null.
332335
lifetime: application
333336
send_in_pings:
334337
- ad-provider-request-stats
@@ -506,7 +509,8 @@ provider_request:
506509
provider:
507510
type: string
508511
description: >
509-
The name of the ad provider
512+
The external service providing the ad.
513+
Should not be null.
510514
lifetime: application
511515
send_in_pings:
512516
- ad-provider-request-stats
@@ -522,7 +526,8 @@ provider_request:
522526
type: quantity
523527
unit: ads
524528
description: >
525-
The number of ads requested from the provider
529+
The number of ads requested from the provider.
530+
Should not be null.
526531
lifetime: application
527532
send_in_pings:
528533
- ad-provider-request-stats
@@ -539,6 +544,7 @@ provider_request:
539544
unit: ads
540545
description: >
541546
The number of ads returned by the provider.
547+
Should not be null.
542548
lifetime: application
543549
send_in_pings:
544550
- ad-provider-request-stats
@@ -553,8 +559,9 @@ provider_request:
553559
products_requested:
554560
type: string_list
555561
description: >
556-
The type of ad requested. Possible values are from Shepherd's Canonical Mozilla Ad Products:
562+
The type of ads requested from the provider. Possible values are from Shepherd's Canonical Mozilla Ad Products:
557563
Tile, Native, Billboard, Rectangle, Skyscraper, Leaderboard.
564+
Should not be null.
558565
lifetime: application
559566
send_in_pings:
560567
- ad-provider-request-stats
@@ -569,7 +576,8 @@ provider_request:
569576
ids_returned:
570577
type: string_list
571578
description: >
572-
The ids of the creatives returned by the provider.
579+
The ids of the ads returned by the provider.
580+
Should not be null.
573581
lifetime: application
574582
send_in_pings:
575583
- ad-provider-request-stats
@@ -584,7 +592,8 @@ provider_request:
584592
request_timestamp:
585593
type: datetime
586594
description:
587-
The timestamp of the request to the provider.
595+
The timestamp of the request to the ad provider.
596+
Should not be null.
588597
lifetime: application
589598
send_in_pings:
590599
- ad-provider-request-stats
@@ -599,7 +608,8 @@ provider_request:
599608
response_timestamp:
600609
type: datetime
601610
description:
602-
The timestamp of the response from the provider.
611+
The timestamp of the response from the ad provider.
612+
Should not be null.
603613
lifetime: application
604614
send_in_pings:
605615
- ad-provider-request-stats

0 commit comments

Comments
 (0)