Implement an initial version of the support bundle in Alloy #2009

dehaansa · 2024-10-31T04:22:01Z

PR Description

Port the Support Bundle from the Agent repository & update it for Alloy.

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

CHANGELOG.md updated
Documentation added
Tests updated

docs/sources/troubleshoot/support_bundle.md

Co-authored-by: Clayton Cornell <[email protected]>

clayton-cornell · 2024-11-04T18:32:32Z

Over to @grafana/grafana-alloy-maintainers for a code review

wildum

Awesome! Thanks for adding this, the code and docs are very clear and easy to follow :) Did you get the chance to test it on windows and with fleet management?

docs/sources/troubleshoot/support_bundle.md

internal/service/http/http.go

docs/sources/troubleshoot/support_bundle.md

…feat/support-bundle

dehaansa · 2024-11-05T21:50:24Z

Awesome! Thanks for adding this, the code and docs are very clear and easy to follow :) Did you get the chance to test it on windows and with fleet management?

I did not have a chance to test in windows/FM. Will connect with you tomorrow to discuss options, I don't have a windows environment set up (or know how to access a shared one yet)

wildum · 2024-11-06T22:15:40Z

Tested on Windows, it works well :) fyi if there are no logs during the recording time the log file won't be generated (which is ok imo)

thampiotr

That's looking really good, can't wait to have this in user's hands!

docs/sources/reference/cli/run.md

thampiotr · 2024-11-07T14:46:33Z

docs/sources/troubleshoot/support_bundle.md

+In addition, you can inspect the [supportbundle implementation](https://github.com/grafana/alloy/tree/internal/service/http/supportbundle.go)
+to verify the code used to generate these bundles.
+
+A support bundle contains the following data:


This will do to support questions what 🚒 does to 🔥
🎉

docs/sources/troubleshoot/support_bundle.md

internal/alloycli/cmd_run.go

internal/runtime/logging/logger.go

thampiotr · 2024-11-07T14:59:33Z

internal/service/http/http.go

-	tracer   trace.TracerProvider
-	gatherer prometheus.Gatherer
-	opts     Options
+	log *logging.Logger


Maybe we can rename this somehow? globalLogger?
A comment that it's only used to set temporary writer etc would be nice to make it easier to figure out.

internal/service/http/http.go

thampiotr · 2024-11-07T15:06:11Z

internal/service/http/http.go

+	s.log.SetTemporaryWriter(syncBuff)
+	defer func() {
+		s.log.RemoveTemporaryWriter()
+	}()


Won't multiple concurrent calls to this /-/support race on these?
Do we need a mutex for the whole call?

Co-authored-by: Piotr <[email protected]>

clayton-cornell · 2024-11-07T17:29:35Z

docs/sources/troubleshoot/support_bundle.md

+weight: 300
+---
+
+# Generate Support Bundle


Will this be released as Public preview?

If yes, then we probably should add the Public preview bits at the top of the doc topic.

<span class="badge docs-labels__stage docs-labels__item">Public preview</span> # Generate Support Bundle {{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

Should we use the shared component for public_preview? The language doesn't seem quite right for this feature

Oooh good point. Lets switch to the generic one instead. We could use this in its place:

{{< docs/public-preview product="Generate support bundle" >

https://grafana.com/docs/writers-toolkit/write/shortcodes/#docspublic-preview (if it's behind a feature flag, there's a block for that too)

This will create a Note block that says:

Generate support bundle is currently in public preview. Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.

clayton-cornell

Some minor tweaks to the docs. Otherwise looks good.

docs/sources/troubleshoot/support_bundle.md

Co-authored-by: Clayton Cornell <[email protected]>

clayton-cornell · 2024-11-07T20:33:38Z

docs/sources/troubleshoot/support_bundle.md

+
+# Generate a support bundle
+
+{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}


Suggested change

{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

{{< docs/public-preview product="Generate support bundle" >}}

thampiotr

LGTM, one last question, but happy to change docs in a follow-up.

CHANGELOG.md

* Implement an initial version of the support bundle in Alloy * Add documentation for support bundle * Update changelog * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Initial PR feedback * Rewrite http service to use logging library internal to alloy * Revert accidental commit of e2e test changes * Fix comment on exported function * Clean up added host variable that is no longer used * Refactor usage of logger in http service * Update internal/service/http/http.go Co-authored-by: Piotr <[email protected]> * implement PR feedback * Hide support bundle behind public preview stability level * Update docs based on feedback * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * More PR feedback in docs * Fix race condition in logger * Add a note about backward-compatibility exception --------- Co-authored-by: Clayton Cornell <[email protected]> Co-authored-by: Piotr <[email protected]>

* update changelog version * Prototype targets.merge function (array.combine_maps) (#1826) * Prototype map.inner_join function * Rename to "targets.merge", remove unnecessary params * Add failure tests * Delete incorrect comment * rename targets.merge to array.combine_maps, mark it as experimental, make is more permissive and add tests * update changelog * Update CHANGELOG.md Co-authored-by: Piotr <[email protected]> * Update docs/sources/reference/stdlib/array.md Co-authored-by: Piotr <[email protected]> * Update docs/sources/reference/stdlib/array.md Co-authored-by: Piotr <[email protected]> * Update docs/sources/reference/stdlib/array.md Co-authored-by: Piotr <[email protected]> * rename mapCombine to combineMaps * document panic * add equal test * add more tests * Update syntax/internal/stdlib/stdlib.go Co-authored-by: Piotr <[email protected]> * Update syntax/internal/stdlib/stdlib.go Co-authored-by: Piotr <[email protected]> * add examples in doc * fix error propagation * remove value nul on len function * refactor code into a traversal function * update doc to avoid modifying the experimental shared doc --------- Co-authored-by: William Dumont <[email protected]> Co-authored-by: Piotr <[email protected]> * Implement an initial version of the support bundle in Alloy (#2009) * Implement an initial version of the support bundle in Alloy * Add documentation for support bundle * Update changelog * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Initial PR feedback * Rewrite http service to use logging library internal to alloy * Revert accidental commit of e2e test changes * Fix comment on exported function * Clean up added host variable that is no longer used * Refactor usage of logger in http service * Update internal/service/http/http.go Co-authored-by: Piotr <[email protected]> * implement PR feedback * Hide support bundle behind public preview stability level * Update docs based on feedback * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/troubleshoot/support_bundle.md Co-authored-by: Clayton Cornell <[email protected]> * More PR feedback in docs * Fix race condition in logger * Add a note about backward-compatibility exception --------- Co-authored-by: Clayton Cornell <[email protected]> Co-authored-by: Piotr <[email protected]> --------- Co-authored-by: Paulin Todev <[email protected]> Co-authored-by: William Dumont <[email protected]> Co-authored-by: Sam DeHaan <[email protected]> Co-authored-by: Clayton Cornell <[email protected]>

dehaansa added 3 commits October 30, 2024 23:49

Implement an initial version of the support bundle in Alloy

fb413ab

Add documentation for support bundle

be6e95b

Update changelog

479291e

dehaansa requested review from clayton-cornell and a team as code owners October 31, 2024 04:22

Merge branch 'main' into feat/support-bundle

efec44a

clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Nov 1, 2024

Merge branch 'main' into feat/support-bundle

131b90b

clayton-cornell reviewed Nov 1, 2024

View reviewed changes

dehaansa and others added 4 commits November 4, 2024 09:34

Update docs/sources/troubleshoot/support_bundle.md

8576be3

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

402b477

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

f22f663

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

b95a248

Co-authored-by: Clayton Cornell <[email protected]>

clayton-cornell requested a review from a team November 4, 2024 18:31

wildum reviewed Nov 5, 2024

View reviewed changes

dehaansa added 7 commits November 5, 2024 14:24

Initial PR feedback

c04efb3

Merge branch 'feat/support-bundle' of github.com:dehaansa/alloy into …

91c2fb0

…feat/support-bundle

Rewrite http service to use logging library internal to alloy

e4d8deb

Revert accidental commit of e2e test changes

657bd04

Fix comment on exported function

7307d16

Clean up added host variable that is no longer used

3740c27

Merge branch 'main' into feat/support-bundle

93ada94

Refactor usage of logger in http service

ff6412f

dehaansa requested a review from wildum November 6, 2024 18:53

wildum approved these changes Nov 7, 2024

View reviewed changes

thampiotr reviewed Nov 7, 2024

View reviewed changes

Update internal/service/http/http.go

e8a30d5

Co-authored-by: Piotr <[email protected]>

clayton-cornell reviewed Nov 7, 2024

View reviewed changes

dehaansa added 4 commits November 7, 2024 13:35

Merge branch 'main' into feat/support-bundle

8ff98a0

implement PR feedback

a1cd13a

Hide support bundle behind public preview stability level

f4fc921

Update docs based on feedback

3d5f9af

dehaansa requested review from thampiotr and clayton-cornell November 7, 2024 19:27

clayton-cornell approved these changes Nov 7, 2024

View reviewed changes

dehaansa and others added 6 commits November 7, 2024 15:09

Update docs/sources/troubleshoot/support_bundle.md

88c4224

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

f23481f

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

1755e9d

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

f10ac8e

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

034265c

Co-authored-by: Clayton Cornell <[email protected]>

Update docs/sources/troubleshoot/support_bundle.md

f5fd0d0

Co-authored-by: Clayton Cornell <[email protected]>

clayton-cornell reviewed Nov 7, 2024

View reviewed changes

More PR feedback in docs

a8e01da

thampiotr approved these changes Nov 11, 2024

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

thampiotr added 2 commits November 11, 2024 12:18

Fix race condition in logger

62b2736

Add a note about backward-compatibility exception

3599ef9

thampiotr enabled auto-merge (squash) November 11, 2024 12:27

thampiotr merged commit 3cf2bcd into grafana:main Nov 11, 2024
15 checks passed

dehaansa mentioned this pull request Nov 12, 2024

[supportbundle] Record live debugging output from the support bundle duration #2068

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement an initial version of the support bundle in Alloy #2009

Implement an initial version of the support bundle in Alloy #2009

dehaansa commented Oct 31, 2024

clayton-cornell commented Nov 4, 2024

wildum left a comment

dehaansa commented Nov 5, 2024

wildum commented Nov 6, 2024

thampiotr left a comment

thampiotr Nov 7, 2024

thampiotr Nov 7, 2024

thampiotr Nov 7, 2024

clayton-cornell Nov 7, 2024

dehaansa Nov 7, 2024

clayton-cornell Nov 7, 2024 •

edited

Loading

clayton-cornell left a comment

clayton-cornell Nov 7, 2024

thampiotr left a comment


		# Generate a support bundle

		{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

	{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
	{{< docs/public-preview product="Generate support bundle" >}}

Implement an initial version of the support bundle in Alloy #2009

Implement an initial version of the support bundle in Alloy #2009

Conversation

dehaansa commented Oct 31, 2024

PR Description

Which issue(s) this PR fixes

Notes to the Reviewer

PR Checklist

clayton-cornell commented Nov 4, 2024

wildum left a comment

Choose a reason for hiding this comment

dehaansa commented Nov 5, 2024

wildum commented Nov 6, 2024

thampiotr left a comment

Choose a reason for hiding this comment

thampiotr Nov 7, 2024

Choose a reason for hiding this comment

thampiotr Nov 7, 2024

Choose a reason for hiding this comment

thampiotr Nov 7, 2024

Choose a reason for hiding this comment

clayton-cornell Nov 7, 2024

Choose a reason for hiding this comment

dehaansa Nov 7, 2024

Choose a reason for hiding this comment

clayton-cornell Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

clayton-cornell left a comment

Choose a reason for hiding this comment

clayton-cornell Nov 7, 2024

Choose a reason for hiding this comment

thampiotr left a comment

Choose a reason for hiding this comment

clayton-cornell Nov 7, 2024 •

edited

Loading