Skip to content

Commit c40ee84

Browse files
authored
docs: Add notice about heap profiling (#3494)
This was something I noticed we are missing.
1 parent ed5162d commit c40ee84

File tree

2 files changed

+19
-17
lines changed
  • docs/sources
    • configure-client/language-sdks
    • view-and-analyze-profile-data/profiling-types

2 files changed

+19
-17
lines changed

docs/sources/configure-client/language-sdks/dotnet.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The .NET Profiler supports the following profiling types:
2424
* Allocations
2525
* Lock contention
2626
* Exceptions
27+
* Live heap (requires .NET 7+)
2728

2829
### Compatibility
2930

@@ -171,6 +172,7 @@ Here is a simple [example](https://github.com/grafana/pyroscope/blob/main/exampl
171172
| PYROSCOPE_PROFILING_EXCEPTION_ENABLED | Boolean | If set to true, enables the Exceptions profiling. Defaults to false. |
172173
| PYROSCOPE_PROFILING_ALLOCATION_ENABLED | Boolean | If set to true, enables the Allocations profiling. Defaults to false. |
173174
| PYROSCOPE_PROFILING_LOCK_ENABLED | Boolean | If set to true, enables the Lock Contention profiling. Defaults to false. |
175+
| PYROSCOPE_PROFILING_HEAP_ENABLED | Boolean | If set to true, enables the Live heap profiling. Requires .NET 7+. Defaults to false. |
174176
| PYROSCOPE_BASIC_AUTH_USER | String | For HTTP Basic Authentication, use this to send profiles to authenticated server, for example Grafana Cloud |
175177
| PYROSCOPE_BASIC_AUTH_PASSWORD | String | For HTTP Basic Authentication, use this to send profiles to authenticated server, for example Grafana Cloud |
176178
| PYROSCOPE_TENANT_ID | String | Only needed if using multi-tenancy in Pyroscope. |

docs/sources/view-and-analyze-profile-data/profiling-types/_index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,23 @@ For information on auto-instrumentation and supported language SDKs, refer to [C
2727
Various languages support different profiling types.
2828
Pyroscope supports the following profiling types:
2929

30-
| Profile Type | Go | Java | .NET | Ruby | Python | Rust | Node.js | eBPF (Go) | eBPF (Python) |
31-
|--------------------|-------|-------|-------|-------|--------|-------|---------|-----------|--------------|
32-
| CPU | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
33-
| Alloc Objects | Yes | Yes | Yes | | | | | | |
34-
| Alloc Space | Yes | Yes | Yes | | | | | | |
35-
| Inuse Objects | Yes | | | | | | | | |
36-
| Inuse Space | Yes | | | | | | | | |
37-
| Goroutines | Yes | | | | | | | | |
38-
| Mutex Count | Yes | | Yes | | | | | | |
39-
| Mutex Duration | Yes | | Yes | | | | | | |
40-
| Block Count | Yes | | | | | | | | |
41-
| Block Duration | Yes | | | | | | | | |
42-
| Lock Count | | Yes | Yes | | | | | | |
43-
| Lock Duration | | Yes | Yes | | | | | | |
44-
| Exceptions | | | Yes | | | | | | |
45-
| Wall | | | Yes | | | | | | |
46-
| Heap | | | | | | | Yes | | |
30+
| Profile Type | Go | Java | .NET | Ruby | Python | Rust | Node.js | eBPF (Go) | eBPF (Python)|
31+
|--------------------|-------|-------|------------|-------|--------|-------|---------|-----------|--------------|
32+
| CPU | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
33+
| Alloc Objects | Yes | Yes | Yes | | | | | | |
34+
| Alloc Space | Yes | Yes | Yes | | | | | | |
35+
| Inuse Objects | Yes | | Yes (7.0+) | | | | | | |
36+
| Inuse Space | Yes | | Yes (7.0+) | | | | | | |
37+
| Goroutines | Yes | | | | | | | | |
38+
| Mutex Count | Yes | | Yes | | | | | | |
39+
| Mutex Duration | Yes | | Yes | | | | | | |
40+
| Block Count | Yes | | | | | | | | |
41+
| Block Duration | Yes | | | | | | | | |
42+
| Lock Count | | Yes | Yes | | | | | | |
43+
| Lock Duration | | Yes | Yes | | | | | | |
44+
| Exceptions | | | Yes | | | | | | |
45+
| Wall | | | Yes | | | | | | |
46+
| Heap | | | | | | | Yes | | |
4747

4848
## CPU profiling
4949

0 commit comments

Comments
 (0)