7cc2074885
The metrics uploader was currently running on foreground where it
would copy the metrics files in a separate directory and then forked
into the background for the upload process. As a result, running the
lunch command would take a second longer to run since each metrics
uploader run had an average of half a second.
Bug: 140638454
Test: * Wrote and updated unit test cases.
* Set ANDROID_ENABLE_METRICS_UPLOAD to point to the latest
metrics_uploader bash script. Executed the "lunch 1" command
and measured the running time. Executed "m nothing" command
and checked that the metrics were uploaded.
* Ran "lunch 1" and "m nothing" with
ANDROID_ENABLE_METRICS_UPLOAD=""
* Removed oauth from metrics_uploader and ran "m nothing" and
"lunch 1". The oauth Message appeared only to "m nothing"
Change-Id: I13c61e666c8f44613dee291a704cef6a27335188
113 lines
3.8 KiB
Go
113 lines
3.8 KiB
Go
// Copyright 2020 Google Inc. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package build
|
|
|
|
// This file contains the functionality to upload data from one location to
|
|
// another.
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"android/soong/ui/metrics"
|
|
"github.com/golang/protobuf/proto"
|
|
|
|
upload_proto "android/soong/ui/metrics/upload_proto"
|
|
)
|
|
|
|
const (
|
|
uploadPbFilename = ".uploader.pb"
|
|
)
|
|
|
|
var (
|
|
// For testing purpose
|
|
getTmpDir = ioutil.TempDir
|
|
)
|
|
|
|
// UploadMetrics uploads a set of metrics files to a server for analysis. An
|
|
// uploader full path is required to be specified in order to upload the set
|
|
// of metrics files. This is accomplished by defining the ANDROID_ENABLE_METRICS_UPLOAD
|
|
// environment variable. The metrics files are copied to a temporary directory
|
|
// and the uploader is then executed in the background to allow the user to continue
|
|
// working.
|
|
func UploadMetrics(ctx Context, config Config, forceDumbOutput bool, buildStartedMilli int64, files ...string) {
|
|
ctx.BeginTrace(metrics.RunSetupTool, "upload_metrics")
|
|
defer ctx.EndTrace()
|
|
|
|
uploader := config.MetricsUploaderApp()
|
|
// No metrics to upload if the path to the uploader was not specified.
|
|
if uploader == "" {
|
|
return
|
|
}
|
|
|
|
// Some files may not exist. For example, build errors protobuf file
|
|
// may not exist since the build was successful.
|
|
var metricsFiles []string
|
|
for _, f := range files {
|
|
if _, err := os.Stat(f); err == nil {
|
|
metricsFiles = append(metricsFiles, f)
|
|
}
|
|
}
|
|
|
|
if len(metricsFiles) == 0 {
|
|
return
|
|
}
|
|
|
|
// The temporary directory cannot be deleted as the metrics uploader is started
|
|
// in the background and requires to exist until the operation is done. The
|
|
// uploader can delete the directory as it is specified in the upload proto.
|
|
tmpDir, err := getTmpDir("", "upload_metrics")
|
|
if err != nil {
|
|
ctx.Fatalf("failed to create a temporary directory to store the list of metrics files: %v\n", err)
|
|
}
|
|
|
|
for i, src := range metricsFiles {
|
|
dst := filepath.Join(tmpDir, filepath.Base(src))
|
|
if _, err := copyFile(src, dst); err != nil {
|
|
ctx.Fatalf("failed to copy %q to %q: %v\n", src, dst, err)
|
|
}
|
|
metricsFiles[i] = dst
|
|
}
|
|
|
|
// For platform builds, the branch and target name is hardcoded to specific
|
|
// values for later extraction of the metrics in the data metrics pipeline.
|
|
data, err := proto.Marshal(&upload_proto.Upload{
|
|
CreationTimestampMs: proto.Uint64(uint64(buildStartedMilli)),
|
|
CompletionTimestampMs: proto.Uint64(uint64(time.Now().UnixNano() / int64(time.Millisecond))),
|
|
BranchName: proto.String("developer-metrics"),
|
|
TargetName: proto.String("platform-build-systems-metrics"),
|
|
MetricsFiles: metricsFiles,
|
|
DirectoriesToDelete: []string{tmpDir},
|
|
})
|
|
if err != nil {
|
|
ctx.Fatalf("failed to marshal metrics upload proto buffer message: %v\n", err)
|
|
}
|
|
|
|
pbFile := filepath.Join(tmpDir, uploadPbFilename)
|
|
if err := ioutil.WriteFile(pbFile, data, 0644); err != nil {
|
|
ctx.Fatalf("failed to write the marshaled metrics upload protobuf to %q: %v\n", pbFile, err)
|
|
}
|
|
|
|
// Start the uploader in the background as it takes several milliseconds to start the uploader
|
|
// and prepare the metrics for upload. This affects small commands like "lunch".
|
|
cmd := Command(ctx, config, "upload metrics", uploader, "--upload-metrics", pbFile)
|
|
if forceDumbOutput {
|
|
cmd.RunOrFatal()
|
|
} else {
|
|
cmd.RunAndStreamOrFatal()
|
|
}
|
|
}
|