Skip to content

Commit

Permalink
kms: add support for capturing performace profiles
Browse files Browse the repository at this point in the history
This commit adds support for capturing perf. profiles
at a KMS server. Now, a client can start a performace
profile via:
```
client.StartProfiling(ctx, &ProfileRequest{
   Host: "192.168.188.110:7373",
   ...
})
```

After some time, the client can either inspect that
status of an ongoing profiling via:
```
client.ProfileStatus(ctx, &ProfileRequest{
   Host: "192.168.188.110:7373",
   ...
})
```

or stop the profiling and download the results:
```
client.StopProfiling(ctx, &ProfileRequest{
   Host: "192.168.188.110:7373",
   ...
})
```

The result of a profile is a stream of pprof files
packed into a TAR archive.

Signed-off-by: Andreas Auernhammer <[email protected]>
  • Loading branch information
aead committed Apr 29, 2024
1 parent 5afd555 commit 3ce6c70
Show file tree
Hide file tree
Showing 10 changed files with 660 additions and 241 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: 1.21.8
go-version: 1.22.2
check-latest: true
- name: Check out code
uses: actions/checkout@v3
Expand All @@ -40,7 +40,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: 1.21.8
go-version: 1.22.2
check-latest: true
- name: Check out code
uses: actions/checkout@v3
Expand All @@ -57,12 +57,13 @@ jobs:
uses: actions/checkout@v3
- uses: actions/setup-go@v3
with:
go-version: 1.21.8
go-version: 1.22.2
check-latest: true
- name: Get govulncheck
run: go install golang.org/x/vuln/cmd/govulncheck@latest
shell: bash
- name: Run govulncheck
run: |
govulncheck ./kms ./kes
govulncheck -C ./kms
govulncheck -C ./kes
shell: bash
2 changes: 1 addition & 1 deletion .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ issues:
- "package-comments: should have a package comment"

service:
golangci-lint-version: 1.52.0 # use the fixed version to not introduce new linters unexpectedly
golangci-lint-version: 1.57.2 # use the fixed version to not introduce new linters unexpectedly
148 changes: 148 additions & 0 deletions kms/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ import (
"crypto/x509/pkix"
"encoding/pem"
"errors"
"fmt"
"math/big"
"net"
"net/http"
"net/url"
"slices"
"strconv"
"strings"
"sync"
"time"
Expand Down Expand Up @@ -412,6 +414,150 @@ func (c *Client) Ready(ctx context.Context, req *ReadinessRequest) error {
return errors.Join(errs...)
}

// StartProfiling enables profiling on req.Host. A client must call
// StopProfiling to stop the profiling again and obtain the resutls.
// The ProfileRequest specifies which types of profiles should be
// enabled and disabled.
//
// The returned error is of type *HostError.
func (c *Client) StartProfiling(ctx context.Context, req *ProfileRequest) error {
const (
Method = http.MethodPost
Path = api.PathProfile
StatusOK = http.StatusOK
)

url, err := url.JoinPath(httpsURL(req.Host), Path)
if err != nil {
return hostError(req.Host, err)
}
url += fmt.Sprintf("?cpu=%v", req.CPU)
url += fmt.Sprintf("&heap=%v", req.Heap)

switch {
case req.Goroutine && req.Thread:
url += fmt.Sprintf("&thread=%v", "all")
case req.Goroutine:
url += fmt.Sprintf("&thread=%v", "runtime")
case req.Thread:
url += fmt.Sprintf("&thread=%v", "os")
}

if req.BlockRate > 0 {
url += "&block=" + strconv.Itoa(req.BlockRate)
}
if req.MutexFraction > 0 {
url += "&mutex=" + strconv.Itoa(req.MutexFraction)
}

r, err := http.NewRequestWithContext(ctx, Method, url, nil)
if err != nil {
return hostError(req.Host, err)
}
r.Header.Set(headers.Accept, headers.ContentTypeBinary)

resp, err := c.direct.Do(r)
if err != nil {
return hostError(req.Host, err)
}
defer resp.Body.Close()

if resp.StatusCode != StatusOK {
return hostError(req.Host, readError(resp))
}
return nil
}

// ProfilingStatus returns status information about an ongoing profiling
// at req.Host.
//
// The returned error is of type *HostError.
func (c *Client) ProfilingStatus(ctx context.Context, req *ProfileRequest) (*ProfileStatusResponse, error) {
const (
Method = http.MethodGet
Path = api.PathProfile
StatusOK = http.StatusOK
)
url, err := url.JoinPath(httpsURL(req.Host), Path)
if err != nil {
return nil, hostError(req.Host, err)
}

r, err := http.NewRequestWithContext(ctx, Method, url, nil)
if err != nil {
return nil, hostError(req.Host, err)
}
r.Header.Set(headers.Accept, headers.ContentTypeBinary)

resp, err := c.direct.Do(r)
if err != nil {
return nil, hostError(req.Host, err)
}
defer resp.Body.Close()

if resp.StatusCode != StatusOK {
return nil, hostError(req.Host, readError(resp))
}

var response ProfileStatusResponse
if err = readResponse(resp, &response); err != nil {
return nil, err
}
return &response, nil
}

// StopProfiling stops an ongoing profiling operation and returns
// its results. It's the callers responsibility to close the returned
// ProfileResponse.
//
// The returned error is of type *HostError.
func (c *Client) StopProfiling(ctx context.Context, req *ProfileRequest) (*ProfileResponse, error) {
const (
Method = http.MethodDelete
Path = api.PathProfile
StatusOK = http.StatusOK
)

url, err := url.JoinPath(httpsURL(req.Host), Path)
if err != nil {
return nil, hostError(req.Host, err)
}

r, err := http.NewRequestWithContext(ctx, Method, url, nil)
if err != nil {
return nil, hostError(req.Host, err)
}
r.Header.Add(headers.Accept, headers.ContentTypeAppAny)
r.Header.Add(headers.Accept, headers.ContentEncodingGZIP)

resp, err := c.direct.Do(r)
if err != nil {
return nil, hostError(req.Host, err)
}
if resp.StatusCode != StatusOK {
defer resp.Body.Close()
return nil, hostError(req.Host, readError(resp))
}

// Decompress the response body if the HTTP client doesn't
// decompress automatically.
body := resp.Body
if resp.Header.Get(headers.ContentEncoding) == headers.ContentEncodingGZIP {
z, err := gzip.NewReader(body)
if err != nil {
resp.Body.Close()
return nil, hostError(req.Host, err)
}
body = gzipReadCloser{
gzip: z,
closer: body,
}
}
return &ProfileResponse{
Body: body,
}, nil
}

// ClusterStatus returns status information about the entire KMS cluster.
// The returned ClusterStatusResponse contains status information for all
// nodes within the cluster. It requires SysAdmin privileges.
Expand Down Expand Up @@ -558,6 +704,7 @@ func (c *Client) ReadDB(ctx context.Context) (*ReadDBResponse, error) {
return nil, hostError(host, err)
}
if resp.StatusCode != StatusOK {
defer resp.Body.Close()
return nil, hostError(host, readError(resp))
}

Expand All @@ -567,6 +714,7 @@ func (c *Client) ReadDB(ctx context.Context) (*ReadDBResponse, error) {
if resp.Header.Get(headers.ContentEncoding) == headers.ContentEncodingGZIP {
z, err := gzip.NewReader(body)
if err != nil {
resp.Body.Close()
return nil, hostError(host, err)
}
body = gzipReadCloser{
Expand Down
2 changes: 2 additions & 0 deletions kms/internal/api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ const (
PathHealthStatus = "/v1/health/status"
PathHealthAPIs = "/v1/health/api"

PathProfile = "/v1/debug/pprof"

PathDB = "/v1/db"
PathKMS = "/v1/kms/"

Expand Down
4 changes: 2 additions & 2 deletions kms/protobuf/request.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 3ce6c70

Please sign in to comment.