Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use remote target's perf for metrics collection if it is installed and new enough #208

Merged
merged 1 commit into from
Feb 16, 2025
Merged

use remote target's perf for metrics collection if it is installed and new enough #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 43 additions & 12 deletions cmd/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1247,24 +1247,55 @@ func extractPerf(myTarget target.Target, localTempDir string) (string, error) {
return util.ExtractResource(script.Resources, path.Join("resources", arch, "perf"), localTempDir)
}

// getPerfPath returns the path to the perf binary, along with a temporary directory and any error encountered.
// If the target is local, the function returns the local path to the perf binary.
// If the target is remote, the function creates a temporary directory on the remote system, and pushes the perf binary to that directory.
func getPerfPath(myTarget target.Target, localPerfPath string) (perfPath string, err error) {
// getPerfPath determines the path to the `perf` binary for the given target.
// If the target is a local target, it uses the provided localPerfPath.
// If the target is remote, it checks if `perf` version 6.1 or later is available on the target.
// If available, it uses the `perf` binary on the target.
// If not available, it pushes the local `perf` binary to the target's temporary directory and uses that.
//
// Parameters:
// - myTarget: The target system where the `perf` binary is needed.
// - localPerfPath: The local path to the `perf` binary.
//
// Returns:
// - perfPath: The path to the `perf` binary on the target.
// - err: An error if any occurred during the process.
func getPerfPath(myTarget target.Target, localPerfPath string) (string, error) {
var perfPath string
if _, ok := myTarget.(*target.LocalTarget); ok {
perfPath = localPerfPath
} else {
targetTempDir := myTarget.GetTempDirectory()
if targetTempDir == "" {
panic("targetTempDir is empty")
hasPerf := false
cmd := exec.Command("perf", "--version")
output, _, _, err := myTarget.RunCommand(cmd, 0, true)
if err == nil && strings.Contains(output, "perf version") {
// get the version number
version := strings.Split(strings.TrimSpace(output), " ")[2]
// split version into major and minor and build numbers
versionParts := strings.Split(version, ".")
if len(versionParts) >= 2 {
major, _ := strconv.Atoi(versionParts[0])
minor, _ := strconv.Atoi(versionParts[1])
if major > 6 || (major == 6 && minor >= 1) {
hasPerf = true
}
}
}
if err = myTarget.PushFile(localPerfPath, targetTempDir); err != nil {
slog.Error("failed to push perf binary to remote directory", slog.String("error", err.Error()))
return
if hasPerf {
perfPath = "perf"
} else {
targetTempDir := myTarget.GetTempDirectory()
if targetTempDir == "" {
panic("targetTempDir is empty")
}
if err = myTarget.PushFile(localPerfPath, targetTempDir); err != nil {
slog.Error("failed to push perf binary to remote directory", slog.String("error", err.Error()))
return "", err
}
perfPath = path.Join(targetTempDir, "perf")
}
perfPath = path.Join(targetTempDir, "perf")
}
return
return perfPath, nil
}

// getPerfCommandArgs returns the command arguments for the 'perf stat' command
Expand Down