197d62c6ca
* agent/debug: add package for debugging, host info * api: add v1/agent/host endpoint * agent: add v1/agent/host endpoint * command/debug: implementation of static capture * command/debug: tests and only configured targets * agent/debug: add basic test for host metrics * command/debug: add methods for dynamic data capture * api: add debug/pprof endpoints * command/debug: add pprof * command/debug: timing, wg, logs to disk * vendor: add gopsutil/disk * command/debug: add a usage section * website: add docs for consul debug * agent/host: require operator:read * api/host: improve docs and no retry timing * command/debug: fail on extra arguments * command/debug: fixup file permissions to 0644 * command/debug: remove server flags * command/debug: improve clarity of usage section * api/debug: add Trace for profiling, fix profile * command/debug: capture profile and trace at the same time * command/debug: add index document * command/debug: use "clusters" in place of members * command/debug: remove address in output * command/debug: improve comment on metrics sleep * command/debug: clarify usage * agent: always register pprof handlers and protect This will allow us to avoid a restart of a target agent for profiling by always registering the pprof handlers. Given this is a potentially sensitive path, it is protected with an operator:read ACL and enable debug being set to true on the target agent. enable_debug still requires a restart. If ACLs are disabled, enable_debug is sufficient. * command/debug: use trace.out instead of .prof More in line with golang docs. * agent: fix comment wording * agent: wrap table driven tests in t.run()
107 lines
2.7 KiB
Go
107 lines
2.7 KiB
Go
package api
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
"strconv"
|
|
)
|
|
|
|
// Debug can be used to query the /debug/pprof endpoints to gather
|
|
// profiling information about the target agent.Debug
|
|
//
|
|
// The agent must have enable_debug set to true for profiling to be enabled
|
|
// and for these endpoints to function.
|
|
type Debug struct {
|
|
c *Client
|
|
}
|
|
|
|
// Debug returns a handle that exposes the internal debug endpoints.
|
|
func (c *Client) Debug() *Debug {
|
|
return &Debug{c}
|
|
}
|
|
|
|
// Heap returns a pprof heap dump
|
|
func (d *Debug) Heap() ([]byte, error) {
|
|
r := d.c.newRequest("GET", "/debug/pprof/heap")
|
|
_, resp, err := d.c.doRequest(r)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error making request: %s", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
// We return a raw response because we're just passing through a response
|
|
// from the pprof handlers
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error decoding body: %s", err)
|
|
}
|
|
|
|
return body, nil
|
|
}
|
|
|
|
// Profile returns a pprof CPU profile for the specified number of seconds
|
|
func (d *Debug) Profile(seconds int) ([]byte, error) {
|
|
r := d.c.newRequest("GET", "/debug/pprof/profile")
|
|
|
|
// Capture a profile for the specified number of seconds
|
|
r.params.Set("seconds", strconv.Itoa(seconds))
|
|
|
|
_, resp, err := d.c.doRequest(r)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error making request: %s", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
// We return a raw response because we're just passing through a response
|
|
// from the pprof handlers
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error decoding body: %s", err)
|
|
}
|
|
|
|
return body, nil
|
|
}
|
|
|
|
// Trace returns an execution trace
|
|
func (d *Debug) Trace(seconds int) ([]byte, error) {
|
|
r := d.c.newRequest("GET", "/debug/pprof/trace")
|
|
|
|
// Capture a trace for the specified number of seconds
|
|
r.params.Set("seconds", strconv.Itoa(seconds))
|
|
|
|
_, resp, err := d.c.doRequest(r)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error making request: %s", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
// We return a raw response because we're just passing through a response
|
|
// from the pprof handlers
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error decoding body: %s", err)
|
|
}
|
|
|
|
return body, nil
|
|
}
|
|
|
|
// Goroutine returns a pprof goroutine profile
|
|
func (d *Debug) Goroutine() ([]byte, error) {
|
|
r := d.c.newRequest("GET", "/debug/pprof/goroutine")
|
|
|
|
_, resp, err := d.c.doRequest(r)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error making request: %s", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
|
|
// We return a raw response because we're just passing through a response
|
|
// from the pprof handlers
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("error decoding body: %s", err)
|
|
}
|
|
|
|
return body, nil
|
|
}
|