testing: clarify tracing requirements (#4063)

I missed that you need to explicitly create a server
using http.DefaultServeMux.
pull/4109/head
Johan Brandhorst-Satzkorn 2 years ago committed by GitHub
parent 11d4211f30
commit fa7813d800
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,18 +1,27 @@
# Tracing in Boundary
Boundary includes a small number of runtime tracing user regions, which can be used to see where Boundary spends its time during execution.
To create a trace, we first need to expose the pprof endpoint. It is disabled by default. Exposing the pprof endpoint is as simple as importing the correct package anywhere in Boundary:
To create a trace, we first need to expose the pprof endpoint. It is disabled by default. Exposing the pprof endpoint is as simple as importing the correct package and starting a HTTP server anywhere in Boundary:
```go
package anything
import (
"log"
"net/http"
_ "net/http/pprof"
)
...
go func() {
log.Println(http.ListenAndServe("localhost:6060", nil))
}()
...
```
This will create a new HTTP endpoint on `localhost:6060` of the running binary. As such, it's only accessible to the users on the same machine.
Remember to remove this import again once you're done testing.
Remember to remove this code again once you're done testing.
To create a trace, one can use any tool that allows creating HTTP requests, e.g. `curl`. To create a 3 second trace:

Loading…
Cancel
Save