SERVER-67044 added build-metrics CLI and basic metadata capture.

1 files changed, 95 insertions, 0 deletions

diff --git a/site_scons/site_tools/build_metrics.py b/site_scons/site_tools/build_metrics.py
new file mode 100644
index 00000000000..0ab660a45e9
--- /dev/null
+++ b/site_scons/site_tools/build_metrics.py
@@ -0,0 +1,95 @@
+# Copyright 2020 MongoDB Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+"""Configure the build to track build performance."""
+
+import time
+import os
+import sys
+import atexit
+import json
+
+import psutil
+
+_SEC_TO_NANOSEC_FACTOR = 1000000000.0
+
+_BUILD_METRIC_DATA = {}
+
+
+def get_build_metric_dict():
+    global _BUILD_METRIC_DATA
+    return _BUILD_METRIC_DATA
+
+
+import atexit
+
+
+# This section is an excerpt of the original
+# https://stackoverflow.com/a/63029332/1644736
+class CaptureAtexits:
+    def __init__(self):
+        self.captured = []
+
+    def __eq__(self, other):
+        self.captured.append(other)
+        return False
+
+
+def finalize_build_metrics(env):
+    metrics = get_build_metric_dict()
+    metrics['end_time'] = time.time_ns()
+
+    build_metrics_file = env.GetOption('build-metrics')
+    if build_metrics_file == '-':
+        json.dump(metrics, sys.stdout, indent=4, sort_keys=True)
+    else:
+        with open(build_metrics_file, 'w') as f:
+            json.dump(metrics, f, indent=4, sort_keys=True)
+
+
+def add_meta_data(env, key, value):
+    get_build_metric_dict()[key] = value
+
+
+def generate(env, **kwargs):
+
+    # This will force our at exit to the of the stack ensuring
+    # that it is the last thing called when exiting.
+    c = CaptureAtexits()
+    atexit.unregister(c)
+    for func in c.captured:
+        atexit.unregister(func)
+    atexit.register(finalize_build_metrics, env)
+    for func in c.captured:
+        atexit.register(func)
+
+    env.AddMethod(get_build_metric_dict, "GetBuildMetricDictionary")
+    env.AddMethod(add_meta_data, "AddBuildMetricsMetaData")
+
+    metrics = get_build_metric_dict()
+    p = psutil.Process(os.getpid())
+
+    metrics['start_time'] = int(p.create_time() * _SEC_TO_NANOSEC_FACTOR)
+    metrics['scons_command'] = " ".join([sys.executable] + sys.argv)
+
+
+def exists(env):
+    return True