blob: c23fe0782c08682bd8ebd3f4f315c228f7d458f0 [file] [log] [blame]
# Copyright 2019 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
# NOTA BENE
# Despite not being numerically indexed, a metric's dimensions are
# sequentially ordered. When adding new dimensions to a metric, unreported
# fields are back-filled with null values, but new reports will report the
# dimension as having an empty value associated with its 0-index. When new
# dimensions are added to a metric, one cannot discern between valid events
# with a 0 value, and metrics reported from devices that did not know about
# the new dimension.
#
# This was realized after already having added additional dimensions to
# metrics in this file.
#
# To avoid invalidating absolutely all historical data, and because this is
# not an issue for initial metrics -- every metric must measure at least one
# dimension -- the first dimension may use its 0-indexed code to represent
# something meaningful to the dimension.
#
# For consistency throughout the rest of the file, and to support
# extensibility of metric dimensions in the future, all subsequent dimensions
# use "Unreported" as the code for the 0-index of that dimension.
#
# Reviewers and contributors: please maintain this practice when adding new
# metrics here.
metric_definitions:
#####################################################################
# update_check_response_time_migrated
#
# Elapsed microseconds from sending update check to getting a response
# from Omaha.
# Logged when we receive an update check response from Omaha.
#####################################################################
- id: 101
metric_name: update_check_response_time_migrated
metric_type: INTEGER
metric_semantics: [LATENCY]
metric_dimensions:
- dimension: Result
event_codes:
0: Success
1: Failed
metric_units: MILLISECONDS
reports:
#####################################################################
# update_check_response_timing_histogram
#
# Exponential histogram starting from 1ms to 1048576ms (about 17min)
#####################################################################
- report_name: update_check_response_timing_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 20
initial_step: 1
step_multiplier: 2
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
privacy_level: NO_ADDED_PRIVACY
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_check_interval_migrated
#
# Elapsed microseconds from the previous update check to the current
# update check.
# Logged when we start a new update check.
#####################################################################
- id: 102
metric_name: update_check_interval_migrated
metric_type: INTEGER
metric_units: SECONDS
metric_semantics: [LATENCY]
metric_dimensions:
- dimension: Result
event_codes:
0: Success
- dimension: Clock
event_codes:
0: Unreported
1: Wall
2: Monotonic
- dimension: Initiator
event_codes:
0: Unreported
1: OnDemand
2: ScheduledTask
reports:
#####################################################################
# update_check_interval_histogram
#
# Exponential histogram starting from 1 seconds to 12.13 days.
#####################################################################
- report_name: update_check_interval_histogram
id: 1
int_buckets:
exponential:
floor: 0
num_buckets: 20
initial_step: 1
step_multiplier: 2
report_type: FLEETWIDE_HISTOGRAMS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# linear_histogram_1min_buckets
#
# linear histogram covering 2 hours
#####################################################################
- report_name: linear_histogram_1min_buckets
id: 2
int_buckets:
linear:
floor: 0
num_buckets: 120
step_size: 60
report_type: FLEETWIDE_HISTOGRAMS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# linear_histogram_10min_buckets
#
# linear histogram covering 24 hours in 10-minute-sized buckets
#####################################################################
- report_name: linear_histogram_10min_buckets
id: 3
int_buckets:
linear:
floor: 0
num_buckets: 144
step_size: 600
report_type: FLEETWIDE_HISTOGRAMS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_duration_migrated
#
# Elapsed microseconds from starting an update to having successfully
# applied it or encountering a failure.
#
# Computed based on the elapsed time from when an update was initiated
# to when the application of the update has completed, excluding the
# reboot into the new version.
#
# Logged when an update is finished or when an update attempt fails.
#####################################################################
- id: 103
metric_name: update_duration_migrated
metric_type: INTEGER
metric_units: SECONDS
metric_semantics: [LATENCY]
metric_dimensions:
- dimension: Result
event_codes:
0: Success
1: Failed
reports:
#####################################################################
# update_duration_histogram
#
# Exponential histogram starting from 10 seconds to 170 minutes.
#####################################################################
- report_name: update_duration_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 10
initial_step: 10
step_multiplier: 2
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# update_duration_histogram_10sec_buckets
#
# Linear histogram of 10sec buckets over a 0-15 minute range
#####################################################################
- report_name: update_duration_histogram_10sec_buckets
id: 2
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
linear:
floor: 0
num_buckets: 90
step_size: 10
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# update_duration_histogram_1min_buckets
#
# Linear histogram of 1 minute buckets over a 1-2 hour range
#####################################################################
- report_name: update_duration_histogram_1min_buckets
id: 3
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
linear:
floor: 0
num_buckets: 120
step_size: 60
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_duration_from_first_seen_migrated
#
# Elapsed microseconds from first seeing an update to having
# successfully applied it.
#
# Computed based on the elapsed time from when an update was "first
# seen" by the client (when the version was first received in an
# "update" response from omaha) to when the application of the update
# has completed, including all retries and waits, excluding the time
# to reboot into the new version.
#
# Logged when an update has been successfully applied (staged for
# booting into).
#####################################################################
- id: 104
metric_name: update_duration_from_first_seen_migrated
metric_type: INTEGER
metric_units: SECONDS
metric_semantics: [LATENCY]
metric_dimensions:
- dimension: Result
event_codes:
0: Success
- dimension: Clock
event_codes:
0: Unreported
1: Monotonic
2: Wall
reports:
#####################################################################
# update_duration_from_first_seen_histogram
#
# Exponential histogram starting from 10 seconds, extending to 121 days.
#####################################################################
- report_name: update_duration_from_first_seen_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 20
initial_step: 10
step_multiplier: 2
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_check_failure_migrated
#
# Why an update check failed (network, omaha, proxy, etc).
# Logged when an update check is failed.
#####################################################################
- id: 105
metric_name: update_check_failure_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING] # TODO(b/278763096): Replace this with a more appropriate semantic
metric_dimensions:
- dimension: Reason
event_codes:
0: Omaha
1: Network
2: Proxy
3: Configuration
4: Internal
max_event_code: 4
reports:
#####################################################################
# update_check_failure_reason_count
#
# Occurrence count for each failure reason.
#####################################################################
- report_name: update_check_failure_reason_count
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# update_check_failure_reason_device_count
#
# Count of number of devices that see a given error each day/
#####################################################################
- report_name: update_check_failure_reason_device_count
id: 2
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_LAST
local_aggregation_procedure: AT_LEAST_ONCE
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# requests_per_check_migrated
#
# Number of requests to omaha within a single update attempt to check
# for the availability of an update.
# Logged when an update check is performed.
#####################################################################
- id: 106
metric_name: requests_per_check_migrated
metric_type: INTEGER
metric_dimensions:
- dimension: Result
event_codes:
0: Success
1: Failed
metric_units_other: "requests"
metric_semantics: [USAGE_COUNTING]
reports:
#####################################################################
# requests_per_check_exponential_histogram
#
# Exponential histogram starting from 1 to 1024.
#####################################################################
- report_name: requests_per_check_exponential_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 10
initial_step: 1
step_multiplier: 2
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# requests_per_check_linear_histogram
#
# Linear histogram starting from 1 to 8.
#####################################################################
- report_name: requests_per_check_linear_histogram
id: 2
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
linear:
floor: 1
num_buckets: 8
step_size: 1
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# requests_per_check_per_device_min_histogram
#
# Linear histogram min aggregated starting from 1 to 8.
#####################################################################
- report_name: requests_per_check_per_device_min_histogram
id: 3
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 1
num_buckets: 8
step_size: 1
local_aggregation_procedure: MIN_PROCEDURE
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# requests_per_check_per_device_max_histogram
#
# Per device Linear histogram max aggregated starting from 1 to 8.
#####################################################################
- report_name: requests_per_check_per_device_max_histogram
id: 4
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 1
num_buckets: 8
step_size: 1
local_aggregation_procedure: MAX_PROCEDURE
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# attempts_to_successful_check_migrated
#
# Number of update check attempts to get a response from omaha.
# Logged when a response has been received.
#####################################################################
- id: 107
metric_name: attempts_to_successful_check_migrated
metric_type: INTEGER
metric_semantics: [USAGE_COUNTING]
metric_units_other: "attempts"
metric_dimensions:
- dimension: Result
event_codes:
0: Success
reports:
#####################################################################
# attempts_to_successful_check_histogram
#
# Exponential histogram starting from 1 to 1024.
#####################################################################
- report_name: attempts_to_successful_check_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 10
initial_step: 1
step_multiplier: 2
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# waited_for_reboot_duration_migrated
#
# Elapsed microseconds from having finished applying the update to
# when finally running that software; this is sent after the reboot
# (and includes the rebooting time).
# Logged when we are running the new version after reboot.
#####################################################################
- id: 108
metric_name: waited_for_reboot_duration_migrated
metric_type: INTEGER
metric_semantics: [LATENCY]
metric_units: SECONDS
metric_dimensions:
- dimension: Result
event_codes:
0: Success
reports:
#####################################################################
# waited_for_reboot_duration_histogram
#
# Exponential histogram starting from 1 seconds to 12.13 days.
#####################################################################
- report_name: waited_for_reboot_duration_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 20
initial_step: 1
step_multiplier: 2
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# failed_boot_attempts_migrated
#
# Number of time an update failed to boot into new version.
# Logged when we are running the new version after reboot or when
# we have reverted to the old version.
#####################################################################
- id: 109
metric_name: failed_boot_attempts_migrated
metric_type: INTEGER
metric_semantics: [USAGE_COUNTING]
metric_units_other: "attempts"
metric_dimensions:
- dimension: Result
event_codes:
0: Success
reports:
#####################################################################
# failed_boot_attempts_histogram
#
# Exponential histogram starting from 1 to 1024.
#####################################################################
- report_name: failed_boot_attempts_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
int_buckets:
exponential:
floor: 0
num_buckets: 10
initial_step: 1
step_multiplier: 2
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_check_failure_count_migrated
#
# Why an update check failed (network, omaha, proxy, etc).
# Logged when an update check is failed.
#####################################################################
- id: 110
metric_name: update_check_failure_count_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions:
- dimension: Reason
event_codes:
0: Omaha
1: Network
2: Proxy
3: Configuration
4: Internal
max_event_code: 4
reports:
#####################################################################
# per_device_exponential_histogram
#
# Exponential histogram of the number of devices that have seen the
# bucketed number of failures each day.
#####################################################################
- report_name: per_device_exponential_histogram
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
exponential:
floor: 0
num_buckets: 10
initial_step: 1
step_multiplier: 2
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# per_device_linear_histogram
#
# Linear histogram of the number of devices that have seen the
# bucketed number of failures each day.
#####################################################################
- report_name: per_device_linear_histogram
id: 2
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 0
num_buckets: 64
step_size: 1
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_check_performed_migrated
#
# Records that an update check was performed and the disposition of
# that check.
# Logged when an update check is completed, regardless of
# disposition.
#####################################################################
- id: 111
metric_name: update_check_performed_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions:
- dimension: CheckResult
event_codes:
0: Success
1: Failed
- dimension: Initiator
event_codes:
0: Unreported
1: ScheduledTask
2: OnDemand
- dimension: Availability
event_codes:
0: Unreported
1: UpdateAvailable
2: NoUpdateAvailable
- dimension: UpdateResult
event_codes:
0: Unreported
1: None
2: Success
3: Failed
reports:
#####################################################################
# per_device_linear_histogram
#
# Linear histogram of the number of update checks performed per
# device per day.
#####################################################################
- report_name: per_device_linear_histogram
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 0
num_buckets: 64
step_size: 1
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# omaha_event_lost_migrated
#
# Records that an Omaha event report was interrupted and lost, and
# logged in this case.
#####################################################################
- id: 112
metric_name: omaha_event_lost_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions:
- dimension: EventType
event_codes:
0: Unknown
1: DownloadComplete
2: InstallComplete
3: UpdateComplete
4: UpdateDownloadStarted
5: UpdateDownloadFinished
6: RebootedAfterUpdate
- dimension: EventResult
event_codes:
0: Unreported
1: Error
2: Success
3: SuccessAndRestartRequired
4: SuccessAndAppRestartRequired
5: Cancelled
6: ErrorInSystemInstaller
7: UpdateDeferred
reports:
#####################################################################
# per_device_linear_histogram
#
# Linear histogram of the number of lost Omaha events per device
# per day.
#####################################################################
- report_name: per_device_linear_histogram
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 0
num_buckets: 64
step_size: 1
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# attempts_per_device_day_migrated
#
# Records the number of times omaha-client attempts to install an
# update.
# Logged after update attempt, regardless of disposition.
#####################################################################
- id: 113
metric_name: attempts_per_device_day_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions:
- dimension: Result
event_codes:
0: Success
1: Failed
reports:
#####################################################################
# device_count_attempts_histogram
#
# Linear histogram of the number devices that have seen N consecutive
# failures applying an update per day.
#####################################################################
- report_name: device_count_attempts_histogram
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 1
num_buckets: 32
step_size: 1
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# attempts_to_reach_success_migrated
#
# Records the number of times omaha-client attempts to perform an
# installation before it succeeds.
# Logged after update attempt, regardless of disposition.
#####################################################################
- id: 114
metric_name: attempts_to_reach_success_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions:
- dimension: Result
event_codes:
0: Success
1: Failed
reports:
#####################################################################
# device_count_attempts_histogram
#
# Linear histogram of the number devices that have seen N consecutive
# update attempts, rolling over each day.
#####################################################################
- report_name: device_count_attempts_histogram
id: 1
report_type: UNIQUE_DEVICE_HISTOGRAMS
system_profile_selection: SELECT_LAST
int_buckets:
linear:
floor: 1
num_buckets: 32
step_size: 1
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
#####################################################################
# update_check_opt_out_preference_migrated
#
# The user's update opt-out preference used during an update check.
# Logged during an update check. Product's control the frequency of
# these checks, but it is typically once per day, in addition to any
# user-initiated update checks.
#####################################################################
- id: 115
metric_name: update_check_opt_out_preference_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions:
- dimension: Preference
event_codes:
0: Unknown
1: AllowAllUpdates
2: AllowOnlySecurityUpdates
max_event_code: 3
reports:
#####################################################################
# update_check_opt_out_preference_count
#
# Occurrence count for each opt-out preference.
#####################################################################
- report_name: update_check_opt_out_preference_count
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
#####################################################################
# update_check_opt_out_preference_device_count
#
# Count of number of devices that specify a given preference each day
#####################################################################
- report_name: update_check_opt_out_preference_device_count
id: 2
report_type: UNIQUE_DEVICE_COUNTS
system_profile_selection: SELECT_LAST
local_aggregation_procedure: AT_LEAST_ONCE
local_aggregation_period: WINDOW_1_DAY
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2023/05/06"
# Deleted metric IDs that must not be reused.
deleted_metric_ids: [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15]