components/metrics/proto/chrome_user_metrics_extension.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 // Protocol buffer for Chrome UMA (User Metrics Analysis).
   6
   7 syntax = "proto2";
   8
   9 option optimize_for = LITE_RUNTIME;
  10
  11 package metrics;
  12
  13 import "histogram_event.proto";
  14 import "omnibox_event.proto";
  15 import "profiler_event.proto";
  16 import "system_profile.proto";
  17 import "user_action_event.proto";
  18 import "perf_data.proto";
  19 import "sampled_profile.proto";
  20
  21 // Next tag: 12
  22 message ChromeUserMetricsExtension {
  23   // The product (i.e. end user application) for a given UMA log.
  24   enum Product {
  25     // Google Chrome product family.
  26     CHROME = 0;
  27   }
  28   // The product corresponding to this log. Note: The default value is Chrome,
  29   // so Chrome products will not transmit this field.
  30   optional Product product = 10 [default = CHROME];
  31
  32   // The id of the client install that generated these events.
  33   //
  34   // For Chrome clients, this id is unique to a top-level (one level above the
  35   // "Default" directory) Chrome user data directory [1], and so is shared among
  36   // all Chrome user profiles contained in this user data directory.
  37   // An id of 0 is reserved for test data (monitoring and internal testing) and
  38   // should normally be ignored in analysis of the data.
  39   // [1] http://www.chromium.org/user-experience/user-data-directory
  40   optional fixed64 client_id = 1;
  41
  42   // The session id for this user.
  43   // Values such as tab ids are only meaningful within a particular session.
  44   // The client keeps track of the session id and sends it with each event.
  45   // The session id is simply an integer that is incremented each time the user
  46   // relaunches Chrome.
  47   optional int32 session_id = 2;
  48
  49   // Information about the user's browser and system configuration.
  50   optional SystemProfileProto system_profile = 3;
  51
  52   // This message will log one or more of the following event types:
  53   repeated UserActionEventProto user_action_event = 4;
  54   repeated OmniboxEventProto omnibox_event = 5;
  55   repeated HistogramEventProto histogram_event = 6;
  56   repeated ProfilerEventProto profiler_event = 7;
  57
  58   // TODO(sque): Deprecate this field and use |sampled_profile| instead.
  59   repeated PerfDataProto perf_data = 8;
  60
  61   // A list of all collected sample-based profiles since the last UMA upload.
  62   repeated SampledProfile sampled_profile = 11;
  63 }