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  optional BuildConfig build_config = 23;
99
100  // The hostname of the machine.
101  optional string hostname = 24;
102
103  // The system resource information such as total physical memory.
104  optional SystemResourceInfo system_resource_info = 25;
105
106  // The build command that the user entered to the build system.
107  optional string build_command = 26;
108
109  // The metrics for calling Bazel.
110  repeated PerfInfo bazel_runs = 27;
111}
112
113message BuildConfig {
114  optional bool use_goma = 1;
115
116  optional bool use_rbe = 2;
117
118  optional bool force_use_goma = 3;
119}
120
121message SystemResourceInfo {
122  // The total physical memory in bytes.
123  optional uint64 total_physical_memory = 1;
124
125  // The total of available cores for building
126  optional int32 available_cpus = 2;
127}
128
129message PerfInfo {
130  // The description for the phase/action/part while the tool running.
131  optional string desc = 1;
132
133  // The name for the running phase/action/part.
134  optional string name = 2;
135
136  // The absolute start time.
137  // The number of nanoseconds elapsed since January 1, 1970 UTC.
138  optional uint64 start_time = 3;
139
140  // The real running time.
141  // The number of nanoseconds elapsed since start_time.
142  optional uint64 real_time = 4;
143
144  // The number of MB for memory use (deprecated as it is too generic).
145  optional uint64 memory_use = 5 [deprecated=true];
146
147  // The resource information of each executed process.
148  repeated ProcessResourceInfo processes_resource_info = 6;
149}
150
151message ProcessResourceInfo {
152  // The name of the process for identification.
153  optional string name = 1;
154
155  // The amount of time spent executing in user space in microseconds.
156  optional uint64 user_time_micros = 2;
157
158  // The amount of time spent executing in kernel mode in microseconds.
159  optional uint64 system_time_micros = 3;
160
161  // The maximum resident set size memory used in kilobytes.
162  optional uint64 max_rss_kb = 4;
163
164  // The number of minor page faults serviced without any I/O activity.
165  optional uint64 minor_page_faults = 5;
166
167  // The number of major page faults serviced that required I/O activity.
168  optional uint64 major_page_faults = 6;
169
170  // Total IO input in kilobytes.
171  optional uint64 io_input_kb= 7;
172
173  // Total IO output in kilobytes.
174  optional uint64 io_output_kb = 8;
175
176  // The number of voluntary context switches
177  optional uint64 voluntary_context_switches = 9;
178
179  // The number of involuntary context switches
180  optional uint64 involuntary_context_switches = 10;
181}
182
183message ModuleTypeInfo {
184  enum BuildSystem {
185    UNKNOWN = 0;
186    SOONG = 1;
187    MAKE = 2;
188  }
189  // The build system, eg. Soong or Make.
190  optional BuildSystem build_system = 1 [default = UNKNOWN];
191
192  // The module type, eg. java_library, cc_binary, and etc.
193  optional string module_type = 2;
194
195  // The number of logical modules.
196  optional uint32 num_of_modules = 3;
197}
198
199message CriticalUserJourneyMetrics {
200  // The name of a critical user journey test.
201  optional string name = 1;
202
203  // The metrics produced when running the critical user journey test.
204  optional MetricsBase metrics = 2;
205}
206
207message CriticalUserJourneysMetrics {
208  // A set of metrics from a run of the critical user journey tests.
209  repeated CriticalUserJourneyMetrics cujs = 1;
210}
211
212message SoongBuildMetrics {
213  // The number of modules handled by soong_build.
214  optional uint32 modules = 1;
215
216  // The total number of variants handled by soong_build.
217  optional uint32 variants = 2;
218
219  // The total number of allocations in soong_build.
220  optional uint64 total_alloc_count = 3;
221
222  // The total size of allocations in soong_build in bytes.
223  optional uint64 total_alloc_size = 4;
224
225  // The approximate maximum size of the heap in soong_build in bytes.
226  optional uint64 max_heap_size = 5;
227}
228