You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
helm/cmd/helm/profiling.go

125 lines
3.0 KiB

/*
Copyright The Helm Authors.
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 main
import (
"fmt"
"os"
"path"
"path/filepath"
"runtime"
"runtime/pprof"
"strings"
"github.com/spf13/cobra"
)
var (
cpuProfileFile *os.File
pprofPaths map[string]string
)
func init() {
pprofPaths = parsePProfPaths(os.Getenv("HELM_PPROF"))
}
// startProfiling starts profiling CPU usage
func startProfiling() error {
cpuprofile, ok := pprofPaths["cpu"]
if ok && cpuprofile != "" {
var err error
cpuProfileFile, err = os.Create(cpuprofile)
if err != nil {
return fmt.Errorf("could not create CPU profile: %w", err)
}
if err := pprof.StartCPUProfile(cpuProfileFile); err != nil {
cpuProfileFile.Close()
cpuProfileFile = nil
return fmt.Errorf("could not start CPU profile: %w", err)
}
}
return nil
}
// stopProfiling stops profiling CPU and memory usage and writes the results to
// the files specified by HELM_PPROF=cpu=/path/to/cpu.prof,mem=/path/to/mem.prof
func stopProfiling() error {
errs := []string{}
// Stop CPU profiling if it was started
if cpuProfileFile != nil {
pprof.StopCPUProfile()
err := cpuProfileFile.Close()
if err != nil {
errs = append(errs, err.Error())
}
cpuProfileFile = nil
}
memprofile, ok := pprofPaths["mem"]
if ok && memprofile != "" {
f, err := os.Create(memprofile)
if err != nil {
errs = append(errs, err.Error())
}
defer f.Close()
runtime.GC() // get up-to-date statistics
if err := pprof.WriteHeapProfile(f); err != nil {
errs = append(errs, err.Error())
}
}
if len(errs) > 0 {
return fmt.Errorf("errors while stopping profiling: [%s]", strings.Join(errs, ", "))
}
return nil
}
// addProfilingFlags adds the --cpuprofile and --memprofile flags to the given command.
func addProfilingFlags(cmd *cobra.Command) {
// Persistent flags to make available to subcommands
cmd.PersistentFlags().String("cpuprofile", "", "File path to write cpu profiling data")
cmd.PersistentFlags().String("memprofile", "", "File path to write memory profiling data")
}
func parsePProfPaths(env string) map[string]string {
// Initial empty paths
m := map[string]string{}
for _, pprofs := range strings.Split(env, ",") {
// Is of the format mem=/path/to/memprof
tuple := strings.Split(pprofs, "=")
if len(tuple) != 2 {
continue
}
if tuple[0] != "cpu" && tuple[0] != "mem" {
continue
}
s, err := filepath.Abs(path.Clean(tuple[1]))
if err != nil {
continue
}
if !strings.HasSuffix(s, string(filepath.Separator)) {
// Ensure its not a directory
m[tuple[0]] = s
}
}
return m
}