jprdonnelly/opentf
1
0
Fork 0
mirror of https://github.com/opentffoundation/opentf.git synced 2025-12-19 17:59:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add TOFU_CPU_PROFILE for enabling go pprof (#2904)

Browse Source 
Signed-off-by: Christian Mesh <christianmesh1@gmail.com>
This commit is contained in:
Christian Mesh
2025-06-16 09:02:54 -04:00
committed by GitHub
parent e389ae3974
commit 59659c8009
2 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
website/docs/cli/config/environment-variables.mdx
View File

@@ -202,3 +202,12 @@ If the key (or similar) has non-alphanumeric characters in it, beware that your
Make sure your secret doesn't get changed by your shell without you realizing. This is also shell dependent, but common ways of avoiding this are using single quotes or escaping special characters with a backslash.
:::
## TOFU_CPU_PROFILE
Set `TOFU_CPU_PROFILE` to instruct OpenTofu to write a [Go pprof file](https://pkg.go.dev/runtime/pprof). These profiles can be used to help developers identify hot-spots in OpenTofu's codebase that slow down execution. It pairs well with the more granular and well structured OpenTelemetry tracing (available in OpenTofu 1.10.0). For more information on profiling in Go, see https://go.dev/blog/pprof. As this uses the go runtime's pprof tooling directly, is not covered under the compatibility promise and is subject to change / removal at any time.
```shell
TOFU_CPU_PROFILE=./tofu.pprof tofu plan
go tool pprof -http ./tofu.pprof
```