Skip to content

allocs->heap #883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −11
Open

allocs->heap #883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions running-a-nats-service/configuration/sys_accounts/sys_accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,10 +278,9 @@ Received [_INBOX.DQD44ugVt0O4Ur3pWIOOD1.WQOBevoq] : '{

If profiling is enabled for a server, this service enables requesting it from the server. The request payload must specify the name of the profile being requested with an optional debug level, including:

- `allocs` - 0, 1
- `heap` - 0, 1
- `block` - 0
- `goroutine` - 0, 1, 2
- `heap` - 0, 1
- `mutex` - 0
- `threadcount` - 0

Expand Down
17 changes: 8 additions & 9 deletions running-a-nats-service/nats_admin/profiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ The `--name`, `--tags` and `--cluster` selectors can be used either individually

| Command | Description |
|------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
| `nats server request profile allocs` | Request a memory profile from all servers in the system |
| `nats server request profile allocs ./profiles` | Request a memory profile from all servers in the system and write to the `profiles` directory |
| `nats server request profile allocs --name=servername1` | Request a memory profile from `servername1` only |
| `nats server request profile allocs --tags=aws` | Request a memory profile from all servers tagged as `aws` |
| `nats server request profile allocs --cluster=aws-useast2` | Request a memory profile from all servers in the cluster named `aws-useast2` only |
| `nats server request profile heap` | Request a memory profile from all servers in the system |
| `nats server request profile heap ./profiles` | Request a memory profile from all servers in the system and write to the `profiles` directory |
| `nats server request profile heap --name=servername1` | Request a memory profile from `servername1` only |
| `nats server request profile heap --tags=aws` | Request a memory profile from all servers tagged as `aws` |
| `nats server request profile heap --cluster=aws-useast2` | Request a memory profile from all servers in the cluster named `aws-useast2` only |

#### CPU profile

Expand All @@ -44,6 +44,7 @@ The NATS Server can expose a HTTP `pprof` profiling port, although it must be en
```
prof_port = 65432
```

Note that this option does not support [configuration-reloading](../configuration/#configuration-reloading), so the server must be restarted for the config change to take effect.

Once the profiling port has been enabled, you can download profiles as per the following sections. These profiles can be inspected using [`go tool pprof`](https://pkg.go.dev/net/http/pprof).
Expand All @@ -52,14 +53,14 @@ To see all available profiles, open [http://localhost:65432/debug/pprof/](http:/

#### Memory profile

`http://localhost:65432/debug/pprof/allocs`
`http://localhost:65432/debug/pprof/heap`

This endpoint will return instantly.

For example, to download an allocation profile from NATS running on the same machine:

```shell
curl -o mem.prof http://localhost:65432/debug/pprof/allocs
curl -o mem.prof http://localhost:65432/debug/pprof/heap
```

The profile will be saved into `mem.prof`.
Expand All @@ -77,5 +78,3 @@ curl -o cpu.prof http://localhost:65432/debug/pprof/profile?seconds=30
```

The profile will be saved into `cpu.prof`.