src/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. The field type is int32 instead of
  29   // Product so that downstream users of the Chromium metrics component can
  30   // introduce products without needing to make changes to the Chromium code
  31   // (though they still need to add the new product to the server-side enum).
  32   // Note: The default value is Chrome, so Chrome products will not transmit
  33   // this field.
  34   optional int32 product = 10 [default = 0];
  35
  36   // The id of the client install that generated these events.
  37   //
  38   // For Chrome clients, this id is unique to a top-level (one level above the
  39   // "Default" directory) Chrome user data directory [1], and so is shared among
  40   // all Chrome user profiles contained in this user data directory.
  41   // An id of 0 is reserved for test data (monitoring and internal testing) and
  42   // should normally be ignored in analysis of the data.
  43   // [1] http://www.chromium.org/user-experience/user-data-directory
  44   optional fixed64 client_id = 1;
  45
  46   // The session id for this user.
  47   // Values such as tab ids are only meaningful within a particular session.
  48   // The client keeps track of the session id and sends it with each event.
  49   // The session id is simply an integer that is incremented each time the user
  50   // relaunches Chrome.
  51   optional int32 session_id = 2;
  52
  53   // Information about the user's browser and system configuration.
  54   optional SystemProfileProto system_profile = 3;
  55
  56   // This message will log one or more of the following event types:
  57   repeated UserActionEventProto user_action_event = 4;
  58   repeated OmniboxEventProto omnibox_event = 5;
  59   repeated HistogramEventProto histogram_event = 6;
  60   repeated ProfilerEventProto profiler_event = 7;
  61
  62   // TODO(sque): Deprecate this field and use |sampled_profile| instead.
  63   repeated PerfDataProto perf_data = 8;
  64
  65   // A list of all collected sample-based profiles since the last UMA upload.
  66   repeated SampledProfile sampled_profile = 11;
  67 }