blob: 0234cafd0622dfbaacde95f9fa84dbd60c365026 [file] [log] [blame]
# Copyright 2020 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.
#####################################################################
# Cobalt Project: connectivity_location
#
# These metrics relate to protocols in the `fuchsia.location`
# namespace.
#####################################################################
metric_definitions:
#####################################################################
# emergency_get_current_result
#
# Count of times we attempted to read our current `position.Position`
# from the `position.EmergencyProvider`.
#
# This will be reported each time the
# `position.EmergencyProvider.GetCurrent` method is invoked.
#
# On average, this should be reported less than once per device
# per day.
#####################################################################
- id: 1
metric_name: emergency_get_current_result
metric_type: EVENT_OCCURRED
replacement_metric_id: 101
metric_dimensions: &egcr_dimensions
- dimension: result
event_codes:
0: Success
1: Failure
max_event_code: 1
reports:
#####################################################################
# emergency_get_current_result_counts
#
# Count of each of the types of get_current_result occurrences.
#####################################################################
- report_name: emergency_get_current_result_counts
id: 1
report_type: SIMPLE_OCCURRENCE_COUNT
local_privacy_noise_level: NONE
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
- id: 101
metric_name: emergency_get_current_result_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions: *egcr_dimensions
reports:
- report_name: emergency_get_current_result_counts
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
#####################################################################
# emergency_get_current_latency
#
# Elapsed time for each successful call to
# `position.EmergencyProvider.GetCurrent`.
#
# On average, this should be reported less than once per day.
#####################################################################
- id: 2
replacement_metric_id: 102
metric_name: emergency_get_current_latency
metric_type: ELAPSED_TIME
reports:
#####################################################################
# emergency_get_current_latency_histogram
#
# A fleet-wide histogram of lookup latency, in milliseconds.
#####################################################################
- report_name: emergency_get_current_latency_histogram
id: 1
report_type: INT_RANGE_HISTOGRAM
int_buckets: &egcl_buckets
exponential:
floor: 0
num_buckets: 10
initial_step: 10
step_multiplier: 2
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
- id: 102
metric_name: emergency_get_current_latency_migrated
metric_type: INTEGER
metric_semantics: [LATENCY]
metric_units_other: "milliseconds" # TODO: Switch this to metric_units: MILLISECONDS once logging
# directly to this metric
reports:
- report_name: emergency_get_current_latency_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
privacy_level: NO_ADDED_PRIVACY
int_buckets: *egcl_buckets
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
#####################################################################
# emergency_get_current_accuracy
#
# Estimated accuracy radius (in millimeters), for each
# `position.Position` returned by
# `position.EmergencyProvider.GetCurrent`.
#
# On average, this should be reported less than once per day.
#####################################################################
- id: 3
metric_name: emergency_get_current_accuracy
metric_type: EVENT_COUNT
replacement_metric_id: 103
reports:
#####################################################################
# emergency_get_current_accuracy_histogram
#
# A fleet-wide histogram of position accuracy, in millimeters.
#####################################################################
- report_name: emergency_get_current_accuracy_histogram
id: 1
report_type: INT_RANGE_HISTOGRAM
int_buckets: &egca_buckets
exponential:
floor: 0
num_buckets: 30
initial_step: 1
step_multiplier: 2
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
- id: 103
metric_name: emergency_get_current_accuracy_migrated
metric_type: INTEGER
metric_semantics: [OUTSIDE_ENVIRONMENT]
metric_units_other: "millimeters"
reports:
- report_name: emergency_get_current_accuracy_histogram
id: 1
report_type: FLEETWIDE_HISTOGRAMS
privacy_level: NO_ADDED_PRIVACY
int_buckets: *egca_buckets
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
#####################################################################
# emergency_get_current_failure
#
# Count of reasons for failures of calls to
# `position.EmergencyProvider.GetCurrent()`.
#
# This is intended to "deep-dive" into the source of faults, when
# the `emergency_get_current_result` metric reports a high failure
# rate.
#
# This will be reported each time the
# `position.EmergencyProvider.GetCurrent` method returns failure.
#
# On average, this should be reported less than once per day.
#####################################################################
- id: 4
metric_name: emergency_get_current_failure
metric_type: EVENT_OCCURRED
replacement_metric_id: 104
metric_dimensions: &egcf_dimensions
- dimension: cause
event_codes:
0: NoBsses
1: Internal
2: Lookup
max_event_code: 2
reports:
#####################################################################
# emergency_get_current_failure_counts
#
# Count of each of the types of get_current_failure occurrences.
#####################################################################
- report_name: emergency_get_current_failure_counts
id: 1
report_type: SIMPLE_OCCURRENCE_COUNT
local_privacy_noise_level: NONE
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
- id: 104
metric_name: emergency_get_current_failure_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions: *egcf_dimensions
reports:
- report_name: emergency_get_current_failure_counts
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
#####################################################################
# wlan_sensor_report
#
# Count of outcomes for calls to
# `sensor.WlanBaseStationWatcher.ReportCurrentStations`.
#
# This is intended to "deep-dive" into the source of faults, when
# the `emergency_get_current_failure` metric reports a high rate of
# `NoBsses` causes.
#
# That analysis requires both: knowing if ReportCurrentStations is
# being called, and if ReportCurrentStations is succeeding.
#
# This will be reported each time the
# `sensor.WlanBaseStationWatcher.ReportCurrentStations` method is
# called.
#
# Typically, this will be reported less than once per hour. However,
# this may peak at up to 4 times per minute, while trying to find
# a WLAN network.
#####################################################################
- id: 5
metric_name: wlan_sensor_report
metric_type: EVENT_OCCURRED
replacement_metric_id: 105
metric_dimensions: &wsr_dimensions
- dimension: result
event_codes:
0: Success
1: NoBssIds
2: NoBsses
3: IpcError
4: ServiceError
max_event_code: 4
reports:
#####################################################################
# wlan_sensor_report_result_counts
#
# Count of each of the types of wlan_sensor_report results.
#####################################################################
- report_name: wlan_sensor_report_result_counts
id: 1
report_type: SIMPLE_OCCURRENCE_COUNT
local_privacy_noise_level: NONE
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"
- id: 105
metric_name: wlan_sensor_report_migrated
metric_type: OCCURRENCE
metric_semantics: [USAGE_COUNTING]
metric_dimensions: *wsr_dimensions
reports:
- report_name: wlan_sensor_report_result_counts
id: 1
report_type: FLEETWIDE_OCCURRENCE_COUNTS
privacy_level: NO_ADDED_PRIVACY
system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
meta_data:
max_release_stage: GA
expiration_date: "2021/06/08"