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

Merged
merged 20 commits into from
Nov 22, 2024

Conversation

dehaansa
Copy link
Contributor

@dehaansa dehaansa commented Nov 12, 2024

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
#2075

PR Checklist

  • CHANGELOG.md updated
  • Documentation added

@dehaansa dehaansa requested review from clayton-cornell and a team as code owners November 12, 2024 21:57
docs/sources/configure/windows.md Outdated Show resolved Hide resolved
docs/sources/configure/windows.md Outdated Show resolved Hide resolved
docs/sources/configure/windows.md Outdated Show resolved Hide resolved
docs/sources/configure/windows.md Outdated Show resolved Hide resolved

Refer to the [Go runtime][runtime] documentation for more information about Go runtime environment variables.

# Windows Service Configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Windows Service Configuration
## Windows Service Configuration

We can only have one H! heading per topic.

Also... do we really need this Windows-specific info here? What about Linux and MacOS? If we add specific instructions for Windows we should consider the same for the other supported OSes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the windows specific information for now.

Copy link
Contributor

Choose a reason for hiding this comment

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

I added this to a liked issue so I don't forget to eventually add the Env Var details.

docs/sources/reference/cli/environment-variables.md Outdated Show resolved Hide resolved
docs/sources/reference/cli/environment-variables.md Outdated Show resolved Hide resolved
docs/sources/reference/cli/environment-variables.md Outdated Show resolved Hide resolved
docs/sources/reference/cli/environment-variables.md Outdated Show resolved Hide resolved
docs/sources/reference/cli/environment-variables.md Outdated Show resolved Hide resolved
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 20, 2024
Copy link
Collaborator

@mattdurham mattdurham left a comment

Choose a reason for hiding this comment

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

LGTM

@mattdurham mattdurham merged commit 3b57159 into grafana:main Nov 22, 2024
15 checks passed
@dehaansa dehaansa deleted the enh/support-bundle-env branch November 22, 2024 19:01
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants