components/metrics/proto/profiler_event.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 // Performance metrics collected via Chrome's built-in profiler.
   6
   7 syntax = "proto2";
   8
   9 option optimize_for = LITE_RUNTIME;
  10
  11 package metrics;
  12
  13 // Next tag: 7
  14 message ProfilerEventProto {
  15   // The version of this profile.
  16   enum ProfileVersion {
  17     VERSION_UNKNOWN = 0;          // Unknown version (should not reach here).
  18     VERSION_STARTUP_PROFILE = 1;  // Startup profile, logged approximately 60
  19                                   // seconds after launch.
  20     VERSION_SPLIT_PROFILE = 2;    // Part of a profile logged in pieces, where
  21                                   // we finish a piece when a ProfilerEvent or a
  22                                   // special end-of-recording event gets
  23                                   // triggered.
  24   }
  25   optional ProfileVersion profile_version = 1;
  26
  27   // The source based upon which "time" measurements are made.
  28   // We currently only measure wall clock time; but we are exploring other
  29   // measurement sources as well, such as CPU time or TCMalloc statistics.
  30   enum TimeSource {
  31     UNKNOWN_TIME_SOURCE = 0;  // Unknown type (should not reach here).
  32     WALL_CLOCK_TIME = 1;      // Total time elapsed between the start and end of
  33                               // the task's execution.
  34   }
  35   optional TimeSource time_source = 2;
  36
  37   // An event in the browser life that causes the client-side profiler framework
  38   // to finish recording of its current instance of ProfilerEventProto, and
  39   // start recording a new one.
  40   // It's not guaranteed that the events get triggered in the order they are
  41   // defined.
  42   enum ProfilerEvent {
  43     // The first non-empty paint of the first web contents happened.
  44     // Corresponds to the Startup.FirstWebContents.NonEmptyPaint histogram.
  45     EVENT_FIRST_NONEMPTY_PAINT = 0;
  46   }
  47
  48   // The set of events, in no particular order, that were triggered in the
  49   // current Chrome session before the recording of this ProfilerEventProto
  50   // started. It doesn't include the event that triggered the end of this
  51   // ProfilerEventProto. A given event will not occur twice in this set.
  52   // The field can be used to find all ProfilerEventProto instances recorded
  53   // before or not before a given event.
  54   repeated ProfilerEvent past_session_event = 4;
  55
  56   // Time when profiling started. This is recorded as a time delta relative to
  57   // the start time of the profiler data recording in the current browser
  58   // session.
  59   optional int64 profiling_start_ms = 5;
  60
  61   // Time when profiling finished. This is recorded as a time delta relative to
  62   // the start time of the profiler data recording in the current browser
  63   // session.
  64   optional int64 profiling_finish_ms = 6;
  65
  66   // Data for a single tracked object (typically, a Task).
  67   message TrackedObject {
  68     // The name of the thread from which this task was posted, hashed.
  69     optional fixed64 birth_thread_name_hash = 1;
  70
  71     // The name of the thread on which this task was executed, hashed.
  72     optional fixed64 exec_thread_name_hash = 2;
  73
  74     // The source file name from which this task was posted, hashed.
  75     optional fixed64 source_file_name_hash = 3;
  76
  77     // Function name from which this task was posted, hashed.
  78     optional fixed64 source_function_name_hash = 4;
  79
  80     // The line number within the source file from which this task was posted.
  81     optional int32 source_line_number = 5;
  82
  83     // The number of times this task was executed.
  84     optional int32 exec_count = 6;
  85
  86     // The total execution time for instances this task.
  87     optional int32 exec_time_total = 7;
  88
  89     // The execution time for a uniformly randomly sampled instance of this
  90     // task.
  91     optional int32 exec_time_sampled = 8;
  92
  93     // The total time instances this task spent waiting (e.g. in a message loop)
  94     // before they were run.
  95     optional int32 queue_time_total = 9;
  96
  97     // The time that a uniformly randomly sampled instance of this task spent
  98     // waiting (e.g.  in a message loop) before it was run.
  99     optional int32 queue_time_sampled = 10;
 100
 101     // The type of process within which this task was executed.
 102     enum ProcessType {
 103       UNKNOWN = 0;  // Should not reach here
 104       BROWSER = 1;
 105       RENDERER = 2;
 106       PLUGIN = 3;
 107       WORKER = 4;
 108       NACL_LOADER = 5;
 109       UTILITY = 6;
 110       PROFILE_IMPORT = 7;
 111       ZYGOTE = 8;
 112       SANDBOX_HELPER = 9;
 113       NACL_BROKER = 10;
 114       GPU = 11;
 115       PPAPI_PLUGIN = 12;
 116       PPAPI_BROKER = 13;
 117     }
 118     optional ProcessType process_type = 11;
 119
 120     // The local PID for the process within which this task was executed.
 121     optional uint32 process_id = 12;
 122   }
 123   repeated TrackedObject tracked_object = 3;
 124 }