components/metrics/proto/sampled_profile.proto

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 syntax = "proto2";
   6
   7 option optimize_for = LITE_RUNTIME;
   8
   9 package metrics;
  10
  11 import "perf_data.proto";
  12
  13 // Protocol buffer for collected sample-based profiling data.
  14 // Contains the parameters and data from a single profile collection event.
  15
  16 // Next tag: 9
  17 message SampledProfile {
  18   // Indicates the event that triggered this collection.
  19   enum TriggerEvent {
  20     UNKNOWN_TRIGGER_EVENT = 0;
  21
  22     // The profile was triggered by periodic sampling.  Periodically sampled
  23     // profiles are collected once per uniformly sized period interval.  Within
  24     // each interval, the sampled data is collected at a random time.  For
  25     // example, if the interval is 60 s, then data would be collected at a
  26     // random point in each of the intervals [0, 60 s), [60 s, 120 s), etc.
  27     PERIODIC_COLLECTION = 1;
  28
  29     // The profile was collected upon resume from suspend.
  30     RESUME_FROM_SUSPEND = 2;
  31
  32     // The profile was collected upon restoring a previous session.
  33     RESTORE_SESSION = 3;
  34   }
  35   optional TriggerEvent trigger_event = 1;
  36
  37   // Fields 2-3: Time durations are given in ticks, and represent system uptime
  38   // rather than wall time.
  39
  40   // Time after system boot when the collection took place, in milliseconds.
  41   optional int64 ms_after_boot = 2;
  42
  43   // Time after last login when the collection took place, in milliseconds.
  44   optional int64 ms_after_login = 3;
  45
  46   // The duration for which the machine was suspended prior to collecting the
  47   // sampled profile. Only set when |trigger_event| is RESUME_FROM_SUSPEND.
  48   optional int64 suspend_duration_ms = 5;
  49
  50   // Number of milliseconds after a resume that profile was collected. Only set
  51   // when |trigger_event| is RESUME_FROM_SUSPEND.
  52   optional int64 ms_after_resume = 6;
  53
  54   // Number of tabs restored during a session restore. Only set when
  55   // |trigger_event| is RESTORE_SESSION.
  56   optional int32 num_tabs_restored = 7;
  57
  58   // Number of milliseconds after a session restore that a profile was
  59   // collected. Only set when |trigger_event| is RESTORE_SESSION.
  60   optional int64 ms_after_restore = 8;
  61
  62   // The actual perf data that was collected.
  63   optional PerfDataProto perf_data = 4;
  64 }