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.

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

Add environment variables to support bundle #2073

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dehaansa
Copy link
Contributor

PR Description

Update the support bundle to collect relevant Golang runtime environment variables.

relevantVariables := []string{
	"AUTOMEMLIMIT",
	"GODEBUG",
	"GOEXPERIMENT",
	"GOGC",
	"GOMAXPROCS",
	"GOMEMLIMIT",
	"HOSTNAME",
	"HTTP_PROXY",
	"HTTPS_PROXY",
	"PPROF_BLOCK_PROFILING_RATE",
	"PPROF_MUTEX_PROFILING_PERCENT",
}

Which issue(s) this PR fixes

#2067

PR Checklist

  • CHANGELOG.md updated
  • Documentation added

@@ -36,6 +36,7 @@ to verify the code used to generate these bundles.
A support bundle contains the following data:
* `alloy-components.json` contains information about the [components][components] running on this {{< param "PRODUCT_NAME" >}} instance, generated by the
`/api/v0/web/components` endpoint.
* `alloy-environment.txt` contains the values of several environment variables relevant to the golang runtime.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's definitely value to add GOGC, HTTPS_PROXY, GOMAXPROCS documentation. AUTOMEMLIMIT is also worth documenting though it's specific to a module that we use, rather than the go runtime itself.

In reviewing documentation I could find elsewhere GOEXPERIMENT is probably not relevant, looks like that's only used at build time so I'll remove that from this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants