# Copyright 2021 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: audio_drivers
################################################################################

metric_definitions:

################################################################################
# Next Metric ID: 5
################################################################################

################################################################################
# seconds_until_error
#
# The number of seconds from boot to when a codec error is detected.
# Very infrequent.
# Logged by a codec driver via Lapis.
################################################################################
- id: 1
  metric_name: seconds_until_error
  metric_units: SECONDS
  metric_type: INTEGER
  metric_semantics: [METRIC_SEMANTICS_UNSPECIFIED]
  reports:
    - report_name: histogram
      id: 1
      report_type: HOURLY_VALUE_HISTOGRAMS
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: &error_time_buckets
        exponential:
          floor: 1
          num_buckets: 5
          initial_step: 60
          step_multiplier: 60
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
    - report_name: histogram_daily
      id: 2
      report_type: UNIQUE_DEVICE_HISTOGRAMS
      local_aggregation_period: WINDOW_1_DAY
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: *error_time_buckets
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/05/06"

################################################################################
# seconds_until_interrupt
#
# The number of seconds from boot to when a codec interrupt triggered.
# Always occurs at boot once, afterwards not expected unless certain errors
# trigger a new interrupt. Logged by a codec driver via Lapis.
################################################################################
- id: 2
  metric_name: seconds_until_interrupt
  metric_units: SECONDS
  metric_type: INTEGER
  metric_semantics: [METRIC_SEMANTICS_UNSPECIFIED]
  reports:
    - report_name: histogram
      id: 1
      report_type: HOURLY_VALUE_HISTOGRAMS
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: &interrupt_time_buckets
        exponential:
          floor: 30
          num_buckets: 5
          initial_step: 60
          step_multiplier: 60
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
    - report_name: histogram_daily
      id: 2
      report_type: UNIQUE_DEVICE_HISTOGRAMS
      local_aggregation_period: WINDOW_1_DAY
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: *interrupt_time_buckets
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/05/06"

################################################################################
# seconds_until_first_error
#
# The number of seconds from boot to when the first codec error is detected.
# Very infrequent.
# Logged by a codec driver via Lapis.
################################################################################
- id: 3
  metric_name: seconds_until_first_error
  metric_units: SECONDS
  metric_type: INTEGER
  metric_semantics: [METRIC_SEMANTICS_UNSPECIFIED]
  reports:
    - report_name: histogram
      id: 1
      report_type: HOURLY_VALUE_HISTOGRAMS
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: &error_time_buckets
        exponential:
          floor: 1
          num_buckets: 5
          initial_step: 60
          step_multiplier: 60
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
    - report_name: histogram_daily
      id: 2
      report_type: UNIQUE_DEVICE_HISTOGRAMS
      local_aggregation_period: WINDOW_1_DAY
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: *error_time_buckets
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/05/06"


################################################################################
# reset_count
#
# The number of codec resets.
# Very infrequent.
# Logged by a codec driver via Lapis.
################################################################################
- id: 4
  metric_name: reset_count
  metric_units_other: "reset_count"
  metric_type: INTEGER
  metric_semantics: [METRIC_SEMANTICS_UNSPECIFIED]
  reports:
    - report_name: histogram
      id: 1
      report_type: HOURLY_VALUE_HISTOGRAMS
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: &count_buckets
        linear:
          floor: 1
          num_buckets: 8
          step_size: 1
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
    - report_name: histogram_daily
      id: 2
      report_type: UNIQUE_DEVICE_HISTOGRAMS
      local_aggregation_period: WINDOW_1_DAY
      privacy_level: NO_ADDED_PRIVACY
      local_aggregation_procedure: MAX_PROCEDURE
      int_buckets: *count_buckets
      system_profile_field: [BOARD_NAME, PRODUCT_NAME, SYSTEM_VERSION, CHANNEL]
  meta_data:
    max_release_stage: GA
    expiration_date: "2022/05/06"