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

################################################################################
# Cobalt Project: connectivity_wlan
################################################################################

metric_definitions:
# IDs 1-5 were already used

################################################################################
# Client Association RSSI [dBm]
#
# We log a histogram of RSSI for client association frames, in dBm,
# once per minute.
################################################################################
- id: 6
  replacement_metric_id: 14
  metric_name: client_assoc_rssi
  # RSSI histogram for the client association frames in dBm. The buckets are
  # -128, -127, ..., 0.
  metric_type: INT_HISTOGRAM
  int_buckets: &car_buckets
    linear:
      # Bucket 0 is the underflow bucket: (-infinity, -128]
      # Bucket 1: -127
      # Bucket 2: -126
      # Bucket 128: 0
      # Bucket 129 is the overflow bucket: [1, infinity)
      floor: -127
      num_buckets: 128
      step_size: 1
  reports:
    ############################################################################
    # Fleet-wide histogram of the client association RSSI in dBm.
    ############################################################################
    - report_name: client_assoc_rssi_fleetwide_histogram
      id: 2462539721 # legacy long report_id
      report_type: INT_RANGE_HISTOGRAM
      system_profile_field: [BOARD_NAME, PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 14
  metric_name: client_assoc_rssi_migrated
  # RSSI histogram for the client association frames in dBm. The buckets are
  # -128, -127, ..., 0.
  metric_type: INTEGER_HISTOGRAM
  metric_units_other: "dBm"
  metric_semantics: [OUTSIDE_ENVIRONMENT, NETWORK_COMMUNICATION]
  int_buckets: *car_buckets
  reports:
    ############################################################################
    # Fleet-wide histogram of the client association RSSI in dBm.
    ############################################################################
    - report_name: client_assoc_rssi_fleetwide_histogram
      id: 1
      report_type: FLEETWIDE_HISTOGRAMS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Client Beacon RSSI [dBm]
#
# We log a histogram of RSSI for client beacon frames, in dBm,
# once per minute.
################################################################################
- id: 7
  replacement_metric_id: 15
  metric_name: client_beacon_rssi
  # RSSI histogram for the client beacon frames in dBm. The buckets are
  # -128, -127, ..., 0.
  metric_type: INT_HISTOGRAM
  int_buckets: &cbr_buckets
    linear:
      # Bucket 0 is the underflow bucket: (-infinity, -128]
      # Bucket 1: -127
      # Bucket 2: -126
      # Bucket 128: 0
      # Bucket 129 is the overflow bucket: [1, infinity)
      floor: -127
      num_buckets: 128
      step_size: 1
  reports:
    ############################################################################
    # Fleet-wide histogram of the client beacon RSSI in dBm.
    ############################################################################
    - report_name: client_beacon_rssi_fleetwide_histogram
      id: 879167428 # legacy long report_id
      report_type: INT_RANGE_HISTOGRAM
      system_profile_field: [BOARD_NAME, PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 15
  metric_name: client_beacon_rssi_migrated
  # RSSI histogram for the client beacon frames in dBm. The buckets are
  # -128, -127, ..., 0.
  metric_type: INTEGER_HISTOGRAM
  metric_units_other: "dBm"
  metric_semantics: [OUTSIDE_ENVIRONMENT, NETWORK_COMMUNICATION]
  int_buckets: *cbr_buckets
  reports:
    ############################################################################
    # Fleet-wide histogram of the client beacon RSSI in dBm.
    ############################################################################
    - report_name: client_beacon_rssi_fleetwide_histogram
      id: 1
      report_type: FLEETWIDE_HISTOGRAMS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

# IDs 8-13 were already used

################################################################################
# Connection attempts
#
# On connection success, log the number of successive connection attempts that
# have been made to the same SSID since boot or the last connection success.
################################################################################
- id: 100
  replacement_metric_id: 102
  metric_name: connection_attempts
  metric_type: EVENT_COUNT
  reports:
    - report_name: connection_attempts
      id: 3217187570 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 102
  metric_name: connection_attempts_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  reports:
    - report_name: connection_attempts
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection success with attempts breakdown
#
# On connection success, log count=1, with breakdown on how many attempts
# having been made to the same SSID since boot or the last connection success,
# as well as information about the network on the *last* connection attempt.
# (whether multiple BSS are found with same SSID, what the security type is,
# and which channel band the network is on).
################################################################################
- id: 101
  replacement_metric_id: 103
  metric_name: connection_success_with_attempts_breakdown
  metric_type: EVENT_COUNT
  metric_dimensions: &cswab_dimensions
    - dimension: attempts
      event_codes:
        0: One
        1: Two
        2: Three
        3: Four
        4: Five
        5: MoreThanFive
    - dimension: is_multi_bss
      event_codes: &yes_no
        0: "Yes"
        1: "No"
    - dimension: protection
      event_codes: &protections
        0: Unknown
        1: Open
        2: Wep
        3: Wpa1
        4: Wpa1Wpa2Personal
        5: Wpa2Personal
        6: Wpa2Wpa3Personal
        7: Wpa3Personal
        8: Wpa2Enterprise
        9: Wpa3Enterprise
        # 10 removed by http://fxrev.dev/470379
        11: Wpa1Wpa2PersonalTkipOnly
        12: Wpa2PersonalTkipOnly
    - dimension: channel_band
      event_codes: &channel_bands
        6: Band2Dot4Ghz
        7: Band5Ghz
  reports:
    - report_name: connection_attempts
      id: 3217187570 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 103
  metric_name: connection_success_with_attempts_breakdown_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *cswab_dimensions
  reports:
    - report_name: connection_attempts
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection result
#
# When a connection attempt ends, log count=1 on whether it succeeds, fails,
# or gets canceled, along with the OUI of the network the user attempts to
# connect to (if connection attempt has found a candidate network)
################################################################################
- id: 110
  no_replacement_metric: manually migrated to connection_result_migrated
  metric_name: connection_result
  metric_type: EVENT_COUNT
  metric_dimensions: &cr_dimensions
    - dimension: result
      event_codes: &connection_result
        0: Success
        1: Canceled
        2: Failed
  reports:
    - report_name: connection_result
      id: 1838796699 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      # Last updated: Aug 19, 2021 version of https://linuxnet.ca/ieee/oui/nmap-mac-prefixes
      # Command: `awk '{print $1}' nmap-mac-prefixes.txt > ouis.txt`
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
    - report_name: connection_result_per_device_with_board_product
      id: 3381230870 # legacy long report_id
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME]
    - report_name: connection_result_per_device_global
      id: 915145966 # legacy long report_id
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection result
#
# When a connection attempt ends, log count=1 on whether it succeeds, fails,
# or gets canceled, along with the AP profile and OUI of the network the user
# attempts to connect to.
################################################################################
- id: 116
  metric_name: connection_result_migrated
  metric_type: STRING
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions:
    - dimension: result
      event_codes: *connection_result
    - dimension: is_multi_bss
      event_codes: *yes_no
    - dimension: protection
      event_codes: *protections
    - dimension: channel_band
      event_codes: *channel_bands
    - dimension: snr
      event_codes: &snrs
        0: "0"
        1: From1To10
        2: From11To15
        3: From16To25
        4: From26To40
        5: MoreThan40
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  reports:
    - report_name: connection_result
      id: 1
      report_type: STRING_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      string_buffer_max: 20
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection result post network selection
#
# When a connection attempt ends, provided that it has proceeded beyond the
# network selection steps, log count=1 on whether it succeeds, fails, or
# gets canceled, along with the AP profile and OUI of the network the user
# attempts to connect to.
################################################################################
- id: 111
  no_replacement_metric: manually migrated to connection_result_migrated
  metric_name: connection_result_post_network_selection
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: result
      event_codes: *connection_result
    - dimension: is_multi_bss
      event_codes: *yes_no
    - dimension: protection
      event_codes: *protections
    - dimension: channel_band
      event_codes: *channel_bands
  reports:
    - report_name: connection_result_post_network_selection
      id: 36500028 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection result per RSSI (post network selection)
#
# Same as "connection_result_post_network_selection" metric, but with RSSI
# dimension instead of AP profile.
################################################################################
- id: 112
  no_replacement_metric: manually migrated to connection_result_migrated
  metric_name: connection_result_per_rssi
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: result
      event_codes: *connection_result
    - dimension: rssi
      event_codes: &rssis
        0: From127To90
        1: From89To86
        2: From85To83
        3: From82To80
        4: From79To77
        5: From76To74
        6: From73To71
        7: From70To66
        8: From65To61
        9: From60To51
        10: From50To1
        11: "0"
  reports:
    - report_name: connection_result_per_rssi
      id: 3112173207 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection failure
#
# When failed connecting to a network, log count=1 in this metric, which step
# failure happens at, and the OUI of the AP that client attempts to connect
# to (if connection attempt has found a candidate network).
################################################################################
- id: 113
  no_replacement_metric: manually migrated to connection_failure_migrated
  metric_name: connection_failure
  metric_type: EVENT_COUNT
  metric_dimensions: &cf_dimensions
    - dimension: fail_at
      event_codes:
        0: Scan
        1: NetworkSelection
        2: Join
        3: Authentication
        4: Association
        5: EstablishRsna
    - dimension: timeout
      event_codes: *yes_no
    - dimension: credential_rejected
      event_codes: *yes_no
  reports:
    - report_name: connection_failure
      id: 2546121118 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 117
  metric_name: connection_failure_migrated
  metric_type: STRING
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *cf_dimensions
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  reports:
    - report_name: connection_failure
      id: 1
      report_type: STRING_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      string_buffer_max: 20
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection result per SNR (post network selection)
#
# Same as "connection_result_post_network_selection" metric, but with SNR
# dimension instead of AP profile.
################################################################################
- id: 114
  no_replacement_metric: manually migrated to connection_result_migrated with SNR dimension
  metric_name: connection_result_per_snr
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: result
      event_codes: *connection_result
    - dimension: snr
      event_codes: *snrs
  reports:
    - report_name: connection_result_per_snr
      id: 1
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Successive connection failure
#
# On connection failure, log count=1, along with how many successive failures
# have been seen connecting to the same SSID. Also log the OUI of the AP
# that client attempts to connect to (if connection attempt has found a
# candidate network).
################################################################################
- id: 120
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: successive_connection_failure
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: successive_failure_count
      event_codes:
        0: Two
        1: Three
        2: Four
        3: Five
        4: MoreThanFive
  reports:
    - report_name: successive_connection_failure
      id: 3420468088 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
    - report_name: successive_connection_failure_per_device
      id: 1706369125 # legacy long report_id
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Successive connection failure breakdown
#
# Same as "successive_connection_failure" metric, but with breakdown on type
# of failure.
################################################################################
- id: 121
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: successive_connection_failure_breakdown
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: successive_failure_count
      event_codes:
        0: Two
        1: Three
        2: Four
        3: Five
        4: MoreThanFive
    - dimension: fail_at
      event_codes:
        0: Scan
        1: NetworkSelection
        2: Join
        3: Authentication
        4: Association
        5: EstablishRsna
        6: DifferentSteps
    - dimension: timeout
      event_codes:
        0: "Yes"
        1: "No"
        2: DifferentCauses
  reports:
    - report_name: successive_connection_failure_breakdown
      id: 510819356 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
    - report_name: successive_connection_failure_breakdown_per_device
      id: 4283468857 # legacy long report_id
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan result
#
# Once a scan finishes, log count=1. This includes join scan that happens
# during a connection attempt.
################################################################################
- id: 130
  replacement_metric_id: 132
  metric_name: scan_result
  metric_type: EVENT_COUNT
  metric_dimensions: &sr_dimensions
    - dimension: scan_result
      event_codes: &scan_result
        0: Success
        1: Failed
    - dimension: scan_type
      event_codes: &scan_types
        0: Active
        1: Passive
    - dimension: is_join_scan
      event_codes: *yes_no
    - dimension: client_state
      event_codes: &client_state_during_scan
        0: Idle
        1: Connected
  reports:
    - report_name: scan_result
      id: 3690927558 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 132
  metric_name: scan_result_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *sr_dimensions
  reports:
    - report_name: scan_result
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan failure
#
# Once a scan fails, log count=1. This includes a join scan failure that
# happens during a connection attempt.
################################################################################
- id: 131
  replacement_metric_id: 134
  metric_name: scan_failure
  metric_type: EVENT_COUNT
  metric_dimensions: &sf_dimensions
    - dimension: error_code
      event_codes:
        0: NotSupported
        1: InvalidArgs
        2: InternalError
    - dimension: scan_type
      event_codes: *scan_types
    - dimension: is_join_scan
      event_codes: *yes_no
    - dimension: client_state
      event_codes: *client_state_during_scan
  reports:
    - report_name: scan_failure
      id: 1566555801 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 134
  metric_name: scan_failure_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *sf_dimensions
  reports:
    - report_name: scan_failure
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Network selection failure
#
# Once a connection attempt fails due to selecting network, log count=1.
# Also log OUI if a candidate network is found.
################################################################################
- id: 140
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: network_selection_failure
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: error_reason
      event_codes:
        0: NoScanResultWithSsid
        # 1-4 removed by http://fxrev.dev/448836
        5: IncompatibleConnectRequest
        6: InternalProtectionError
  reports:
    - report_name: network_selection_failure
      id: 1524481705 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# No-compatible network failure - group cipher
#
# Once a connection attempt fails due to because no compatible network is
# found, log count=1 and the first group cipher used by the candidate network.
################################################################################
- id: 141
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: no_compatible_network_failure_group_cipher
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: group_cipher
      event_codes: &dot11_ciphers
        0: Unknown
        1: GroupCipherSuite
        2: Wep40
        3: Tkip
        4: Ccmp128
        5: Wep104
        6: BipCmac128
        7: GroupAddressedTrafficNotAllowed
        8: Gcmp128
        9: Gcmp256
        10: Ccmp256
        11: BipGmac128
        12: BipGmac256
        13: BipCmac256
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# No-compatible network failure - AKM
#
# Once a connection attempt fails due to because no compatible network is
# found, log count=1 and the AKM used by the candidate network.
################################################################################
- id: 142
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: no_compatible_network_failure_akm
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: akm
      event_codes:
        0: Unknown
        1: Eap
        2: Psk
        3: FtEap
        4: FtPsk
        5: EapSha256
        6: PskSha256
        7: Tdls
        8: Sae
        9: FtSae
        10: ApPeerKey
        11: EapSuiteB
        12: EapSuiteBSha384
        13: FtEapSha384
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# No-compatible network failure - pairwise cipher
#
# Once a connection attempt fails due to because no compatible network is
# found, log count=1 and the first pairwise cipher used by the candidate
# network.
################################################################################
- id: 143
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: no_compatible_network_failure_pairwise_cipher
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: pairwise_cipher
      event_codes: *dot11_ciphers
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# No-compatible network failure - suites
#
# Once a connection attempt fails due to because no compatible network is
# found, log count=1 and the first group cipher, AKM, first pairwise cipher
# used by the candidate network. Due to the limit on dimension combinations,
# only a subset of ciphers and AKMs is specified in this metric.
################################################################################
- id: 144
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: no_compatible_network_failure_suites
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: group_cipher
      event_codes:
        0: Others
        1: Tkip
        2: Ccmp128
    - dimension: akm
      event_codes:
        0: Others
        1: Eap
        2: Psk
        3: FtEap
        4: FtPsk
        5: EapSha256
        6: PskSha256
        7: Sae
        8: EapSuiteBSha384
    - dimension: pairwise_cipher
      event_codes:
        0: Others
        1: Ccmp128
        2: Gcmp256
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Authentication failure
#
# Once a connection attempt fails during an authentication step, log count=1,
# error code, AP profiles, and OUI of AP.
################################################################################
- id: 150
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: authentication_failure
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: error_code
      event_codes: &auth_error_codes
        0: Refused
        1: AntiCloggingTokenRequired
        2: FiniteCyclicGroupNotSupported
        3: AuthenticationRejected
        4: AuthFailureTimeout
    - dimension: is_multi_bss
      event_codes: *yes_no
    - dimension: channel_band
      event_codes: *channel_bands
    - dimension: protection
      event_codes: *protections
    - dimension: credential_rejected
      event_codes: *yes_no
  reports:
    - report_name: authentication_failure
      id: 1788679658 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Authentication failure per RSSI
#
# Like "authentication_failure" metric, but focus on RSSI breakdown instead.
################################################################################
- id: 151
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: authentication_failure_per_rssi
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: error_code
      event_codes: *auth_error_codes
    - dimension: rssi
      event_codes: *rssis
    - dimension: channel_band
      event_codes: *channel_bands
    - dimension: credential_rejected
      event_codes: *yes_no
  reports:
    - report_name: authentication_failure_per_rssi
      id: 271540892 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Association failure
#
# Once a connection attempt fails due to association timeout, log count=1 and
# error code, AP profiles, and OUI of AP.
################################################################################
- id: 160
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: association_failure
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: error_code
      event_codes: &assoc_error_codes
        0: RefusedReasonUnspecified
        1: RefusedNotAuthenticated
        2: RefusedCapabilitiesMismatch
        3: RefusedExternalReason
        4: RefusedApOutOfMemory
        5: RefusedBasicRatesMismatch
        6: RejectedEmergencyServicesNotSupported
        7: RefusedTemporarily
    - dimension: protection
      event_codes: *protections
    - dimension: credential_rejected
      event_codes: *yes_no
  reports:
    - report_name: association_failure
      id: 977264429 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Association failure per RSSI
#
# Like "association_failure" metric, but focus on RSSI breakdown instead.
################################################################################
- id: 161
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: association_failure_per_rssi
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: error_code
      event_codes: *assoc_error_codes
    - dimension: rssi
      event_codes: *rssis
    - dimension: channel_band
      event_codes: *channel_bands
    - dimension: credential_rejected
      event_codes: *yes_no
  reports:
    - report_name: association_failure_per_rssi
      id: 1605532061 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Establish RSNA failure
#
# Once a connection attempt fails during establish RSNA step, log count=1 and
# OUI of AP.
################################################################################
- id: 170
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: establish_rsna_failure
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: protection
      event_codes: *protections  # For DRY, we reuse the same "protections" event
                                 # codes. However, values like "Open" and "Wep"
                                 # are invalid.
    - dimension: credential_rejected
      event_codes: *yes_no
  reports:
    - report_name: establish_rsna_failure
      id: 4155328192 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Establish RSNA failure high-level error
#
# Like establish_rsna_failure, but with high-level error reason.
################################################################################
- id: 171
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: establish_rsna_failure_high_level_error
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: protection
      event_codes: *protections
    - dimension: error
      event_codes:
        0: StartSupplicantFailed
        1: KeyFrameExchangeTimeout
        2: OverallTimeout
        3: InternalError
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Establish RSNA failure low-level error
#
# Like establish_rsna_failure, but with low-level error reason.
################################################################################
- id: 172
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: establish_rsna_failure_low_level_error
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: protection
      event_codes: *protections
    ############################################################################
    # Error reasons from wlan-rsn crate's Error enum. Main difference is that
    # errors with MessageNumber are combined into MessageSpecificError,
    # with specific reasons logged in establish_rsna_failure_msg_specific_error
    # instead.
    ############################################################################
    - dimension: error
      event_codes:
        0: UnexpectedIoError
        1: InvalidOuiLength
        2: InvalidPmkidLength
        3: InvalidSsidLen
        4: InvalidPassphraseLen
        5: InvalidPassphraseChar
        6: IncompatibleConfig
        7: InvalidBitSize
        8: NonceError
        9: PtkHierarchyInvalidPmkError
        10: PtkHierarchyUnsupportedAkmError
        11: PtkHierarchyUnsupportedCipherError
        12: GtkHierarchyUnsupportedCipherError
        13: InvalidAesKeywrapKeySize
        14: InvalidAesKeywrapDataLength
        15: WrongAesKeywrapKey
        16: InvaidKeyDataLength
        17: InvalidKeyData
        18: UnknownAuthenticationMethod
        19: InvalidNegotiatedAkm
        20: UnknownKeyExchange
        21: UnexpectedInitiationRequest
        22: UnsupportedKeyDescriptor
        23: InvalidKeyDescriptor
        24: UnsupportedKeyDescriptorVersion
        25: UnsupportedKeyDerivation
        26: InvalidInstallBitGroupSmkHandshake
        27: SecureBitWithUnknownPtk
        28: SecureBitNotSetWithKnownPtkGtk
        29: InvalidRequestBitAuthenticator
        30: InvalidErrorBitAuthenticator
        31: InvalidKeyAckBitSupplicant
        32: InvalidMicBitForEncryptedKeyData
        33: InvalidKeyLength
        34: UnsupportedCipherSuite
        35: UnsupportedAkmSuite
        36: ComputingMicForUnprotectedFrame
        37: MicSizesDiffer
        38: InvalidMicSize
        39: InvalidKeyDataContent
        40: InvalidKeyDataLength
        41: UnexpectedMic
        42: InvalidMic
        43: UnexpectedEncryptedKeyData
        44: InvalidKeyReplayCounter
        45: ErrorNonceDoesntMatch
        46: PmksaNotEstablished
        47: InvalidNonceSize
        48: InvalidKeyDataRsne
        49: BufferTooSmall
        50: SmkHandshakeNotSupported
        51: InvalidNegotiatedProtection
        52: MessageSpecificError
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Establish RSNA failure msg-specific error
#
# Like establish_rsna_failure, but with error reason on specific message. This
# further breaks down MessageSpecificError from
# establish_rsna_failure_low_level_error.
################################################################################
- id: 173
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: establish_rsna_failure_msg_specific_error
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: protection
      event_codes: *protections
    - dimension: message_number
      event_codes:
        0: One
        1: Two
        2: Three
        3: Four
    - dimension: error
      event_codes:
        0: Unexpected4WayHandshakeMessage
        1: InvalidInstallBitValue
        2: InvalidKeyAckBitValue
        3: InvalidKeyMicBitValue
        4: InvalidSecureBitValue
        5: InvalidErrorBitValue
        6: InvalidRequestBitValue
        7: InvalidEncryptedKeyDataBitValue
        8: InvalidNonce
        9: InvalidRsc
        10: EmptyKeyData
        11: InvalidIv
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Establish RSNA failure progress
#
# Like establish_rsna_failure, but breakdown on whether some steps have
# succeeded.
################################################################################
- id: 174
  no_replacement_metric: Connection failure breakdown metrics for individual steps are not migrated
  metric_name: establish_rsna_failure_progress
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: protection
      event_codes: *protections
    - dimension: pmksa_established
      event_codes: *yes_no
    - dimension: ptksa_established
      event_codes: *yes_no
    - dimension: gtksa_established
      event_codes: *yes_no
    - dimension: esssa_established
      event_codes: *yes_no
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection setup time (unit: microseconds)
#
# Once a connection attempt finishes, log amount of time it takes to complete.
################################################################################
- id: 200
  replacement_metric_id: 205
  metric_name: connection_setup_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: connection_setup_time
      id: 3596613501 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: connection_setup_time_per_board
      id: 1238679264 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: connection_time_per_product
      id: 891273003 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 205
  metric_name: connection_setup_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: connection_setup_time
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection setup time per result (unit: microseconds)
#
# Once a connection attempt finishes, log amount of time it takes to complete,
# and whether it succeeds or fails.
################################################################################
- id: 201
  replacement_metric_id: 206
  metric_name: connection_setup_time_per_result
  metric_type: ELAPSED_TIME
  metric_dimensions: &cstpr_dimensions
    - dimension: connection_result
      event_codes: *connection_result
  reports:
    - report_name: connection_setup_time_per_result
      id: 1742122531 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: connection_setup_time_per_result_per_board
      id: 4217191086 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: connection_setup_time_per_result_per_product
      id: 3582333459 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 206
  metric_name: connection_setup_time_per_result_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *cstpr_dimensions
  reports:
    - report_name: connection_setup_time_per_result
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection setup time without scan (unit: microseconds)
#
# Once a connection attempt completes, log amount of time it takes starting
# from Join step (i.e., excluding the join scan and network selection time)
################################################################################
- id: 202
  replacement_metric_id: 207
  metric_name: connection_setup_time_without_scan
  metric_type: ELAPSED_TIME
  reports:
    - report_name: connection_setup_time_without_scan
      id: 3217172420 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: connection_setup_time_without_scan_per_board
      id: 1610218473 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: connection_setup_time_without_scan_per_product
      id: 1423966084 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 207
  metric_name: connection_setup_time_without_scan_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: connection_setup_time_without_scan
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection setup time without scan per result (unit: microseconds)
#
# Like "connection_time_without_scan", but with breakdown on connection result
################################################################################
- id: 203
  replacement_metric_id: 208
  metric_name: connection_setup_time_without_scan_per_result
  metric_type: ELAPSED_TIME
  metric_dimensions: &cstwspr_dimensions
    - dimension: connection_result
      event_codes: *connection_result
  reports:
    - report_name: connection_setup_time_without_scan_per_result
      id: 1083835692 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: connection_setup_time_without_scan_per_result_per_board
      id: 738165761 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: connection_setup_time_without_scan_per_result_per_product
      id: 649604188 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 208
  metric_name: connection_setup_time_without_scan_per_result_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *cstwspr_dimensions
  reports:
    - report_name: connection_setup_time_without_scan_per_result
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection time without scan per RSSI (unit: microseconds)
#
# Like "connection_time_without_scan", but with breakdown on RSSI
################################################################################
- id: 204
  replacement_metric_id: 209
  metric_name: connection_setup_time_without_scan_per_rssi
  metric_type: ELAPSED_TIME
  metric_dimensions: &cstwsprssi_dimensions
    - dimension: rssi
      event_codes: *rssis
  reports:
    - report_name: connection_setup_time_without_scan_per_rssi
      id: 2712933562 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: connection_setup_time_without_scan_per_rssi_per_board
      id: 2233955111 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: connection_setup_time_without_scan_per_rssi_per_product
      id: 747929490 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 209
  metric_name: connection_setup_time_without_scan_per_rssi_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *cstwsprssi_dimensions
  reports:
    - report_name: connection_setup_time_without_scan_per_rssi
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan time (unit: microseconds)
#
# Once a discovery scan finishes, log amount of time it takes. Or, once a
# connection attempt finishes, log amount of time the join scan takes,
# provided that the join scan isn't canceled.
################################################################################
- id: 210
  replacement_metric_id: 215
  metric_name: scan_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: scan_time
      id: 2103079462 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: scan_time_per_board
      id: 3287395355 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: scan_time_per_product
      id: 4052576950 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 215
  metric_name: scan_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: scan_time
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan time per scan result (unit: microseconds)
#
# Like "scan_time", but with breakdown on scan result
################################################################################
- id: 211
  replacement_metric_id: 216
  metric_name: scan_time_per_result
  metric_type: ELAPSED_TIME
  metric_dimensions: &stpr_dimensions
    - dimension: scan_result
      event_codes: *scan_result
  reports:
    - report_name: scan_time_per_result
      id: 3799526582 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: scan_time_per_result_per_board
      id: 3151153355 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: scan_time_per_result_per_product
      id: 2027286534 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 216
  metric_name: scan_time_per_result_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *stpr_dimensions
  reports:
    - report_name: scan_time_per_result
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan time per scan type (unit: microseconds)
#
# Like "scan_time", but with breakdown on scan type (active vs passive scan).
################################################################################
- id: 212
  replacement_metric_id: 217
  metric_name: scan_time_per_scan_type
  metric_type: ELAPSED_TIME
  metric_dimensions: &stpst_dimensions
    - dimension: scan_type
      event_codes: *scan_types
  reports:
    - report_name: scan_time_per_scan_type
      id: 2060382845 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: scan_time_per_scan_type_per_board
      id: 75698656 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: scan_time_per_scan_type_per_product
      id: 1415207957 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 217
  metric_name: scan_time_per_scan_type_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *stpst_dimensions
  reports:
    - report_name: scan_time_per_scan_type
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan time per join or discovery (unit: microseconds)
#
# Like "scan_time", but with breakdown on whether it's join scan or discovery
# scan.
################################################################################
- id: 213
  replacement_metric_id: 218
  metric_name: scan_time_per_join_or_discovery
  metric_type: ELAPSED_TIME
  metric_dimensions: &stpjod_dimensions
    - dimension: is_join_scan
      event_codes: *yes_no
  reports:
    - report_name: scan_time_per_join_or_discovery
      id: 1189236244 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: scan_time_per_join_or_discovery_per_board
      id: 3346484441 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: scan_time_per_join_or_discovery_per_product
      id: 586220564 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 218
  metric_name: scan_time_per_join_or_discovery_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *stpjod_dimensions
  reports:
    - report_name: scan_time_per_join_or_discovery
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan time per client state (unit: microseconds)
#
# Like "scan_time", but with breakdown on client state when scan starts.
################################################################################
- id: 214
  replacement_metric_id: 219
  metric_name: scan_time_per_client_state
  metric_type: ELAPSED_TIME
  metric_dimensions: &stpcs_dimensions
    - dimension: client_state
      event_codes: *client_state_during_scan
  reports:
    - report_name: scan_time_per_client_state
      id: 1462067566 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: scan_time_per_client_state_per_board
      id: 2660012883 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: scan_time_per_client_state_per_product
      id: 545354126 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 219
  metric_name: scan_time_per_client_state_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *stpcs_dimensions
  reports:
    - report_name: scan_time_per_client_state
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Authentication time (unit: microseconds)
#
# Once a connection attempt finishes, log amount of time it takes for
# authentication step to complete.
################################################################################
- id: 220
  replacement_metric_id: 222
  metric_name: authentication_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: authentication_time
      id: 1752568727 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: authentication_time_per_board
      id: 594652458 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: authentication_time_per_product
      id: 1973850863 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 222
  metric_name: authentication_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: authentication_time
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Authentication time per RSSI (unit: microseconds)
#
# Like "authentication_time", but with breakdown on RSSI.
################################################################################
- id: 221
  replacement_metric_id: 223
  metric_name: authentication_time_per_rssi
  metric_type: ELAPSED_TIME
  metric_dimensions: &atpr_dimensions
    - dimension: rssi
      event_codes: *rssis
  reports:
    - report_name: authentication_time_per_rssi
      id: 824656227 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: authentication_time_per_rssi_per_board
      id: 2327793134 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: authentication_time_per_rssi_per_product
      id: 3031088979 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 223
  metric_name: authentication_time_per_rssi_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *atpr_dimensions
  reports:
    - report_name: authentication_time_per_rssi
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Association time (unit: microseconds)
#
# Log amount of time it takes for an association step to complete.
################################################################################
- id: 230
  replacement_metric_id: 232
  metric_name: association_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: association_time
      id: 2015583722 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: association_time_per_board
      id: 3143400759 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: association_time_per_product
      id: 4232936898 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 232
  metric_name: association_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: association_time
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Association time per RSSI (unit: microseconds)
#
# Like "association_time", but with breakdown on RSSI.
################################################################################
- id: 231
  replacement_metric_id: 233
  metric_name: association_time_per_rssi
  metric_type: ELAPSED_TIME
  metric_dimensions: &atprssi_dimensions
    - dimension: rssi
      event_codes: *rssis
  reports:
    - report_name: association_time_per_rssi
      id: 3701848732 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: association_time_per_rssi_per_board
      id: 3388825681 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: association_time_per_rssi_per_product
      id: 128724172 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 233
  metric_name: association_time_per_rssi_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *atprssi_dimensions
  reports:
    - report_name: association_time_per_rssi
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"


################################################################################
# Establish RSNA time (unit: microseconds)
#
# Log amount of time it takes for an establish RSNA step to complete
################################################################################
- id: 240
  replacement_metric_id: 243
  metric_name: establish_rsna_time
  metric_type: ELAPSED_TIME
  metric_dimensions:
  reports:
    - report_name: establish_rsna_time
      id: 1092506449 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: establish_rsna_time_per_board
      id: 2073312476 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: establish_rsna_time_per_product
      id: 1357126769 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 243
  metric_name: establish_rsna_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions:
  reports:
    - report_name: establish_rsna_time
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Establish RSNA time per RSSI (unit: microseconds)
#
# Like "establish_rsna_time", but with breakdown on RSSI.
################################################################################
- id: 241
  replacement_metric_id: 244
  metric_name: establish_rsna_time_per_rssi
  metric_type: ELAPSED_TIME
  metric_dimensions: &ertpr_dimensions
    - dimension: rssi
      event_codes: *rssis
  reports:
    - report_name: establish_rsna_time_per_rssi
      id: 19595201 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: establish_rsna_time_per_rssi_per_board
      id: 346901228 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: establish_rsna_time_per_rssi_per_product
      id: 2044426145 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 244
  metric_name: establish_rsna_time_per_rssi_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *ertpr_dimensions
  reports:
    - report_name: establish_rsna_time_per_rssi
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Start supplicant time (unit: microseconds)
#
# Log amount of time it takes for a supplicant's start method call to complete.
# This is logged approximately once every connection attempt to a protected
# network (because supplicant needs to start first before rest of connection
# setup can proceed).
################################################################################
- id: 242
  replacement_metric_id: 245
  metric_name: start_supplicant_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: numeric_aggregation_per_board
      id: 3648821612 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: numeric_aggregation_per_product
      id: 2605427233 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 245
  metric_name: start_supplicant_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: numeric_aggregation
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection queued time (unit: microseconds)
#
# In SME, a connection attempt may sit idle while waiting for an existing scan
# to finish. This logs the duration from when SME receives a connection
# attempt to when it actually starts (with the join scan step)
################################################################################
- id: 250
  replacement_metric_id: 251
  metric_name: connection_queued_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: connection_queued_time
      id: 1536125649 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
    - report_name: connection_queued_time_per_board
      id: 4127903836 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [BOARD_NAME]
    - report_name: connection_queued_time_per_product
      id: 886152177 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: [PRODUCT_NAME]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 251
  metric_name: connection_queued_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: connection_queued_time
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection gap time (unit: microseconds)
#
# This metric logs the time it takes from when the client last disconnects
# (whether it's manual disconnect or connection drop) to when the client
# reconnects. This is logged when a client connects successfully.
#
# This metric does not measure the gap from device boot to when client first
# connects, or when client disconnects to when device shuts down. This metric
# is also not logged for the case where a previous disconnect happened
# automatically while connecting to a network, but this may change in the
# future.
################################################################################
- id: 260
  replacement_metric_id: 262
  metric_name: connection_gap_time
  metric_type: ELAPSED_TIME
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 262
  metric_name: connection_gap_time_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  reports:
    - report_name: numeric_aggregation
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection gap time breakdown (unit: microseconds)
#
# Same as connection_gap_time metric but with breakdown on whether reconnects
# happens on same SSID and what the previous disconnect was.
################################################################################
- id: 261
  replacement_metric_id: 263
  metric_name: connection_gap_time_breakdown
  metric_type: ELAPSED_TIME
  metric_dimensions: &cgtb_dimensions
    - dimension: ssids
      event_codes:
        0: SameSsid
        1: DifferentSsids
    - dimension: previous_disconnect_cause
      event_codes:
        0: Manual
        1: Drop
  reports:
    - report_name: numeric_aggregation
      id: 1233664577 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      percentiles: [90, 95, 99]
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 263
  metric_name: connection_gap_time_breakdown_migrated
  metric_type: INTEGER
  metric_semantics: [LATENCY, NETWORK_COMMUNICATION]
  metric_units: MICROSECONDS
  metric_dimensions: *cgtb_dimensions
  reports:
    - report_name: numeric_aggregation
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      local_aggregation_procedure: MAX_PROCEDURE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: []
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection count by duration
#
# When first connected, log count=1. At each connection duration milestone,
# log count=1.
################################################################################
- id: 300
  replacement_metric_id: 305
  metric_name: connection_count_by_duration
  metric_type: EVENT_COUNT
  metric_dimensions: &ccbd_dimensions
    - dimension: connected_time
      event_codes: &connected_milestones
        0: Connected
        1: ConnectedOneMinute
        2: ConnectedTenMinute
        3: ConnectedThirtyMinute
        4: ConnectedOneHour
        5: ConnectedThreeHours
        6: ConnectedSixHours
        7: ConnectedTwelveHours
        8: ConnectedOneDay
        9: ConnectedTwoDays
        10: ConnectedThreeDays
  reports:
    - report_name: connection_count_by_duration
      id: 1341197894 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: connection_count_by_duration_per_device
      id: 3748489403 # legacy long report_id
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 305
  metric_name: connection_count_by_duration_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *ccbd_dimensions
  reports:
    - report_name: connection_count_by_duration
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: connection_count_by_duration_per_device_1_day
      id: 2
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_1_DAY
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: connection_count_by_duration_per_device_7_days
      id: 3
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_7_DAYS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Lost connection counts
#
# Whenever client sees an unexpected disconnect, log count=1, with breakdown
# on how long that connection has lasted.
################################################################################
- id: 301
  no_replacement_metric: Disconnect metrics will be replacing the connection loss metrics, so only the former metrics are migrated.
  metric_name: lost_connection_count
  metric_type: EVENT_COUNT
  metric_dimensions:
    - dimension: connected_time
      event_codes: &connected_times
        0: LessThanOneMinute
        1: LessThanTenMinutes
        2: LessThanThirtyMinutes
        3: LessThanOneHour
        4: LessThanThreeHours
        5: LessThanSixHours
        6: AtLeastSixHours
    - dimension: rssi
      event_codes: *rssis
  reports:
    - report_name: lost_connection_count
      id: 2393361650 # legacy long report_id
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection uptime ping
#
# Periodically, we log this event for each time milestone that the current
# connection has already passed. Once the connection has passed a given time
# milestone, we continue to log that milestone repeatedly as long as the
# connection continues.
#
# The main difference between "connection_count_by_duration" metric and this
# metric is that the former logs each milestone only once in the same
# connected session, whereas this metric may log each milestone multiple times.
# This metric is primarily intended for per-device stats.
################################################################################
- id: 302
  replacement_metric_id: 306
  metric_name: connection_uptime_ping
  metric_type: EVENT_OCCURRED
  metric_dimensions: &cup_dimensions
    - dimension: connected_time
      event_codes: *connected_milestones
      max_event_code: 10
  reports:
    - report_name: unique_n_day_actives
      id: 2596147864 # legacy long report_id
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 306
  metric_name: connection_uptime_ping_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *cup_dimensions
  reports:
    - report_name: unique_n_day_actives_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: unique_n_day_actives_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Disconnect counts
#
# Whenever client sees a disconnect, log count=1.
################################################################################
- id: 303
  replacement_metric_id: 307
  metric_name: disconnect_count
  metric_type: EVENT_COUNT
  reports:
    - report_name: disconnect_count_per_device
      id: 1
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 307
  metric_name: disconnect_count_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  reports:
    - report_name: disconnect_count_per_device_1_day
      id: 1
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_1_DAY
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: disconnect_count_per_device_7_days
      id: 2
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_7_DAYS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Disconnect counts breakdown
#
# Whenever client sees a disconnect, log count=1, with breakdown
# on how long that connection has lasted, disconnect source, and SNR.
################################################################################
- id: 304
  no_replacement_metric: manually migrated to disconnect_count_breakdown_migrated
  metric_name: disconnect_count_breakdown
  metric_type: EVENT_COUNT
  metric_dimensions: &dcb_dimensions
    - dimension: connected_time
      event_codes: *connected_times
    - &disconnect_sources_dim
      dimension: disconnect_source
      event_codes:
        0: user
        1: mlme
        2: ap
    - dimension: snr
      event_codes: *snrs
    - dimension: recent_channel_switch
      event_codes: *yes_no
    - dimension: channel_band
      event_codes: *channel_bands
  reports:
    - report_name: disconnect_count_breakdown
      id: 1
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      candidate_file: fuchsia/connectivity_wlan/ouis.txt
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 308
  metric_name: disconnect_count_breakdown_migrated
  metric_type: STRING
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *dcb_dimensions
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  reports:
    - report_name: disconnect_count_breakdown
      id: 1
      report_type: STRING_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      string_buffer_max: 20
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Disconnect reason code
#
# Whenever client sees a disconnect, log the reason code and its source
################################################################################
- id: 400
  metric_name: disconnect_reason
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions:
    - &disconnect_reasons_dim
      # Note: the meaning of reason_code depends on which `disconnect_source`
      #       it comes from.
      dimension: reason_code
      max_event_code: 1000
    - *disconnect_sources_dim
  reports:
    - report_name: disconnect_reason
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: device_most_common_disconnect_reason_daily
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: SELECT_MOST_COMMON
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL]
    - report_name: device_most_common_disconnect_reason_weekly
      id: 3
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: SELECT_MOST_COMMON
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL]
    - report_name: device_most_common_disconnect_reason_daily_system_ver
      id: 4
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: SELECT_MOST_COMMON
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: device_most_common_disconnect_reason_weekly_system_ver
      id: 5
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: SELECT_MOST_COMMON
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Disconnect reason average population
#
# Every day, if the device has been on for long enough and has only had a
# few disconnects on that day, log the reason codes and source of those
# disconnects.
#
# This is an experimental metric (will be removed once it answers our question
# or there's no longer need for it).
################################################################################
- id: 401
  metric_name: disconnect_reason_average_population
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions:
    - *disconnect_reasons_dim
    - *disconnect_sources_dim
  reports:
    - report_name: disconnect_reason_average_population
      id: 1
      report_type: HOURLY_VALUE_NUMERIC_STATS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: device_disconnect_reason_average_population_daily
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: SELECT_MOST_COMMON
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL]
    - report_name: device_disconnect_reason_average_population_daily_system_ver
      id: 3
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: SELECT_MOST_COMMON
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Scan results received
#
# On each scan completion, count the number of saved networks observed within
# that scan.
################################################################################
- id: 310
  replacement_metric_id: 321
  metric_name: scan_results_received
  metric_type: EVENT_OCCURRED
  metric_dimensions: &srr_dimensions
    - dimension: saved_networks_count
      event_codes:
        0: Zero
        1: One
        2: TwoToFour
        3: FiveToTwenty
        4: TwentyOneToForty
        5: FortyOneOrMore
      max_event_code: 5
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of saved
    # network in scan results" was observed during rolling windows of 1 and 7
    # days.
    ############################################################################
    - report_name: saved_networks_in_scan_results_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 321
  metric_name: scan_results_received_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *srr_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of saved
    # network in scan results" was observed during rolling windows of 1 and 7
    # days.
    ############################################################################
    - report_name: saved_networks_in_scan_results_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: saved_networks_in_scan_results_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Saved network observed in scan result
#
# On each scan completion, for each saved network, count the number of BSSs seen
# for that saved network.
################################################################################
- id: 311
  replacement_metric_id: 322
  metric_name: saved_network_in_scan_result
  metric_type: EVENT_OCCURRED
  metric_dimensions: &snisr_dimensions
    - dimension: bss_count
      event_codes:
        0: Zero
        1: One
        2: TwoToFour
        3: FiveToTen
        4: ElevenToTwenty
        5: TwentyOneOrMore
      max_event_code: 5
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of bss per
    # saved network in scan results" was observed during rolling windows of 1 and
    # 7 days.
    ############################################################################
    - report_name: bss_per_saved_network_in_scan_result_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 322
  metric_name: saved_network_in_scan_result_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *snisr_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of bss per
    # saved network in scan results" was observed during rolling windows of 1 and
    # 7 days.
    ############################################################################
    - report_name: bss_per_saved_network_in_scan_result_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: bss_per_saved_network_in_scan_result_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Saved networks
#
# Periodically record the count of networks saved on the device every 24h.
################################################################################
- id: 312
  replacement_metric_id: 323
  metric_name: saved_networks
  metric_type: EVENT_OCCURRED
  metric_dimensions: &sn_dimensions
    - dimension: saved_networks
      event_codes:
        0: Zero
        1: One
        2: TwoToFour
        3: FiveToForty
        4: FortyToFiveHundred
        5: FiveHundredAndOneOrMore
      max_event_code: 5
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of saved
    # networks" was observed during rolling windows of 1 and 7 days.
    ############################################################################
    - report_name: saved_networks_on_device_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 323
  metric_name: saved_networks_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *sn_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of saved
    # networks" was observed during rolling windows of 1 and 7 days.
    ############################################################################
    - report_name: saved_networks_on_device_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: saved_networks_on_device_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Saved configuration for saved network
#
# Periodically record the count of saved configurations for each saved network
# on the device every 24h.
################################################################################
- id: 313
  replacement_metric_id: 324
  metric_name: saved_configurations_for_saved_network
  metric_type: EVENT_OCCURRED
  metric_dimensions: &scfsn_dimensions
    - dimension: saved_configurations
      event_codes:
        0: Zero
        1: One
        2: TwoToFour
        3: FiveToForty
        4: FortyToFiveHundred
        5: FiveHundredAndOneOrMore
      max_event_code: 5
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of
    # configurations per saved network" was observed during rolling windows of
    # 1 and 7 days.
    ############################################################################
    - report_name: saved_configurations_per_saved_network_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"
- id: 324
  metric_name: saved_configurations_for_saved_network_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *scfsn_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices on which each "count of
    # configurations per saved network" was observed during rolling windows of
    # 1 and 7 days.
    ############################################################################
    - report_name: saved_configurations_per_saved_network_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: saved_configurations_per_saved_network_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Last successful scan age when performing a scan
#
# Record the age of the previous successful scan every time we trigger a scan.
# This measurement will help optimize the window in which we suppress scan
# attempts because we have a recent-enough scan result in our cache.
################################################################################
- id: 314
  replacement_metric_id: 325
  metric_name: last_scan_age_when_scan_requested
  metric_type: ELAPSED_TIME
  reports:
    - report_name: last_scan_age_when_scan_requested_histogram
      id: 1
      report_type: INT_RANGE_HISTOGRAM
      int_buckets: &lsawsrh_buckets
        linear:
          floor: 0
          num_buckets: 60  # combined with the step size, 5 minutes of buckets
          step_size: 5000000  # 5 seconds in microsends
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 325
  metric_name: last_scan_age_when_scan_requested_migrated
  metric_type: INTEGER
  metric_units: MICROSECONDS
  metric_semantics: [NETWORK_COMMUNICATION, LATENCY]
  reports:
    - report_name: last_scan_age_when_scan_requested_histogram
      id: 1
      report_type: FLEETWIDE_HISTOGRAMS
      int_buckets: *lsawsrh_buckets
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Active scan requested
#
# Count the number of saved networks we request to actively scan for during
# automated network selection.
################################################################################
- id: 315
  replacement_metric_id: 326
  metric_name: active_scan_requested_for_network_selection
  metric_type: EVENT_OCCURRED
  metric_dimensions: &asrfns_dimensions
    - dimension: active_scan_ssids_requested
      event_codes:
        0: Zero
        1: One
        2: TwoToFour
        3: FiveToTen
        4: ElevenToTwenty
        5: TwentyOneToFifty
        6: FiftyOneToOneHundred
        7: OneHundredAndOneOrMore
      max_event_code: 7
  reports:
    ############################################################################
    # We report the number of unique devices on which attempted an active scan
    # to find a saved network during rolling windows of 1 and 7 days.
    ############################################################################
    - report_name: bss_per_saved_network_in_active_scan_result_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of active scan attempts to find a saved network.
    ############################################################################
    - report_name: active_scan_requested_for_network_selection_ssid_count
      id: 2
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 326
  metric_name: active_scan_requested_for_network_selection_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *asrfns_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices on which attempted an active scan
    # to find a saved network during rolling windows of 1 and 7 days.
    ############################################################################
    - report_name: bss_per_saved_network_in_active_scan_result_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: bss_per_saved_network_in_active_scan_result_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of active scan attempts to find a saved network.
    ############################################################################
    - report_name: active_scan_requested_for_network_selection_ssid_count
      id: 3
      report_type: FLEETWIDE_OCCURRENCE_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Saved network observed in active scan result
#
# On each scan completion, for each saved network, count the number of BSSs seen
# for that saved network that were found via an active scan.
################################################################################
- id: 316
  replacement_metric_id: 327
  metric_name: saved_network_in_scan_result_with_active_scan
  metric_type: EVENT_OCCURRED
  metric_dimensions: &snisrwas_dimensions
    - dimension: active_scan_ssids_observed
      event_codes:
        0: Zero
        1: One
        2: TwoToFour
        3: FiveToTen
        4: ElevenToTwenty
        5: TwentyOneToFifty
        6: FiftyOneToOneHundred
        7: OneHundredAndOneOrMore
      max_event_code: 7
  reports:
    ############################################################################
    # We report the number of unique devices on which used an active scan to
    # find a saved network during rolling windows of 1 and 7 days.
    ############################################################################
    - report_name: bss_per_saved_network_in_active_scan_result_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of active scan successes in finding a saved
    # network.
    ############################################################################
    - report_name: active_scan_results_for_network_selection_ssid_count
      id: 2
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 327
  metric_name: saved_network_in_scan_result_with_active_scan_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *snisrwas_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices on which used an active scan to
    # find a saved network during rolling windows of 1 and 7 days.
    ############################################################################
    - report_name: bss_per_saved_network_in_active_scan_result_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: bss_per_saved_network_in_active_scan_result_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of active scan successes in finding a saved
    # network.
    ############################################################################
    - report_name: active_scan_results_for_network_selection_ssid_count
      id: 3
      report_type: FLEETWIDE_OCCURRENCE_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Connection attempt at Policy layer
#
# On each connection attempt at the Policy layer, log the reason for the
# connection attempt and its success.
################################################################################
- id: 317
  replacement_metric_id: 329
  metric_name: policy_connection_attempt
  metric_type: EVENT_OCCURRED
  metric_dimensions: &pca_dimensions
    - dimension: reason
      event_codes:
        0: RetryAfterDisconnectDetected
        1: RetryAfterFailedConnectAttempt
        2: FidlConnectRequest
        3: ProactiveNetworkSwitch
        4: RegulatoryChangeReconnect
        5: IdleInterfaceAutoconnect
        6: NewSavedNetworkAutoconnect
      max_event_code: 6
  reports:
    ############################################################################
    # We report the number of unique devices which had each connection reason
    ############################################################################
    - report_name: policy_connection_reasons_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of connection reasons
    ############################################################################
    - report_name: policy_connection_reasons_count
      id: 2
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 329
  metric_name: policy_connection_attempt_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *pca_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices which had each connection reason
    ############################################################################
    - report_name: policy_connection_reasons_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: policy_connection_reasons_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of connection reasons
    ############################################################################
    - report_name: policy_connection_reasons_count
      id: 3
      report_type: FLEETWIDE_OCCURRENCE_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Disconnection at Policy layer
#
# On each disconnection at the Policy layer, log the reason for the
# disconnection.
################################################################################
- id: 318
  replacement_metric_id: 330
  metric_name: policy_disconnection
  metric_type: EVENT_OCCURRED
  metric_dimensions: &pd_dimensions
    - dimension: reason
      event_codes:
        0: Unknown
        1: FailedToConnect
        2: FidlConnectRequest
        3: FidlStopClientConnectionsRequest
        4: ProactiveNetworkSwitch
        5: DisconnectDetectedFromSme
        6: RegulatoryRegionChange
        7: Startup
        8: NetworkUnsaved
        9: NetworkConfigUpdated
      max_event_code: 9
  reports:
    ############################################################################
    # We report the number of unique devices which had each disconnection reason
    ############################################################################
    - report_name: policy_disconnection_reasons_unique_devices
      id: 1
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: NONE
      window_size:
        - 1
        - 7
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of disconnection reasons
    ############################################################################
    - report_name: policy_disconnection_reasons_count
      id: 2
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 330
  metric_name: policy_disconnection_migrated
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  metric_dimensions: *pd_dimensions
  reports:
    ############################################################################
    # We report the number of unique devices which had each disconnection reason
    ############################################################################
    - report_name: policy_disconnection_reasons_unique_devices_1_day
      id: 1
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: policy_disconnection_reasons_unique_devices_7_days
      id: 2
      report_type: UNIQUE_DEVICE_COUNTS
      system_profile_selection: SELECT_LAST
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: AT_LEAST_ONCE
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    ############################################################################
    # We report the total number of disconnection reasons
    ############################################################################
    - report_name: policy_disconnection_reasons_count
      id: 3
      report_type: FLEETWIDE_OCCURRENCE_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Client functionality up-time at the policy layer.
#
# When client connections are disabled, log for how long they were enabled.
################################################################################
- id: 319
  replacement_metric_id: 331
  metric_name: client_connections_enabled_duration
  metric_type: ELAPSED_TIME
  reports:
    - report_name: client_connections_enabled_duration
      id: 1
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      window_size:
        - 1
        - 7
    - report_name: client_connections_enabled_toggles
      id: 2
      report_type: PER_DEVICE_NUMERIC_STATS
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      window_size:
        - 1
        - 7
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 331
  metric_name: client_connections_enabled_duration_migrated
  metric_type: INTEGER
  metric_units: MICROSECONDS
  metric_semantics: [NETWORK_COMMUNICATION, LATENCY]
  reports:
    - report_name: client_connections_enabled_duration_1_day
      id: 1
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: MEAN
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: client_connections_enabled_duration_7_days
      id: 2
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: MEAN
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Access point up-time at the policy layer.
#
# When an AP is stopped, log for how long the AP was running.
################################################################################
- id: 320
  replacement_metric_id: 332
  metric_name: access_point_enabled_duration
  metric_type: ELAPSED_TIME
  reports:
    - report_name: access_point_enabled_duration
      id: 1
      report_type: NUMERIC_AGGREGATION
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      window_size:
        - 1
        - 7
    - report_name: access_point_enabled_toggles
      id: 2
      report_type: PER_DEVICE_NUMERIC_STATS
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
      window_size:
        - 1
        - 7
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

- id: 332
  metric_name: access_point_enabled_duration_migrated
  metric_type: INTEGER
  metric_units: MICROSECONDS
  metric_semantics: [NETWORK_COMMUNICATION, LATENCY]
  reports:
    - report_name: access_point_enabled_duration_1_day
      id: 1
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_1_DAY
      local_aggregation_procedure: MEAN
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
    - report_name: access_point_enabled_duration_7_days
      id: 2
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_period: WINDOW_7_DAYS
      local_aggregation_procedure: MEAN
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/08/01"

################################################################################
# Firmware recovery occurrence in brcmfmac driver..
#
# When an instance of brcmfmac firmware recovery happened in any device,
# increase the counter by 1.
################################################################################
- id: 340
  metric_name: brcmfmac_firmware_recovery_occurrence
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION]
  reports:
    - report_name: brcmfmac_firmware_recovery_total_count
      id: 1
      report_type: FLEETWIDE_OCCURRENCE_COUNTS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, CHANNEL, SYSTEM_VERSION]
  # Use a single anchor so every metric shares the same expiration date
  # When updating the expiration date, perform a review of all the metrics (formal
  # or informal). Consult go/tq-wlan-metrics-maintenance for a list of all the
  # metric categories to faciliate this review.
  <<: &ga_release_metadata
    meta_data:
      max_release_stage: GA
      expiration_date: "2022/08/01"

##############################
### 9XX - Template definitions
##############################

# Setup for metrics that simply sum up the duration of all sessions, such as
# total device uptime or total WLAN-connected time. We mainly use this metric
# for the sum and count columns (to compute avg), which are highly aggregatable,
# hence we only generated one default report that has all the system profiles
# we need.
- id: 900
  metric_name: fleetwide_total_time_quality_metric_template
  <<: &fleetwide_total_time_quality_metric_template
    <<: &fleetwide_total_time_quality_metric_template__metric_portion
      metric_type: INTEGER
      metric_units: MICROSECONDS
      metric_semantics: [NETWORK_COMMUNICATION]
      <<: *ga_release_metadata
    reports:
      - &fleetwide_total_time_quality_metric_template__default_report_1
        report_name: fleetwide_hourly_local_sum
        id: 1
        report_type: HOURLY_VALUE_NUMERIC_STATS
        local_aggregation_procedure: SUM_PROCEDURE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 901
  metric_name: fleetwide_total_time_quality_metric_template__custom
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - id: 101
      report_name: fleetwide_hourly_local_sum__exp
      experiment_id: [12345678, 87654321]
      <<: &fleetwide_total_time_quality_metric_template__report_1_with_exp
        report_type: HOURLY_VALUE_NUMERIC_STATS
        local_aggregation_procedure: SUM_PROCEDURE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION, EXPERIMENT_IDS]

# Setup for metrics that simply log and sum up fleetwide occurrence. This
# metric is highly aggregatable, hence only one default report that has all
# the system profiles is needed.
- id: 902
  metric_name: total_occurrence_counts_template
  <<: &total_occurrence_counts_template
    <<: &total_occurrence_counts_template__metric_portion
      metric_type: OCCURRENCE
      metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
      <<: *ga_release_metadata
    reports:
      - &total_occurrence_counts_template__default_report_1
        id: 1
        report_name: fleetwide_occurrence_counts
        report_type: FLEETWIDE_OCCURRENCE_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 903
  metric_name: total_occurrence_counts_template__custom
  <<: *total_occurrence_counts_template__metric_portion
  reports:
    - *total_occurrence_counts_template__default_report_1
    - id: 101
      report_name: fleetwide_occurrence_counts__exp
      experiment_id: [12345678, 87654321]
      <<: &total_occurrence_counts_template__report_1_with_exp
        report_type: FLEETWIDE_OCCURRENCE_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION, EXPERIMENT_IDS]
    - id: 102
      report_name: device_daily_occurrence_histograms
      <<: &total_occurrence_counts_template__report_device_daily_occurrence_histograms
        report_type: UNIQUE_DEVICE_HISTOGRAMS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      int_buckets:
        linear:
          floor: 0
          num_buckets: 10
          step_size: 1


# Setup for metrics where a device computes a ratio per day and log that
# ratio before the end of the day. Only daily reports can be generated
# (no weekly or monthly reports) because those ratios are only computed
# for the days. Because the measure is not aggregatable, two reports
# are generated, one with system version and one without.
- id: 904
  metric_name: device_local_ratio_monitoring_metric_template
  <<: &device_log_local_ratio_once_daily_monitoring_metric_template
    <<: &device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
      metric_type: INTEGER
      metric_units_other: "TenThousandth"
      metric_semantics: [NETWORK_COMMUNICATION]
      <<: *ga_release_metadata
    reports:
      - &device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
        report_name: device_daily_local_avg_stats
        id: 1
        report_type: UNIQUE_DEVICE_NUMERIC_STATS
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: MEAN
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
        report_name: device_daily_local_avg_stats_system_ver
        id: 2
        report_type: UNIQUE_DEVICE_NUMERIC_STATS
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: MEAN
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 905
  metric_name: device_local_ratio_monitoring_metric_template__custom
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - id: 100
      report_name: device_daily_max_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 150
          step_size: 1000
      <<: &device_log_local_ratio_once_daily_monitoring_metric_template__report_device_daily_max_histograms
        report_type: UNIQUE_DEVICE_HISTOGRAMS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: MAX_PROCEDURE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
    - id: 101
      report_name: device_daily_local_avg_stats__exp
      experiment_id: [12345678, 87654321]
      <<: &device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
        report_type: UNIQUE_DEVICE_NUMERIC_STATS
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: MEAN
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, EXPERIMENT_IDS]
    - id: 102
      report_name: device_daily_local_avg_stats_system_ver__exp
      experiment_id: [12345678, 87654321]
      <<: &device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
        report_type: UNIQUE_DEVICE_NUMERIC_STATS
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: MEAN
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION, EXPERIMENT_IDS]

# Setup for metrics that count the number of devices where an event has
# occurred or a feature has been used at least once, or the device itself
# belongs to some category.
#
# Daily and weekly reports are generated. Additionally, for each aggregation
# period, reports with and without system version are generated. We did this
# because we previously thought that we would get duplicate count if we
# aggregate on system version and thus would need a separate report if we
# want device count without system version. This turns out to be untrue
# since Cobalt only generates one count per day, for the last system version.
- id: 906
  metric_name: device_counts_metric_template
  <<: &device_counts_metric_template
    <<: &device_counts_metric_template__metric_portion
      metric_type: OCCURRENCE
      metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
      <<: *ga_release_metadata
    reports:
      - &device_counts_metric_template__default_report_1
        id: 1
        <<: &device_daily_counts_at_least_once_report
          report_name: device_daily_counts_at_least_once
          report_type: UNIQUE_DEVICE_COUNTS
          system_profile_selection: SELECT_LAST
          local_aggregation_period: WINDOW_1_DAY
          local_aggregation_procedure: AT_LEAST_ONCE
          privacy_level: NO_ADDED_PRIVACY
          system_profile_field: [BOARD_NAME, CHANNEL]
      - &device_counts_metric_template__default_report_2
        id: 2
        report_name: device_daily_counts_at_least_once_system_ver
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      - &device_counts_metric_template__default_report_3
        id: 3
        report_name: device_weekly_counts_at_least_once
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &device_counts_metric_template__default_report_4
        id: 4
        report_name: device_weekly_counts_at_least_once_system_ver
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 907
  metric_name: device_counts_metric_template__custom
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - id: 102
      report_name: device_daily_counts_at_least_once_system_ver__exp
      experiment_id: [12345678, 87654321]
      <<: &device_counts_metric_template__report_2_with_exp
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION, EXPERIMENT_IDS]
    - id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__exp
      experiment_id: [12345678, 87654321]
      <<: &device_counts_metric_template__report_4_with_exp
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION, EXPERIMENT_IDS]

# Setup for metrics where a device computes a ratio per day and log an
# occurrence with that ratio as the dimension. Only daily reports can
# be generated (no weekly or monthly reports) because those ratios are
# only computed for the day. Because the measure is not aggregatable,
# two reports are generated, one with system version and one without.
#
# This template may be used with metric dimensions.
- id: 908
  metric_name: device_one_daily_occurrence_metric_template
  <<: &device_one_daily_occurrence_metric_template
    <<: &device_one_daily_occurrence_metric_template__metric_portion
      metric_type: OCCURRENCE
      metric_semantics: [NETWORK_COMMUNICATION]
      <<: *ga_release_metadata
    reports:
      - &device_one_daily_occurrence_metric_template__default_report_1
        report_name: device_daily_occurrence
        id: 1
        report_type: FLEETWIDE_OCCURRENCE_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &device_one_daily_occurrence_metric_template__default_report_2
        report_name: device_daily_occurrence_system_ver
        id: 2
        report_type: FLEETWIDE_OCCURRENCE_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 909
  metric_name: device_one_daily_occurrence_metric_template__custom
  <<: *device_one_daily_occurrence_metric_template__metric_portion
  reports:
    - *device_one_daily_occurrence_metric_template__default_report_1

# Setup for occurrence metrics with one or more dimensions, that produce not
# just FLEETWISE_OCCURRENCE_COUNTS report but also various device counts
# reports. Device counts reports are generated with the permutation of:
# - aggregration period: daily and weekly
# - local aggregration procedure: AT_LEAST_ONCE and SELECT_MOST_COMMON
# - system profile: with and without system version
#
# This template may be used with metric dimensions.
- id: 910
  metric_name: detailed_occurrence_metric_template
  <<: &detailed_occurrence_metric_template
    <<: &detailed_occurrence_metric_template__metric_portion
      metric_type: OCCURRENCE
      metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
      <<: *ga_release_metadata
    reports:
      - &detailed_occurrence_metric_template__default_report_1
        id: 1
        report_name: fleetwide_occurrence_counts
        report_type: FLEETWIDE_OCCURRENCE_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      - &detailed_occurrence_metric_template__default_report_10
        id: 10
        report_name: device_daily_counts_at_least_once
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &detailed_occurrence_metric_template__default_report_11
        id: 11
        report_name: device_daily_counts_at_least_once_system_ver
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      - &detailed_occurrence_metric_template__default_report_12
        id: 12
        report_name: device_daily_counts_most_common
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: SELECT_MOST_COMMON
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &detailed_occurrence_metric_template__default_report_13
        id: 13
        report_name: device_daily_counts_most_common_system_ver
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        local_aggregation_procedure: SELECT_MOST_COMMON
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      - &detailed_occurrence_metric_template__default_report_20
        id: 20
        report_name: device_weekly_counts_at_least_once
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &detailed_occurrence_metric_template__default_report_21
        id: 21
        report_name: device_weekly_counts_at_least_once_system_ver
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: AT_LEAST_ONCE
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      - &detailed_occurrence_metric_template__default_report_22
        id: 22
        report_name: device_weekly_counts_most_common
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: SELECT_MOST_COMMON
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &detailed_occurrence_metric_template__default_report_23
        id: 23
        report_name: device_weekly_counts_most_common_system_ver
        report_type: UNIQUE_DEVICE_COUNTS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_7_DAYS
        local_aggregation_procedure: SELECT_MOST_COMMON
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 911
  metric_name: detailed_occurrence_metric_template__custom
  <<: *detailed_occurrence_metric_template__metric_portion
  reports:
    - *detailed_occurrence_metric_template__default_report_1

# Setup for string metrics that simply sum up how often each string happens.
# This metric is highly aggregatable, hence only one report that has all
# the system profiles is needed.
- id: 912
  metric_name: fleetwide_string_counts_metric_template
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: &fleetwide_string_counts_metric_template
    <<: &fleetwide_string_counts_metric_template__metric_portion
      metric_type: STRING
      metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
      <<: *ga_release_metadata
    reports:
      - &fleetwide_string_counts_metric_template__default_report_1
        report_name: string_counts
        id: 1
        report_type: STRING_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        string_buffer_max: 20
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 913
  metric_name: fleetwide_string_counts_metric_template__custom
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: *fleetwide_string_counts_metric_template__metric_portion
  reports:
    - *fleetwide_string_counts_metric_template__default_report_1

# Setup that imitates UNIQUE_DEVICE_COUNTS local aggregation for string
# metric, by logging only once. As such, two reports are generated, one
# with system version and one without, because device count metrics are
# not aggregatable across system version.
# TODO(fxbug.dev/98997): remove this metric with report type
# STRING_COUNTS, once the metric using UNIQUE_DEVICE_STRING_COUNTS
# reports is verified.
- id: 914
  metric_name: log_string_once_metric_template
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: &log_once_per_string_daily_string_counts_metric_template
    <<: &log_once_per_string_daily_string_counts_metric_template__metric_portion
      metric_type: STRING
      metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
      <<: *ga_release_metadata
    reports:
      - &log_once_per_string_daily_string_counts_metric_template__default_report_1
        report_name: device_daily_string_counts
        id: 1
        report_type: STRING_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        string_buffer_max: 20
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &log_once_per_string_daily_string_counts_metric_template__default_report_2
        report_name: device_daily_string_counts_system_ver
        id: 2
        report_type: STRING_COUNTS
        privacy_level: NO_ADDED_PRIVACY
        string_buffer_max: 20
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
# TODO(fxbug.dev/98997): remove this metric with report type
# STRING_COUNTS, once the metric using UNIQUE_DEVICE_STRING_COUNTS
# reports is verified.
- id: 915
  metric_name: log_string_once_metric_template__custom
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: *log_once_per_string_daily_string_counts_metric_template__metric_portion
  reports:
    - *log_once_per_string_daily_string_counts_metric_template__default_report_1

# Setup for string metrics that uses UNIQUE_DEVICE_STRING_COUNTS to count
# strings only once per device per day. As such, two reports are
# generated, one with system version and one without, because device count
# metrics are not aggregatable across system version.
- id: 916
  metric_name: device_string_counts_metric_template
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: &device_string_counts_metric_template
    <<: &device_string_counts_metric_template__metric_portion
      metric_type: STRING
      metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
      <<: *ga_release_metadata
    reports:
      - &device_string_counts_metric_template__default_report_1
        report_name: device_daily_string_counts
        id: 1
        report_type: UNIQUE_DEVICE_STRING_COUNTS
        system_profile_selection: SELECT_LAST
        privacy_level: NO_ADDED_PRIVACY
        string_buffer_max: 20
        local_aggregation_period: WINDOW_1_DAY
        system_profile_field: [BOARD_NAME, CHANNEL]
      - &device_string_counts_metric_template__default_report_2
        report_name: device_daily_string_counts_system_ver
        id: 2
        report_type: UNIQUE_DEVICE_STRING_COUNTS
        system_profile_selection: SELECT_LAST
        privacy_level: NO_ADDED_PRIVACY
        string_buffer_max: 20
        local_aggregation_period: WINDOW_1_DAY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]

# Example of how to use above metric's smaller anchors together.
# This is also a placeholder where additional compatible reports can be defined
# and reused.
- id: 917
  metric_name: device_string_counts_metric_template__custom
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: *device_string_counts_metric_template__metric_portion
  reports:
    - *device_string_counts_metric_template__default_report_1

##########################
### 1XXX - Quality metrics
##########################

################################################################################
# Total WLAN uptime near saved network
#
# Periodically, log the amount of time that WLAN has been connected or is
# attempting to reconnect while a saved network is nearby.
#
# NOTE: This metric is used as the denominator for the percentage of connected
#       uptime, so make sure it has the same columns as the connected uptime
#       metric.
################################################################################
- id: 1000
  metric_name: total_wlan_uptime_near_saved_network
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: &ps_exp_ids [49331091, 49331092, 49331142, 49331143, 49331144]

################################################################################
# Total amount of time that the client is connected
#
# Periodically, log the amount of time that the client has been connected to
# an AP.
#
# NOTE: This is used as the denominator for many other metrics (for example,
#       disconnects per day connected), so make sure it has the same columns
#       as the metrics that use this as the denominator.
################################################################################
- id: 1001
  metric_name: total_connected_uptime
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Total number of disconnects
#
# Whenever a client has disconnected from an AP, log the occurrence.
################################################################################
- id: 1002
  metric_name: total_disconnect_count
  <<: *total_occurrence_counts_template__metric_portion
  reports:
    - *total_occurrence_counts_template__default_report_1
    - <<: *total_occurrence_counts_template__report_1_with_exp
      id: 101
      report_name: fleetwide_occurrence_counts__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time with high RX packet drop
#
# Periodically while a client is connected, log the amount of time when the
# client has had high RX packet drop.
################################################################################
- id: 1003
  metric_name: total_time_with_high_rx_packet_drop
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time with high TX packet drop
#
# Periodically while a client is connected, log the amount of time when the
# client has had high TX packet drop.
################################################################################
- id: 1004
  metric_name: total_time_with_high_tx_packet_drop
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time with no RX
#
# Periodically while a client is connected, log the amount of time when the
# client has had no RX.
################################################################################
- id: 1005
  metric_name: total_time_with_no_rx
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time with very high RX packet drop
#
# Periodically while a client is connected, log the amount of time when the
# client has had very high RX packet drop.
################################################################################
- id: 1006
  metric_name: total_time_with_very_high_rx_packet_drop
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time with very high TX packet drop
#
# Periodically while a client is connected, log the amount of time when the
# client has had very high TX packet drop.
################################################################################
- id: 1007
  metric_name: total_time_with_very_high_tx_packet_drop
  <<: *fleetwide_total_time_quality_metric_template__metric_portion
  reports:
    - *fleetwide_total_time_quality_metric_template__default_report_1
    - <<: *fleetwide_total_time_quality_metric_template__report_1_with_exp
      id: 101
      report_name: fleetwide_hourly_local_sum__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Total number of roaming disconnects
#
# Whenever a client has disconnected from an AP to roam, log the occurrence.
################################################################################
- id: 1008
  metric_name: total_roaming_disconnect_count
  <<: *total_occurrence_counts_template__metric_portion
  reports:
    - *total_occurrence_counts_template__default_report_1
    - <<: *total_occurrence_counts_template__report_1_with_exp
      id: 101
      report_name: fleetwide_occurrence_counts__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Total number of non-roaming disconnects
#
# Whenever a client has disconnected from an AP because of a lost connection,
# log the occurrence. These are the disconnects that don't happen for roaming
# and exclude manual user interactions.
################################################################################
- id: 1009
  metric_name: total_non_roaming_disconnect_count
  <<: *total_occurrence_counts_template__metric_portion
  reports:
    - *total_occurrence_counts_template__default_report_1
    - <<: *total_occurrence_counts_template__report_1_with_exp
      id: 101
      report_name: fleetwide_occurrence_counts__ps_exp
      experiment_id: *ps_exp_ids

#############################
### 2XXX - Monitoring metrics
#############################

################################################################################
# Connected uptime ratio
#
# Every day, before the end of the day UTC time, log the connected uptime ratio
# for that day (time connected / WLAN uptime near saved network).
################################################################################
- id: 2000
  metric_name: connected_uptime_ratio
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Disconnect per day connected
#
# Every day, before the end of the day UTC time, log the disconnect per day
# connected ratio for that day (# of disconnects / time connected in day).
################################################################################
- id: 2001
  metric_name: disconnect_per_day_connected
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_device_daily_max_histograms
      id: 100
      report_name: device_daily_max_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 150
          step_size: 1000  # Each bucket is 0.1 ratio
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time ratio with high RX packet drop
#
# Every day, before the end of the day UTC time, log the time ratio with high
# RX packet drop for that day (time with high packet drop / time connected)
################################################################################
- id: 2002
  metric_name: time_ratio_with_high_rx_packet_drop
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time ratio with high TX packet drop
#
# Every day, before the end of the day UTC time, log the time ratio with high
# TX packet drop for that day (time with high packet drop / time connected)
################################################################################
- id: 2003
  metric_name: time_ratio_with_high_tx_packet_drop
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time ratio with no RX
#
# Every day, before the end of the day UTC time, log the time ratio with no RX
# for that day (time with high packet loss / time connected)
################################################################################
- id: 2004
  metric_name: time_ratio_with_no_rx
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Connection success rate
#
# Every day, log connection success rate of the device on that day
################################################################################
- id: 2005
  metric_name: connection_success_rate
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time ratio with very high RX packet drop
#
# Every day, before the end of the day UTC time, log the time ratio with very
# high RX packet drop for that day
# (time with very high packet drop / time connected)
################################################################################
- id: 2006
  metric_name: time_ratio_with_very_high_rx_packet_drop
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Time ratio with very high TX packet drop
#
# Every day, before the end of the day UTC time, log the time ratio with very
# high TX packet drop for that day
# (time with very high packet drop / time connected)
################################################################################
- id: 2007
  metric_name: time_ratio_with_very_high_tx_packet_drop
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Roaming disconnect per day connected
#
# Every day, before the end of the day UTC time, log the roaming disconnect per
# day connected ratio for that day (# of roaming disconnects / time connected
# in day). Roaming disconnects happen when the device decides to proactively
# leave to join another network.
################################################################################
- id: 2008
  metric_name: roaming_disconnect_per_day_connected
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Non roaming disconnect per day connected
#
# Every day, before the end of the day UTC time, log the non-roaming disconnect
# per day connected ratio for that day (# of non-roaming disconnects / time
# connected in day). Non roaming disconnects do not include disconnects from
# manual user actions, since they are not useful for comparing to the number of
# roaming disconnects.
################################################################################
- id: 2009
  metric_name: non_roaming_disconnect_per_day_connected
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Disconnect per day connected
#
# Every day, before the end of the day UTC time, log the disconnect per day
# connected ratio for that day (# of disconnects / time connected in day).
################################################################################
- id: 2010
  metric_name: disconnect_per_day_connected_7d
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_2
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_device_daily_max_histograms
      id: 100
      report_name: device_daily_max_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 150
          step_size: 1000  # Each bucket is 0.1 ratio
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_1_with_exp
      id: 101
      report_name: device_daily_local_avg_stats__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_local_avg_stats_system_ver__ps_exp
      experiment_id: *ps_exp_ids

#############################################
### 3XXX - Monitoring metrics (device counts)
#############################################

################################################################################
# Count of devices with low uptime
#
# Every day, log a count if a device has low uptime on that day.
################################################################################
- id: 3000
  metric_name: device_with_low_uptime
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with high disconnect rate
#
# Every day, log a count if a device has high disconnect rate on that day.
################################################################################
- id: 3001
  metric_name: device_with_high_disconnect_rate
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with high avg time to connect
#
# Every day, log a count if a device has high avg time to connect.
################################################################################
- id: 3002
  metric_name: device_with_high_avg_time_to_connect
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with frequent high RX packet drop
#
# Every day, log a count if a device has frequent high RX packet drop.
################################################################################
- id: 3003
  metric_name: device_with_frequent_high_rx_packet_drop
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with frequent high TX packet drop
#
# Every day, log a count if a device has frequent high TX packet drop.
################################################################################
- id: 3004
  metric_name: device_with_frequent_high_tx_packet_drop
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with frequent no RX
#
# Every day, log a count if a device frequently has no RX.
################################################################################
- id: 3005
  metric_name: device_with_frequent_no_rx
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with low connection success rate
#
# Every day, log a count if the device has low connection success rate.
################################################################################
- id: 3006
  metric_name: device_with_low_connection_success_rate
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with frequent very high RX packet drop
#
# Every day, log a count if a device has frequent very high RX packet drop.
################################################################################
- id: 3007
  metric_name: device_with_frequent_very_high_rx_packet_drop
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with frequent very high TX packet drop
#
# Every day, log a count if a device has frequent very high TX packet drop.
################################################################################
- id: 3008
  metric_name: device_with_frequent_very_high_tx_packet_drop
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with high roaming disconnect rate
#
# Every day, log a count if a device has high roam disconnect rate on that day.
################################################################################
- id: 3009
  metric_name: device_with_high_roaming_disconnect_rate
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

################################################################################
# Count of devices with high disconnect rate
#
# Every day, log a count if a device has high disconnect rate from non-roaming
# disconnects on that day. This does not include disconnects that happen from
# manual user interactions such as stopping all client connections.
################################################################################
- id: 3010
  metric_name: device_with_high_non_roaming_disconnect_rate
  <<: *device_counts_metric_template__metric_portion
  reports:
    - *device_counts_metric_template__default_report_1
    - *device_counts_metric_template__default_report_2
    - *device_counts_metric_template__default_report_3
    - *device_counts_metric_template__default_report_4
    - <<: *device_counts_metric_template__report_2_with_exp
      id: 102
      report_name: device_daily_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids
    - <<: *device_counts_metric_template__report_4_with_exp
      id: 104
      report_name: device_weekly_counts_at_least_once_system_ver__ps_exp
      experiment_id: *ps_exp_ids

#############################################
### 4XXX - Statistics metrics (WLAN area)
#############################################

################################################################################
# Device connected uptime ratio breakdown
#
# Every day, before the end of the day UTC time, compute the connected uptime
# ratio for that day (time connected / WLAN uptime near saved network), and log
# an occurrence with the appropriate dimension.
################################################################################
- id: 4000
  metric_name: device_connected_uptime_ratio_breakdown
  metric_dimensions:
    - dimension: UptimeRatio
      event_codes:
        1: LessThan75Percent
        2: 75ToLessThan90Percent
        3: 90ToLessThan95Percent
        4: 95ToLessThan98Percent
        5: 98ToLessThan99Percent
        6: 99ToLessThan99.5Percent
        7: 99.5To100Percent
  <<: *device_one_daily_occurrence_metric_template

################################################################################
# Device disconnects per day connected breakdown
#
# Every day, before the end of the day UTC time, compute the disconnect per day
# connected ratio for that day (# of disconnects / time connected in day), and
# log an occurrence with the appropriate dimension.
################################################################################
- <<: *device_one_daily_occurrence_metric_template
  id: 4001
  metric_name: device_disconnect_per_day_connected_breakdown
  metric_dimensions:
    - dimension: DpdcRatio
      event_codes:
        1: "0"
        2: UpTo1.5
        3: UpTo3
        4: UpTo5
        5: UpTo10
        6: MoreThan10

################################################################################
# Device disconnects per day connected breakdown weekly
#
# Every day, before the end of the day UTC time, compute the disconnect per day
# connected ratio for up to the last 7 days, and log an occurrence with the
# appropriate dimension.
################################################################################
- <<: *device_one_daily_occurrence_metric_template
  id: 4002
  metric_name: device_disconnect_per_day_connected_breakdown_7d
  metric_dimensions:
    - dimension: DpdcRatio
      event_codes:
        1: "0"
        2: UpTo0.2
        3: UpTo0.35
        4: UpTo0.5
        5: UpTo1
        6: UpTo5
        7: MoreThan5

################################################################################
# Disconnect breakdown by device uptime
#
# When a client has disconnected from an AP, log an occurrence along with a
# dimension based on how long the device has been up.
################################################################################
- id: 4003
  metric_name: disconnect_breakdown_by_device_uptime
  metric_dimensions:
    - dimension: DeviceUptime
      event_codes:
        1: LessThan1Hour
        2: LessThan3Hours
        3: LessThan12Hours
        4: LessThan1Day
        5: LessThan2Days
        6: AtLeast2Days
  <<: *detailed_occurrence_metric_template

################################################################################
# Disconnect breakdown by connected duration
#
# When a client has disconnected from an AP, log an occurrence along with a
# dimension based on how long the connected session has been.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4004
  metric_name: disconnect_breakdown_by_connected_duration
  metric_dimensions:
    - dimension: connected_duration
      event_codes:
        1: LessThan30Seconds
        2: LessThan5Minutes
        3: LessThan1Hour
        4: LessThan6Hours
        5: LessThan24Hours
        6: AtLeast24Hours

################################################################################
# Disconnect breakdown by reason code
#
# Whenever client sees a disconnect, log the reason code and its source.
#
# Replacement for metric 400, but logged in Policy instead of wlanstack.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4005
  metric_name: disconnect_breakdown_by_reason_code
  metric_dimensions:
    - *disconnect_reasons_dim
    - *disconnect_sources_dim

################################################################################
# Disconnect breakdown by primary channel
#
# Whenever client sees a disconnect, log the primary channel.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4006
  metric_name: disconnect_breakdown_by_primary_channel
  metric_dimensions:
    - &primary_channel_dim
      dimension: primary_channel
      max_event_code: 196

################################################################################
# Downtime breakdown by disconnect reason
#
# When a client reconnects, compute the downtime since the previous
# disconnection. Log the downtime with the dimension based on the previous
# disconnect reason code.
################################################################################
- id: 4007
  metric_name: downtime_breakdown_by_disconnect_reason
  metric_type: INTEGER
  metric_units: MICROSECONDS
  metric_semantics: [NETWORK_COMMUNICATION, LATENCY]
  metric_dimensions:
    - *disconnect_reasons_dim
    - *disconnect_sources_dim
  reports:
    - report_name: fleetwide_means
      id: 1
      report_type: FLEETWIDE_MEANS
      privacy_level: NO_ADDED_PRIVACY
      system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
  <<: *ga_release_metadata

################################################################################
# Connect attempt breakdown by status code
#
# When a client makes a connection attempt, log the status code.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4008
  metric_name: connect_attempt_breakdown_by_status_code
  metric_dimensions:
    - &status_code_dim
      dimension: status_code
      max_event_code: 1000

################################################################################
# Connect attempt on normal device breakdown by status code
#
# Once each day, check if the device has normal connection success rate. If it
# does, log all the status code of all the connection attempts it has made
# that day.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4009
  metric_name: connect_attempt_on_normal_device_breakdown_by_status_code
  metric_dimensions:
    - *status_code_dim

################################################################################
# Connect attempt on bad device breakdown by status code
#
# Once each day, check if the device has low connection success rate. If it
# does, log all the status code of all the connection attempts it has made
# that day.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4010
  metric_name: connect_attempt_on_bad_device_breakdown_by_status_code
  metric_dimensions:
    - *status_code_dim

################################################################################
# Successful connect breakdown by user wait time
#
# On connect success, log the duration the user has waited, including the
# time of network selection and all the retries.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4011
  metric_name: successful_connect_breakdown_by_user_wait_time
  metric_dimensions:
    - dimension: wait_time
      event_codes:
        1: LessThan1Second
        2: LessThan3Seconds
        3: LessThan5Seconds
        4: LessThan8Seconds
        5: LessThan15Seconds
        6: AtLeast15Seconds

################################################################################
# Successful connect breakdown by is_multi_bss
#
# On connect success, log whether there are multiple BSS in the ESS.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4012
  metric_name: successful_connect_breakdown_by_is_multi_bss
  metric_dimensions:
    - &is_multi_bss_dim
      dimension: is_multi_bss
      event_codes:
        1: "Yes"
        2: "No"

################################################################################
# Successful connect breakdown by BSS security type
#
# On connect success, log the security type of the BSS.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4013
  metric_name: successful_connect_breakdown_by_security_type
  metric_dimensions:
    - &security_type_dim
      dimension: security_type
      event_codes: *protections

################################################################################
# Successful connect breakdown by WLAN primary channel
#
# On connect success, log the WLAN primary channel.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4014
  metric_name: successful_connect_breakdown_by_primary_channel
  metric_dimensions:
    - *primary_channel_dim

################################################################################
# Successful connect breakdown by WLAN channel band
#
# On connect success, log the WLAN channel band.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4015
  metric_name: successful_connect_breakdown_by_channel_band
  metric_dimensions:
    - &channel_band_dim
      dimension: channel_band
      event_codes:
        1: Band2Dot4Ghz
        2: Band5Ghz

################################################################################
# Successful connect breakdown by RSSI bucket
#
# On connect success, log the RSSI bucket.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4016
  metric_name: successful_connect_breakdown_by_rssi_bucket
  metric_dimensions:
    - &rssi_bucket_dim
      dimension: rssi_bucket
      event_codes:
        1: From128To90
        2: From89To86
        3: From85To83
        4: From82To80
        5: From79To77
        6: From76To74
        7: From73To71
        8: From70To66
        9: From65To61
        10: From60To51
        11: From50To35
        # RSSI greater than -35dBm is considered too strong, which degrades
        # throughput performance:
        # https://helpcenter.engeniustech.com/hc/en-us/articles/360015304031-Outdoor-RSSI-and-Acceptable-Signal-Strength
        12: From34To28
        13: From27To1
        14: "0"

################################################################################
# Successful connect breakdown by SNR bucket
#
# On connect success, log the SNR bucket.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4017
  metric_name: successful_connect_breakdown_by_snr_bucket
  metric_dimensions:
    - &snr_bucket_dim
      dimension: snr_bucket
      event_codes:
        1: "0"
        2: From1To10
        3: From11To15
        4: From16To25
        5: From26To40
        6: MoreThan40

################################################################################
# Connect success rate per day breakdown by is_multi_bss
#
# Every day, separately compute the device's daily connect success rate on
# networks that have multiple BSS and networks that have single BSS. Log a
# number for each dimension
################################################################################
- <<: *device_log_local_ratio_once_daily_monitoring_metric_template
  id: 4018
  metric_name: daily_connect_success_rate_breakdown_by_is_multi_bss
  metric_dimensions:
    - *is_multi_bss_dim

################################################################################
# Connect success rate per day breakdown by security type
#
# Every day, separately compute the device's daily connect success rate for
# each security type of encountered networks. Log a number for each dimension
################################################################################
- <<: *device_log_local_ratio_once_daily_monitoring_metric_template
  id: 4019
  metric_name: daily_connect_success_rate_breakdown_by_security_type
  metric_dimensions:
    - *security_type_dim

################################################################################
# Connect success rate per day breakdown by primary channel
#
# Every day, separately compute the device's daily connect success rate for
# each primary channel of encountered networks. Log a number for each dimension
################################################################################
- <<: *device_log_local_ratio_once_daily_monitoring_metric_template
  id: 4020
  metric_name: daily_connect_success_rate_breakdown_by_primary_channel
  metric_dimensions:
    - *primary_channel_dim

################################################################################
# Connect success rate per day breakdown by channel band
#
# Every day, separately compute the device's daily connect success rate for
# each channel band of encountered networks. Log a number for each dimension
################################################################################
- <<: *device_log_local_ratio_once_daily_monitoring_metric_template
  id: 4021
  metric_name: daily_connect_success_rate_breakdown_by_channel_band
  metric_dimensions:
    - *channel_band_dim

################################################################################
# Connect success rate per day breakdown by rssi bucket
#
# Every day, separately compute the device's daily connect success rate for
# each rssi bucket of encountered networks. Log a number for each dimension
################################################################################
- <<: *device_log_local_ratio_once_daily_monitoring_metric_template
  id: 4022
  metric_name: daily_connect_success_rate_breakdown_by_rssi_bucket
  metric_dimensions:
    - *rssi_bucket_dim

################################################################################
# Connect success rate per day breakdown by snr bucket
#
# Every day, separately compute the device's daily connect success rate for
# each snr bucket of encountered networks. Log a number for each dimension
################################################################################
- <<: *device_log_local_ratio_once_daily_monitoring_metric_template
  id: 4023
  metric_name: daily_connect_success_rate_breakdown_by_snr_bucket
  metric_dimensions:
    - *snr_bucket_dim

################################################################################
# Successful connect per OUI
#
# On connect success, log the OUI.
################################################################################
- id: 4024
  metric_name: successful_connect_per_oui
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: *fleetwide_string_counts_metric_template

################################################################################
# Reconnect breakdown by duration
#
# On reconnect, log an occurrence, with breakdown on how long the reconnect
# takes.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4025
  metric_name: reconnect_breakdown_by_duration
  metric_dimensions:
    - dimension: reconnect_duration
      event_codes:
        1: LessThan100Milliseconds
        2: LessThan1Second
        3: LessThan5Seconds
        4: LessThan30Seconds
        5: AtLeast30Seconds

################################################################################
# Roaming scans per day
#
# Log when policy decides to perform a scan to look for networks to roam to.
# Report how many of these scans devices do each day.
################################################################################
- id: 4026
  metric_name: policy_proactive_roaming_scan_counts
  metric_type: OCCURRENCE
  metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
  reports:
    - id: 1
      # Use this name if there is only one such report for the metric.
      <<: &default_device_daily_occurrence_histograms_report_name
        report_name: device_daily_occurrence_histograms
      <<: &device_daily_histograms_report
        report_type: UNIQUE_DEVICE_HISTOGRAMS
        system_profile_selection: SELECT_LAST
        local_aggregation_period: WINDOW_1_DAY
        privacy_level: NO_ADDED_PRIVACY
        system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
      int_buckets:
        linear:
          floor: 0
          num_buckets: 150
          step_size: 1
  <<: *ga_release_metadata

################################################################################
# Roaming proactive network switches per day
#
# Log when a device decides to leave the current AP and attempt to connect to
# another one. Report how many times each device does this each day.
################################################################################
- id: 4027
  metric_name: network_roaming_disconnect_counts
  <<: &disconnect_counts_metric
    metric_type: OCCURRENCE
    metric_semantics: [NETWORK_COMMUNICATION, USAGE_COUNTING]
    reports:
      - id: 1
        <<: *default_device_daily_occurrence_histograms_report_name
        <<: *device_daily_histograms_report
        int_buckets:
          linear:
            floor: 0
            num_buckets: 24
            step_size: 1
    <<: *ga_release_metadata

################################################################################
# Non-roaming disconnects per day
#
# Log when a device disconnects, but not because of roaming. This does not
# include disconnects from a user forgetting a network or manually connecting
# to a new one.
################################################################################
- id: 4028
  metric_name: network_non_roaming_disconnect_counts
  <<: *disconnect_counts_metric

################################################################################
# All disconnects per day
#
# Log when a device disconnects for any reason. The histogram buckets match
# roaming disconnect counts so that the numbers can be compared.
################################################################################
- id: 4029
  metric_name: network_disconnect_counts
  <<: *disconnect_counts_metric

################################################################################
# Connection uptime before roam
#
# When a decision to roam happens, log how long the current connection has been
# up. The unit for the metric is in minutes. The range of recorded time is
# 0 - 6 hours.
################################################################################
- id: 4030
  metric_name: connected_duration_before_roaming_disconnect
  <<: &connected_duration_before_disconnect_metric
    metric_type: INTEGER
    metric_units: MINUTES
    metric_semantics: [NETWORK_COMMUNICATION]
    reports:
      - id: 1
        <<: &default_fleetwide_histograms_report_name
          report_name: fleetwide_histograms
        <<: &fleetwide_histograms_report
          report_type: FLEETWIDE_HISTOGRAMS
          privacy_level: NO_ADDED_PRIVACY
          system_profile_field: [BOARD_NAME, CHANNEL, SYSTEM_VERSION]
        int_buckets:
          linear:
            floor: 0
            num_buckets: 360
            step_size: 1
    <<: *ga_release_metadata

################################################################################
# Connection uptime before non-roam disconnect
#
# When a disconnect happens, log how long the current connection has been up.
# The unit for the metric is in minutes. The recorded duration buckets match
# the ones used for roam connected durations in order to compare the two.
################################################################################
- id: 4031
  metric_name: connected_duration_before_non_roaming_disconnect
  <<: *connected_duration_before_disconnect_metric

################################################################################
# Connection uptime before disconnect
#
# When any disconnect happens, log how long the current connection has been up.
################################################################################
- id: 4032
  metric_name: connected_duration_before_disconnect
  <<: *connected_duration_before_disconnect_metric

################################################################################
# Connection RSSI values
#
# The RSSI values of the AP that the device is connected to. This RSSI value is
# collected every second and all collected values are aggregated as a histogram
# and periodically sent to cobalt. The values are reported for the entire fleet
# in order to get an idea of the signal strength of the fleet's connections and
# see whether changes cause general improvements or worsening of signal
# strength of the networks chosen by devices.
################################################################################
- id: 4033
  metric_name: connection_rssi
  metric_type: INTEGER_HISTOGRAM
  metric_units_other: "dBm"
  metric_semantics: [NETWORK_COMMUNICATION]
  int_buckets:
    linear:
      floor: -128
      num_buckets: 129
      step_size: 1
  reports:
    - id: 1
      <<: *default_fleetwide_histograms_report_name
      <<: *fleetwide_histograms_report
  <<: *ga_release_metadata

################################################################################
# RSSI velocity
#
# RSSI velocity, or change in RSSI per second, is estimated for the current
# connection based on regular RSSI readings. The unit of RSSI velocity is dBm/s
# and will be converted to dBm/s even if the interval used to calculate RSSI
# velocity isn't 1 second.
################################################################################
- id: 4034
  metric_name: rssi_velocity
  metric_type: INTEGER_HISTOGRAM
  metric_units_other: "dBm/s"
  metric_semantics: [NETWORK_COMMUNICATION]
  int_buckets:
    linear:
      floor: -10
      num_buckets: 21
      step_size: 1
  reports:
    - id: 1
      <<: *default_fleetwide_histograms_report_name
      <<: *fleetwide_histograms_report
  <<: *ga_release_metadata

################################################################################
# Roaming reconnect time
#
# Log how long it takes to reconnect to the new network after disconnecting
# from the previous network when roaming. The time is logged in microseconds,
# up to 60 seconds with .1 second histogram buckets.
################################################################################
- id: 4035
  metric_name: roaming_reconnect_duration
  metric_type: INTEGER
  metric_units: MICROSECONDS
  metric_semantics: [NETWORK_COMMUNICATION]
  reports:
    - id: 1
      <<: *default_fleetwide_histograms_report_name
      <<: *fleetwide_histograms_report
      int_buckets:
        linear:
          floor: 0
          num_buckets: 600
          step_size: 100000
  <<: *ga_release_metadata

################################################################################
# Non roaming reconnect time
#
# Log how long it takes to connect after a disconnect that didn't happen for
# roaming. This metric matches roaming reconnect time so that the two can
# be compared. Non roaming disconnects include loss of signal or the AP ending
# the connection. The time is logged in microseconds, up to 60 seconds with .1
# second histogram buckets.
################################################################################
- id: 4036
  metric_name: non_roaming_reconnect_duration
  metric_type: INTEGER
  metric_units: MICROSECONDS
  metric_semantics: [NETWORK_COMMUNICATION]
  reports:
    - id: 1
      <<: *default_fleetwide_histograms_report_name
      <<: *fleetwide_histograms_report
      int_buckets:
        linear:
          floor: 0
          num_buckets: 600
          step_size: 100000
  <<: *ga_release_metadata

################################################################################
# Disconnect breakdown by channel band
#
# Whenever client sees a disconnect, log the channel band.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4037
  metric_name: disconnect_breakdown_by_channel_band
  metric_dimensions:
    - *channel_band_dim

################################################################################
# Disconnect breakdown by is_multi_bss
#
# Whenever client sees a disconnect, log whether the network had multiple BSS.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4038
  metric_name: disconnect_breakdown_by_is_multi_bss
  metric_dimensions:
    - *is_multi_bss_dim

################################################################################
# Disconnect breakdown by security type
#
# Whenever client sees a disconnect, log the security type.
################################################################################
- <<: *detailed_occurrence_metric_template
  id: 4039
  metric_name: disconnect_breakdown_by_security_type
  metric_dimensions:
    - *security_type_dim

################################################################################
# WLAN user restart counts
#
# Whenever a user quickly stops and starts client connections, log an
# occurrence. Users often toggle WLAN when something is not working well, so
# this indicates something may be wrong.
################################################################################
- id: 4040
  metric_name: client_connections_stop_and_start
  <<: *total_occurrence_counts_template__metric_portion
  reports:
    - id: 1
      report_name: device_daily_occurrence_histograms
      <<: *total_occurrence_counts_template__report_device_daily_occurrence_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 10
          step_size: 1

################################################################################
# WLAN manual network change counts
#
# Whenever already has a client connection and a user manually connects to a
# different network, log an occurrence. Switching to another network manually
# may indicate that the user thought something was wrong with the previous
# network or new network is better and WLAN should have proactively switched to
# that network.
################################################################################
- id: 4041
  metric_name: manual_network_change
  <<: *total_occurrence_counts_template__metric_portion
  reports:
    - id: 1
      report_name: device_daily_occurrence_histograms
      <<: *total_occurrence_counts_template__report_device_daily_occurrence_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 10
          step_size: 1

################################################################################
# Percent good roams
#
# Once a day, if the device has roamed at all log what percent of roams that
# happen on the device result in a good network connection. A good connection
# is considered one that we wouldn't roam away from soon after connecting.
################################################################################
- id: 4042
  metric_name: percent_good_roams
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - id: 101
      report_name: device_daily_max_histograms
      <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_device_daily_max_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 101
          ## The unit is TenThousandths, so each bucket is .01 to represent 1%.
          step_size: 100

################################################################################
# Percent good roams out of 5+
#
# Once a day, if the device has roamed at least 5 times, log what percent of
# roams that happen on the device result in a good network connection.
################################################################################
- id: 4043
  metric_name: percent_good_roams_at_least_five_roams
  <<: *device_log_local_ratio_once_daily_monitoring_metric_template__metric_portion
  reports:
    - *device_log_local_ratio_once_daily_monitoring_metric_template__default_report_1
    - id: 101
      report_name: device_daily_max_histograms
      <<: *device_log_local_ratio_once_daily_monitoring_metric_template__report_device_daily_max_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 101
          ## The unit is TenThousandths, so each bucket is .01 to represent 1%.
          step_size: 100


################################################################################
# Roam to insufficient network
#
# When a roam happens to a network that has an issue soon after connecting, log
# an occurrence. The issues correspond to reasons that WLAN would roam away
# from a network, such as bad or worsening signal or insufficient network speed,
# plus whether there was a non-user, non-roaming disconnect soon after
# connecting.
################################################################################
- id: 4044
  metric_name: roam_to_insufficent_network_issue_counts
  <<: *total_occurrence_counts_template__metric_portion
  metric_dimensions:
    - dimension: has_insufficient_signal
      event_codes: *yes_no
    - dimension: has_insufficient_data_rate
      event_codes: *yes_no
    - dimension: disconnect
      event_codes: *yes_no
    - dimension: imminent_disconnect
      event_codes: *yes_no
  reports:
    - *total_occurrence_counts_template__default_report_1
    # Counts per device can be used for a more detailed view when there is a
    # change in the total count report for a combination of dimensions (ie for
    # report 1). For example there could be a few devices heavily affected, or
    # many devices slightly affected.
    - id: 101
      report_name: device_daily_occurrence_histograms
      <<: *total_occurrence_counts_template__report_device_daily_occurrence_histograms
      int_buckets:
        linear:
          floor: 0
          num_buckets: 10
          step_size: 1

##################################################
### 5XXX - Statistics metrics (Usage distribution)
##################################################

################################################################################
# Number of WiFi-connected devices
#
# When a client connects to an AP, log the occurrence. Every day, if the
# client is still connected, log at least one occurrence.
#
# The resulting report is the number of connected device.
################################################################################
- <<: *device_counts_metric_template
  id: 5000
  metric_name: number_of_connected_devices

################################################################################
# Device connected to AP with security type
#
# When a client connects to an AP, log the security type of that network.
# Every day, if the client is still connected, log at least one occurrence.
################################################################################
- <<: *device_counts_metric_template
  id: 5001
  metric_name: connected_network_security_type
  metric_dimensions:
    - *security_type_dim

################################################################################
# Device connected to an AP that supports APSD
################################################################################
- <<: *device_counts_metric_template
  id: 5002
  metric_name: device_connected_to_ap_that_supports_apsd

################################################################################
# Device connected to an AP that supports Link Measurement subfeature from
# 802.11k
################################################################################
- <<: *device_counts_metric_template
  id: 5003
  metric_name: device_connected_to_ap_that_supports_link_measurement

################################################################################
# Device connected to an AP that supports Neighbor Report subfeature from
# 802.11k
################################################################################
- <<: *device_counts_metric_template
  id: 5004
  metric_name: device_connected_to_ap_that_supports_neighbor_report

################################################################################
# Device connected to an AP that supports Fast Transition (802.11r)
################################################################################
- <<: *device_counts_metric_template
  id: 5005
  metric_name: device_connected_to_ap_that_supports_ft

################################################################################
# Device connected to an AP that supports BSS transition management subfeature
# from 802.11v
################################################################################
- <<: *device_counts_metric_template
  id: 5006
  metric_name: device_connected_to_ap_that_supports_bss_transition_management

################################################################################
# Device connected to AP breakdown by is_multi_bss
################################################################################
- <<: *device_counts_metric_template
  id: 5007
  metric_name: device_connected_to_ap_breakdown_by_is_multi_bss
  metric_dimensions:
    - *is_multi_bss_dim

################################################################################
# Device connected to AP breakdown by primary channel
#
# When a client connects to an AP, log primary channel it's on. On channel
# switch, log the new primary channel. Every day, if the client is still
# connected, log at least one occurrence.
################################################################################
- <<: *device_counts_metric_template
  id: 5008
  metric_name: device_connected_to_ap_breakdown_by_primary_channel
  metric_dimensions:
    - *primary_channel_dim

################################################################################
# Device connected to AP breakdown by channel band
#
# When a client connects to an AP, log channel band it's on. On channel
# switch, log the (potentially) new channel band. Every day, if the client
# is still connected, log at least one occurrence.
################################################################################
- <<: *device_counts_metric_template
  id: 5009
  metric_name: device_connected_to_ap_breakdown_by_channel_band
  metric_dimensions:
    - *channel_band_dim

################################################################################
# Device connected to AP with some OUI
#
# Once a day, log the OUIs of all the APs that the client has connected to
# or is connected to that day.
#
# TODO(fxbug.dev/98997): remove this metric once metric 5011 has been verified.
################################################################################
- id: 5010
  metric_name: device_connected_to_ap_oui
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: *log_once_per_string_daily_string_counts_metric_template

################################################################################
# Device connected to AP with some OUI
#
# Once a day, log the OUIs of all the APs that the client has connected to
# or is connected to that day.
################################################################################
- id: 5011
  metric_name: device_connected_to_ap_oui_2
  string_candidate_file: fuchsia/connectivity_wlan/ouis.txt
  <<: *device_string_counts_metric_template

# Deleted metric IDs that must not be reused.
deleted_metric_ids: [2,3,4,5,8,9,10,11,12,13]