1// Copyright 2018 Google Inc. All Rights Reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//   http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto2";
16
17package soong_build_metrics;
18option go_package = "soong_metrics_proto";
19
20message MetricsBase {
21  // Timestamp generated when the build starts.
22  optional int64 build_date_timestamp = 1;
23
24  // It is usually used to specify the branch name [and release candidate].
25  optional string build_id  = 2;
26
27  // The platform version codename, eg. P, Q, REL.
28  optional string platform_version_codename = 3;
29
30  // The target product information, eg. aosp_arm.
31  optional string target_product = 4;
32
33  enum BuildVariant {
34    USER = 0;
35    USERDEBUG = 1;
36    ENG = 2;
37  }
38  // The target build variant information, eg. eng.
39  optional BuildVariant target_build_variant = 5 [default = ENG];
40
41  enum Arch {
42    UNKNOWN = 0;
43    ARM = 1;
44    ARM64 = 2;
45    X86 = 3;
46    X86_64 = 4;
47  }
48  // The target arch information, eg. arm.
49  optional Arch target_arch = 6 [default = UNKNOWN];
50
51  // The target arch variant information, eg. armv7-a-neon.
52  optional string target_arch_variant = 7;
53
54  // The target cpu variant information, eg. generic.
55  optional string target_cpu_variant = 8;
56
57  // The host arch information, eg. x86_64.
58  optional Arch host_arch = 9 [default = UNKNOWN];
59
60  // The host 2nd arch information, eg. x86.
61  optional Arch host_2nd_arch = 10 [default = UNKNOWN];
62
63  // The host os information, eg. linux.
64  optional string host_os = 11;
65
66  // The host os extra information, eg. Linux-4.17.0-3rodete2-amd64-x86_64-Debian-GNU.
67  optional string host_os_extra = 12;
68
69  // The host cross os information, eg. windows.
70  optional string host_cross_os = 13;
71
72  // The host cross arch information, eg. x86.
73  optional string host_cross_arch = 14;
74
75  // The host cross 2nd arch information, eg. x86_64.
76  optional string host_cross_2nd_arch = 15;
77
78  // The directory for generated built artifacts installation, eg. out.
79  optional string out_dir = 16;
80
81  // The metrics for calling various tools (microfactory) before Soong_UI starts.
82  repeated PerfInfo setup_tools = 17;
83
84  // The metrics for calling Kati by multiple times.
85  repeated PerfInfo kati_runs = 18;
86
87  // The metrics for calling Soong.
88  repeated PerfInfo soong_runs = 19;
89
90  // The metrics for calling Ninja.
91  repeated PerfInfo ninja_runs = 20;
92
93  // The metrics for the whole build
94  optional PerfInfo total = 21;
95
96  optional SoongBuildMetrics soong_build_metrics = 22;
97}
98
99message PerfInfo {
100  // The description for the phase/action/part while the tool running.
101  optional string desc = 1;
102
103  // The name for the running phase/action/part.
104  optional string name = 2;
105
106  // The absolute start time.
107  // The number of nanoseconds elapsed since January 1, 1970 UTC.
108  optional uint64 start_time = 3;
109
110  // The real running time.
111  // The number of nanoseconds elapsed since start_time.
112  optional uint64 real_time = 4;
113
114  // The number of MB for memory use.
115  optional uint64 memory_use = 5;
116}
117
118message ModuleTypeInfo {
119  enum BuildSystem {
120    UNKNOWN = 0;
121    SOONG = 1;
122    MAKE = 2;
123  }
124  // The build system, eg. Soong or Make.
125  optional BuildSystem build_system = 1 [default = UNKNOWN];
126
127  // The module type, eg. java_library, cc_binary, and etc.
128  optional string module_type = 2;
129
130  // The number of logical modules.
131  optional uint32 num_of_modules = 3;
132}
133
134message CriticalUserJourneyMetrics {
135  // The name of a critical user journey test.
136  optional string name = 1;
137
138  // The metrics produced when running the critical user journey test.
139  optional MetricsBase metrics = 2;
140}
141
142message CriticalUserJourneysMetrics {
143  // A set of metrics from a run of the critical user journey tests.
144  repeated CriticalUserJourneyMetrics cujs = 1;
145}
146
147message SoongBuildMetrics {
148  // The number of modules handled by soong_build.
149  optional uint32 modules = 1;
150
151  // The total number of variants handled by soong_build.
152  optional uint32 variants = 2;
153
154  // The total number of allocations in soong_build.
155  optional uint64 total_alloc_count = 3;
156
157  // The total size of allocations in soong_build in bytes.
158  optional uint64 total_alloc_size = 4;
159
160  // The approximate maximum size of the heap in soong_build in bytes.
161  optional uint64 max_heap_size = 5;
162}