mirror of
https://github.com/google/gops.git
synced 2025-02-19 19:59:55 +02:00
117 lines
2.4 KiB
Markdown
117 lines
2.4 KiB
Markdown
# gops [](https://travis-ci.org/google/gops) [](https://godoc.org/github.com/google/gops/agent)
|
|
|
|
gops is a command to list and diagnose Go processes currently running on your system.
|
|
|
|
```
|
|
$ gops
|
|
983 uplink-soecks (/usr/local/bin/uplink-soecks)
|
|
52697 gops (/Users/jbd/bin/gops)
|
|
4132* foops (/Users/jbd/bin/foops)
|
|
51130 gocode (/Users/jbd/bin/gocode)
|
|
```
|
|
|
|
## Installation
|
|
|
|
```
|
|
$ go get -u github.com/google/gops
|
|
```
|
|
|
|
## Diagnostics
|
|
|
|
For processes that starts the diagnostics agent, gops can report
|
|
additional information such as the current stack trace, Go version, memory
|
|
stats, etc.
|
|
|
|
In order to start the diagnostics agent, see the [hello example](https://github.com/google/gops/blob/master/examples/hello/main.go).
|
|
|
|
``` go
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
"time"
|
|
|
|
"github.com/google/gops/agent"
|
|
)
|
|
|
|
func main() {
|
|
if err := agent.Start(); err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
time.Sleep(time.Hour)
|
|
}
|
|
```
|
|
|
|
### Diagnostics manual
|
|
|
|
#### 0. listing all processes
|
|
|
|
To print all go processes, run `gops` without arguments:
|
|
```sh
|
|
$ gops
|
|
983 uplink-soecks (/usr/local/bin/uplink-soecks)
|
|
52697 gops (/Users/jbd/bin/gops)
|
|
4132* foops (/Users/jbd/bin/foops)
|
|
51130 gocode (/Users/jbd/bin/gocode)
|
|
```
|
|
|
|
Note that processes running the agent are marked with `*` next to the PID (e.g. `4132*`).
|
|
|
|
#### 1. stack
|
|
|
|
In order to print the current stack trace from a target program, run the following command:
|
|
|
|
```sh
|
|
$ gops stack -p=<PID>
|
|
|
|
```
|
|
|
|
#### 2. memstats
|
|
|
|
To print the current memory stats, run the following command:
|
|
|
|
```sh
|
|
$ gops memstats -p=<PID>
|
|
```
|
|
|
|
#### 3. pprof
|
|
|
|
gops supports CPU and heap pprof profiles. After reading either heap or CPU profile,
|
|
it shells out to the `go tool pprof` and let you interatively examine the profiles.
|
|
|
|
To enter the CPU profile, run:
|
|
|
|
```sh
|
|
$ gops pprof-cpu -p=<PID>
|
|
```
|
|
|
|
To enter the heap profile, run:
|
|
|
|
```sh
|
|
$ gops pprof-heap -p=<PID>
|
|
```
|
|
|
|
#### 4. gc
|
|
|
|
If you want to force run garbage collection on the target program, run the following command.
|
|
It will block until the GC is completed.
|
|
|
|
```sh
|
|
$ gops gc -p=<PID>
|
|
```
|
|
|
|
#### 5. version
|
|
|
|
gops reports the Go version the target program is built with, if you run the following:
|
|
|
|
```sh
|
|
$ gops version -p=<PID>
|
|
```
|
|
|
|
#### 6. vitals
|
|
|
|
To print the runtime statistics such as number of goroutines and `GOMAXPROCS`, run the following:
|
|
```sh
|
|
$ gops vitals -p=<PID>
|
|
```
|