profiling

Documentation

Overview

Package profiling provides helpers for CPU and memory profiling.

Index

• type Stop
  • func Start(cpuProfile, memProfile string) (Stop, error)

Types

type Stop

type Stop func() error

Stop is a function returned by Start that stops profiling and flushes any buffered data. It must be called (typically via defer) when the profiled section of code completes.

func Start

func Start(cpuProfile, memProfile string) (Stop, error)

Start begins CPU and/or memory profiling based on the provided file paths. Pass an empty string to skip the corresponding profile. The returned Stop function must be called to finalise the profiles.