From c40ee842d6a0a11666ad415bfc3d70c2db957b07 Mon Sep 17 00:00:00 2001 From: Christian Simon Date: Mon, 19 Aug 2024 09:03:26 +0100 Subject: [PATCH] docs: Add notice about heap profiling (#3494) This was something I noticed we are missing. --- .../configure-client/language-sdks/dotnet.md | 2 ++ .../profiling-types/_index.md | 34 +++++++++---------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/sources/configure-client/language-sdks/dotnet.md b/docs/sources/configure-client/language-sdks/dotnet.md index 668467d71f..71962698d8 100644 --- a/docs/sources/configure-client/language-sdks/dotnet.md +++ b/docs/sources/configure-client/language-sdks/dotnet.md @@ -24,6 +24,7 @@ The .NET Profiler supports the following profiling types: * Allocations * Lock contention * Exceptions +* Live heap (requires .NET 7+) ### Compatibility @@ -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. | diff --git a/docs/sources/view-and-analyze-profile-data/profiling-types/_index.md b/docs/sources/view-and-analyze-profile-data/profiling-types/_index.md index 97e36b016e..c8b84f2a83 100644 --- a/docs/sources/view-and-analyze-profile-data/profiling-types/_index.md +++ b/docs/sources/view-and-analyze-profile-data/profiling-types/_index.md @@ -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