Home | History | Annotate | Download | only in proto
      1 /*
      2  * Copyright (C) 2015 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 //
     17 // Protocol buffer for Chrome UMA (User Metrics Analysis).
     18 //
     19 // Note: this protobuf must be compatible with the one in chromium.
     20 
     21 syntax = "proto2";
     22 
     23 option optimize_for = LITE_RUNTIME;
     24 option java_outer_classname = "ChromeUserMetricsExtensionProtos";
     25 option java_package = "org.chromium.components.metrics";
     26 
     27 package metrics;
     28 
     29 import "system/core/metricsd/uploader/proto/histogram_event.proto";
     30 import "system/core/metricsd/uploader/proto/system_profile.proto";
     31 import "system/core/metricsd/uploader/proto/user_action_event.proto";
     32 
     33 // Next tag: 13
     34 message ChromeUserMetricsExtension {
     35   // The product (i.e. end user application) for a given UMA log.
     36   enum Product {
     37     // Google Chrome product family.
     38     CHROME = 0;
     39   }
     40   // The product corresponding to this log. The field type is int32 instead of
     41   // Product so that downstream users of the Chromium metrics component can
     42   // introduce products without needing to make changes to the Chromium code
     43   // (though they still need to add the new product to the server-side enum).
     44   // Note: The default value is Chrome, so Chrome products will not transmit
     45   // this field.
     46   optional int32 product = 10 [default = 0];
     47 
     48   // The id of the client install that generated these events.
     49   //
     50   // For Chrome clients, this id is unique to a top-level (one level above the
     51   // "Default" directory) Chrome user data directory [1], and so is shared among
     52   // all Chrome user profiles contained in this user data directory.
     53   // An id of 0 is reserved for test data (monitoring and internal testing) and
     54   // should normally be ignored in analysis of the data.
     55   // [1] http://www.chromium.org/user-experience/user-data-directory
     56   optional fixed64 client_id = 1;
     57 
     58   // The session id for this user.
     59   // Values such as tab ids are only meaningful within a particular session.
     60   // The client keeps track of the session id and sends it with each event.
     61   // The session id is simply an integer that is incremented each time the user
     62   // relaunches Chrome.
     63   optional int32 session_id = 2;
     64 
     65   // Information about the user's browser and system configuration.
     66   optional SystemProfileProto system_profile = 3;
     67 
     68   // This message will log one or more of the following event types:
     69   repeated UserActionEventProto user_action_event = 4;
     70   repeated HistogramEventProto histogram_event = 6;
     71 
     72 }
     73