Skip to content

Commit

Permalink
Merge branch 'feat/support-bundle' of github.com:dehaansa/alloy into …
Browse files Browse the repository at this point in the history
…feat/support-bundle
  • Loading branch information
dehaansa committed Nov 5, 2024
2 parents c04efb3 + b95a248 commit 91c2fb0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/sources/troubleshoot/support_bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ about a running {{< param "PRODUCT_NAME" >}} instance, and can be used as a base
to debug an issue.

{{< admonition type="note" >}}
By default this endpoint is enabled, but may be disabled using the `--disable-support-bundle` runtime flag.
This endpoint is enabled by default, but may be disabled using the `--disable-support-bundle` runtime flag.
{{< /admonition >}}

The duration parameter is optional, must be less than or equal to the
configured HTTP server write timeout, and if not provided, defaults to it.
The endpoint is only exposed to {{< param "PRODUCT_NAME" >}}'s HTTP server listen address, which
The endpoint is only exposed to the {{< param "PRODUCT_NAME" >}} HTTP server listen address, which
defaults to `localhost:12345`.

The support bundle contains all information in plain text, so that it can be
inspected before sharing, to verify that no sensitive information has leaked.
The support bundle contains all information in plain text, so you can
inspect it before sharing to verify that no sensitive information has leaked.

In addition, you can inspect the [supportbundle implementation](https://github.com/grafana/alloy/tree/internal/service/http/supportbundle.go)
to verify the code that is being used to generate these bundles.
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
Expand Down

0 comments on commit 91c2fb0

Please sign in to comment.