fuchsia/flash_ts/metrics.yaml

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

metric_definitions:

#####################################################################
# load_from_flash
#
# Count of times we attempted to load properties from flash. This
# metric provides the highest-level view of the effectiveness of the
# flash_ts service.
#
# This will be reported once each time that flash_ts service starts.
# We expect that this will be once per boot. However, if the flash_ts
# service is terminated (due, e.g., to low-memory conditions), this
# metric could be reported multiple times for a single boot.
#####################################################################
- id: 1
  metric_name: load_from_flash
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - dimension: result
      event_codes:
        0: Success
        1: SuccessWithWarnings
        2: Failure
      max_event_code: 2
  reports:
      #####################################################################
      # load_from_flash_counts
      #
      # Count of each of the types of load occurrences.
      #####################################################################
    - report_name: load_from_flash_counts
      id: 1
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2020/12/10"

#####################################################################
# cache_read
#
# Count of times we attempted to read properties from Isolated
# Persistent Storage. This metric is intended to both:
# * quantify cache effectiveness, and
# * help debug cache problems
#
# This will be reported once each time that flash_ts service starts.
# We expect that this will be once per boot. However, if the flash_ts
# service is terminated (due, e.g., to low-memory conditions), this
# metric could be reported multiple times for a single boot.
#####################################################################
- id: 2
  metric_name: cache_read
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - dimension: result
      event_codes:
        0: Success
        1: NotFound
        2: MiscIoError
        3: ParseFailure
      max_event_code: 3
  reports:
      #####################################################################
      # cache_read_counts
      #
      # Count of each of the types of cache_read occurrences.
      #####################################################################
    - report_name: cache_read_counts
      id: 1
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2021/01/21"

#####################################################################
# cache_write
#
# Count of times we attempted to write properties to Isolated
# Persistent Storage. This metric is intended to help debug cache
# problems.
#
# Because the storage is persistent, we expect that this metric will
# be reported only once per device. However, if a) writing fails,
# b) the device suffers filesystem corruption, or c) the device is
# factory-reset, then the metric will be reported multiple times.
#####################################################################
- id: 3
  metric_name: cache_write
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - dimension: result
      event_codes:
        0: Success
        1: IoError
      max_event_code: 1
  reports:
      #####################################################################
      # cache_write_counts
      #
      # Count of each of the types of cache_read occurrences.
      #####################################################################
    - report_name: cache_write_counts
      id: 1
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2021/01/21"

#####################################################################
# parse_error
#
# Count of times we encountered errors parsing FTS data. This metric
# is primarily intended to help debug parsing problems. However, it
# may be affected by I/O and storage problems as well.
#
# Reporting frequency
# * For most devices, this event should never be reported.
# * For devices with corrupt flash memory, or devices that were
#   programmed incorrectly at the factory, every time flash_ts
#   starts, the program will log each observed parse error once.
#   (We may encounter multiple kinds of errors, because devices may
#   have multiple copies of the FTS data.)
#####################################################################
- id: 4
  metric_name: parse_error
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - dimension: result
      event_codes:
        0: ShortChunk
        1: BlankChunk
        2: BadHeader
        3: BadPayloadLen
        4: BadChecksum
        5: BadProperties
        6: MissingTerminator
        7: BadPadding
        8: BadTableVersionNum
      max_event_code: 8
  reports:
      #####################################################################
      # parse_error_counts
      #
      # Count of each of the types of parse_error occurrences.
      #####################################################################
    - report_name: parse_error_counts
      id: 1
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2021/01/21"

#####################################################################
# parse_warning
#
# Count of times we encountered warnings parsing FTS data. This metric
# is primarily intended to help prioritize potential enhancements to
# the parser.
#
# Reporting frequency
# * For most devices, this event should never be reported.
# * For devices that encounter warnings, every time flash_ts
#   starts, the program will log each observed parse warning once.
#####################################################################
- id: 5
  metric_name: parse_warning
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - dimension: result
      event_codes:
        0: NonUtf8Key
        1: NonUtf8Value
        2: DuplicateTableVersion
      max_event_code: 2
  reports:
      #####################################################################
      # parse_warning_counts
      #
      # Count of each of the types of parse_warning occurrences.
      #####################################################################
    - report_name: parse_warning_counts
      id: 1
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: NONE
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2021/01/21"