Skip to content
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

docs: Add notice about heap profiling #3494

Merged
merged 1 commit into from
Aug 19, 2024
Merged

docs: Add notice about heap profiling #3494

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
2 changes: 2 additions & 0 deletions docs/sources/configure-client/language-sdks/dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The .NET Profiler supports the following profiling types:
* Allocations
* Lock contention
* Exceptions
* Live heap (requires .NET 7+)

### Compatibility

Expand Down Expand Up @@ -171,6 +172,7 @@ Here is a simple [example](https://github.com/grafana/pyroscope/blob/main/exampl
| PYROSCOPE_PROFILING_EXCEPTION_ENABLED | Boolean | If set to true, enables the Exceptions profiling. Defaults to false. |
| PYROSCOPE_PROFILING_ALLOCATION_ENABLED | Boolean | If set to true, enables the Allocations profiling. Defaults to false. |
| PYROSCOPE_PROFILING_LOCK_ENABLED | Boolean | If set to true, enables the Lock Contention profiling. Defaults to false. |
| PYROSCOPE_PROFILING_HEAP_ENABLED | Boolean | If set to true, enables the Live heap profiling. Requires .NET 7+. Defaults to false. |
| PYROSCOPE_BASIC_AUTH_USER | String | For HTTP Basic Authentication, use this to send profiles to authenticated server, for example Grafana Cloud |
| PYROSCOPE_BASIC_AUTH_PASSWORD | String | For HTTP Basic Authentication, use this to send profiles to authenticated server, for example Grafana Cloud |
| PYROSCOPE_TENANT_ID | String | Only needed if using multi-tenancy in Pyroscope. |
Expand Down
34 changes: 17 additions & 17 deletions docs/sources/view-and-analyze-profile-data/profiling-types/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,23 @@ For information on auto-instrumentation and supported language SDKs, refer to [C
Various languages support different profiling types.
Pyroscope supports the following profiling types:

| Profile Type | Go | Java | .NET | Ruby | Python | Rust | Node.js | eBPF (Go) | eBPF (Python) |
|--------------------|-------|-------|-------|-------|--------|-------|---------|-----------|--------------|
| CPU | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Alloc Objects | Yes | Yes | Yes | | | | | | |
| Alloc Space | Yes | Yes | Yes | | | | | | |
| Inuse Objects | Yes | | | | | | | | |
| Inuse Space | Yes | | | | | | | | |
| Goroutines | Yes | | | | | | | | |
| Mutex Count | Yes | | Yes | | | | | | |
| Mutex Duration | Yes | | Yes | | | | | | |
| Block Count | Yes | | | | | | | | |
| Block Duration | Yes | | | | | | | | |
| Lock Count | | Yes | Yes | | | | | | |
| Lock Duration | | Yes | Yes | | | | | | |
| Exceptions | | | Yes | | | | | | |
| Wall | | | Yes | | | | | | |
| Heap | | | | | | | Yes | | |
| Profile Type | Go | Java | .NET | Ruby | Python | Rust | Node.js | eBPF (Go) | eBPF (Python)|
|--------------------|-------|-------|------------|-------|--------|-------|---------|-----------|--------------|
| CPU | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Alloc Objects | Yes | Yes | Yes | | | | | | |
| Alloc Space | Yes | Yes | Yes | | | | | | |
| Inuse Objects | Yes | | Yes (7.0+) | | | | | | |
| Inuse Space | Yes | | Yes (7.0+) | | | | | | |
| Goroutines | Yes | | | | | | | | |
| Mutex Count | Yes | | Yes | | | | | | |
| Mutex Duration | Yes | | Yes | | | | | | |
| Block Count | Yes | | | | | | | | |
| Block Duration | Yes | | | | | | | | |
| Lock Count | | Yes | Yes | | | | | | |
| Lock Duration | | Yes | Yes | | | | | | |
| Exceptions | | | Yes | | | | | | |
| Wall | | | Yes | | | | | | |
| Heap | | | | | | | Yes | | |

## CPU profiling

Expand Down
Loading