# Copyright 2020 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

##########################################################################
#  This file contains MetricDefinitions used in Logger tests.
#  It is compiled into all_report_types_test_registry.h, which is included
#  in testing_constants.h.
##########################################################################

metric_definitions:

- id: 1
  metric_name: "ErrorOccurred"
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - dimension: FirstDimension
      max_event_code: 100
  reports:
    - report_name: "ErrorCountsByCode"
      id: 1
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: SMALL
  meta_data: &meta_data
    max_release_stage: GA

- id: 2
  metric_name: "ReadCacheHits"
  metric_type: EVENT_COUNT
  # One defined dimension with max_event_code set and no event_codes defined.
  metric_dimensions:
    - dimension: FirstDimension
      max_event_code: 111
  reports:
    - report_name: "ReadCacheHitCounts"
      id: 2
      report_type: EVENT_COMPONENT_OCCURRENCE_COUNT
    - report_name: "ReadCacheHitHistograms"
      id: 3
      report_type: INT_RANGE_HISTOGRAM
    - report_name: "ReadCacheHitStats"
      id: 4
      report_type: NUMERIC_AGGREGATION
  meta_data: *meta_data

- id: 3
  metric_name: "ModuleLoadTime"
  metric_type: ELAPSED_TIME
  # No metric dimensions defined.
  reports:
    - report_name: "ModuleLoadTime_Aggregated"
      id: 5
      report_type: NUMERIC_AGGREGATION
    - report_name: "ModuleLoadTime_Histogram"
      id: 6
      report_type: INT_RANGE_HISTOGRAM
  meta_data: *meta_data

- id: 4
  metric_name: "LoginModuleFrameRate"
  metric_type: FRAME_RATE
  # One defined dimension with max_event_code not set and one
  # event_code defined.
  metric_dimensions:
    - dimension: FirstDimension
      event_codes:
        45: CODE
  reports:
    - report_name: "LoginModuleFrameRate_Aggregated"
      id: 8
      report_type: NUMERIC_AGGREGATION
    - report_name: "LoginModuleFrameRate_Histogram"
      id: 9
      report_type: INT_RANGE_HISTOGRAM
    - report_name: "LoginModuleFrameRate_PerDeviceMin"
      id: 11
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: MIN
      window_size:
        - 1
        - 7
  meta_data: *meta_data

- id: 5
  metric_name: "LedgerMemoryUsage"
  metric_type: MEMORY_USAGE
  # Two metric dimensions defined
  metric_dimensions:
    # The first dimension has max_event_code set
    - dimension: FirstDimension
      event_codes:
        45: CODE45
      max_event_code: 100
    # The second dimension does not have max_event_code set
    - dimension: SecondDimension
      event_codes:
        46: CODE46
        47: CODE47
  reports:
    - report_name: "LedgerMemoryUsage_Aggregated"
      id: 12
      report_type: NUMERIC_AGGREGATION
    - report_name: "LedgerMemoryUsage_Histogram"
      id: 13
      report_type: INT_RANGE_HISTOGRAM
    - report_name: "LedgerMemoryUsage_PerDeviceMax"
      id: 14
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: MAX
      window_size:
        - 1
        - 7
  meta_data: *meta_data

- id: 6
  metric_name: "FileSystemWriteTimes"
  metric_type: INT_HISTOGRAM
  metric_dimensions:
    - event_codes:
        47: CODE
  int_buckets:
     linear:
       floor: 0
       num_buckets: 10
       step_size: 1
  reports:
    - report_name: "FileSystemWriteTimes_Histogram"
      id: 15
      report_type: INT_RANGE_HISTOGRAM
  meta_data: *meta_data

- id: 8
  metric_name: "ModuleInstalls"
  metric_type: CUSTOM
  reports:
    - report_name: "ModuleInstalls_DetailedData"
      id: 18
      report_type: CUSTOM_RAW_DUMP
  meta_data: *meta_data

- id: 9
  metric_name: "DeviceBoots"
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - max_event_code: 1
  reports:
    - report_name: "DeviceBoots_UniqueDevices"
      id: 19
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: SMALL
      window_size:
        - 1
  meta_data: *meta_data

- id: 10
  metric_name: "FeaturesActive"
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - max_event_code: 4
  reports:
    - report_name: "FeaturesActive_UniqueDevices"
      id: 20
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: LARGE
      window_size:
        - 1
        - 7
        - 30
  meta_data: *meta_data

- id: 11
  metric_name: "EventsOccurred"
  metric_type: EVENT_OCCURRED
  metric_dimensions:
    - max_event_code: 4
  reports:
    - report_name: "EventsOccurred_GlobalCount"
      id: 21
      report_type: SIMPLE_OCCURRENCE_COUNT
      local_privacy_noise_level: SMALL
    - report_name: "EventsOccurred_UniqueDevices"
      id: 22
      report_type: UNIQUE_N_DAY_ACTIVES
      local_privacy_noise_level: MEDIUM
      window_size:
        - 1
        - 7
  meta_data: *meta_data

- id: 12
  metric_name: "SettingsChanged"
  metric_type: EVENT_COUNT
  metric_dimensions:
    - event_codes:
        0: SettingA
        1: SettingB
        2: SettingC
  reports:
    - report_name: "SettingsChanged_PerDeviceCount"
      id: 23
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 7
        - 30
  meta_data: *meta_data

- id: 13
  metric_name: "ConnectionFailures"
  metric_type: EVENT_COUNT
  metric_dimensions:
    - event_codes:
        0: ErrorCode0
        1: ErrorCode1
        2: ErrorCode2
  reports:
    - report_name: "ConnectionFailures_GlobalCount"
      id: 24
      report_type: EVENT_COMPONENT_OCCURRENCE_COUNT
    - report_name: "ConnectionFailures_PerDeviceCount"
      id: 25
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
  meta_data: *meta_data

- id: 14
  metric_name: "StreamingTime"
  metric_type: ELAPSED_TIME
  metric_dimensions:
    - event_codes:
        0: StreamTypeA
        1: StreamTypeB
        2: StreamTypeC
  reports:
    - report_name: "StreamingTime_PerDeviceTotal"
      id: 26
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: SUM
      window_size:
        - 1
        - 7
    - report_name: "StreamingTime_PerDeviceMin"
      id: 27
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: MIN
      window_size:
        - 1
        - 7
    - report_name: "StreamingTime_PerDeviceMax"
      id: 28
      report_type: PER_DEVICE_NUMERIC_STATS
      aggregation_type: MAX
      window_size:
        - 1
        - 7
  meta_data: *meta_data

- id: 15
  metric_name: "NewReadCacheHits"
  metric_type: OCCURRENCE
  # One defined dimension with max_event_code set and no event_codes defined.
  metric_dimensions:
    - dimension: FirstDimension
      max_event_code: 111
  reports:
    - report_name: "NewReadCacheHitCounts"
      id: 1
      report_type: FLEETWIDE_OCCURRENCE_COUNTS
    - report_name: "NewReadCacheHitHistograms"
      id: 2
      report_type: HOURLY_VALUE_HISTOGRAMS
    - report_name: "NewReadCacheHitStats"
      id: 3
      report_type: HOURLY_VALUE_NUMERIC_STATS
  meta_data: *meta_data

- id: 16
  metric_name: "NewStreamingTime"
  metric_type: INTEGER
  metric_semantics: [LATENCY]
  metric_units: SECONDS
  metric_dimensions:
    - event_codes:
        0: StreamTypeA
        1: StreamTypeB
        2: StreamTypeC
  reports:
    - report_name: "NewStreamingTime_PerDeviceTotal"
      id: 1
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
  meta_data: *meta_data

- id: 16
  metric_name: "NewLoginModuleFrameRate"
  metric_type: INTEGER
  metric_semantics: [FRAME_RENDERING]
  metric_units_other: "FPS"
  # One defined dimension with max_event_code not set and one
  # event_code defined.
  metric_dimensions:
    - dimension: FirstDimension
      event_codes:
        45: CODE
  reports:
    - report_name: "NewLoginModuleFrameRate_Aggregated"
      id: 1
      report_type: FLEETWIDE_MEANS
    - report_name: "NewLoginModuleFrameRate_Histogram"
      id: 2
      report_type: FLEETWIDE_HISTOGRAMS
      int_buckets:
        linear:
          floor: 0
          num_buckets: 120
          step_size: 1000
    - report_name: "NewLoginModuleFrameRate_PerDevice"
      id: 3
      report_type: UNIQUE_DEVICE_NUMERIC_STATS
      local_aggregation_procedure: SUM_PROCEDURE
  meta_data: *meta_data

- id: 17
  metric_name: "NewFileSystemWriteTimes"
  metric_type: INTEGER_HISTOGRAM
  metric_semantics: [USAGE_COUNTING]
  metric_dimensions:
    - event_codes:
        47: CODE
  int_buckets:
     linear:
       floor: 0
       num_buckets: 10
       step_size: 1
  reports:
    - report_name: "NewFileSystemWriteTimes_Histogram"
      id: 1
      report_type: FLEETWIDE_HISTOGRAMS
      int_buckets:
        linear:
          floor: 0
          num_buckets: 120
          step_size: 1000
  meta_data: *meta_data

- id: 18
  metric_name: "NewComponent"
  metric_type: STRING
  metric_semantics: [USAGE_COUNTING]
  # No metric dimensions defined.
  string_candidate_file: application_names.txt
  string_buffer_max: 30
  reports:
    - report_name: "NewComponent_Histogram"
      id: 1
      report_type: STRING_COUNTS
  meta_data: *meta_data