Capture configuration files & runtime config in support bundle #2094
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ideally we should replace secret values with a placeholder. |
|
In the old agent one we used a custom yaml marshaller to redact the secrets, I feel we need to also redact the values here. |
clayton-cornell
added
the
type/docs
Co-authored-by: Clayton Cornell <[email protected]>
…alloy into enh/support-bundle-config-file
|
Implemented a POC of redacting secrets in the AST & printer, but I need to consider how it affects the fmt command and other uses of printer. |
|
Looks reasonable but would like to see some tests around and if we need to make the behavior configurable. |
mattdurham
reviewed
Nov 21, 2024
| @@ -45,8 +45,11 @@ A support bundle contains the following data: | |||
| * `alloy-runtime-flags.txt` contains the values of the runtime flags available in {{< param "PRODUCT_NAME" >}}. | |||
| * The `pprof/` directory contains Go runtime profiling data (CPU, heap, goroutine, mutex, block profiles) as exported by the pprof package. | |||
| Refer to the [profile][profile] documentation for more details on how to use this information. | |||
| * The `sources/` directory contains copies of the local configuration files used to configure {{< param "PRODUCT_NAME" >}}. | |||
There was a problem hiding this comment.
Does this include local modules? Totally fine if it doesnt but may want to add a bit more information.
mattdurham
approved these changes
Nov 21, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Add configuration sources (local file & remote config) to the support bundle.
One thing that requires consideration -- this is not currently doing any redaction of the configuration files, should we make this opt-in/opt-out rather than always collected?
Which issue(s) this PR fixes
#2066
Notes to the Reviewer
PR Checklist