Menu
Documentationbreadcrumb arrow Grafana Cloudbreadcrumb arrow Instrument and send databreadcrumb arrow Grafana Alloybreadcrumb arrow Troubleshootbreadcrumb arrow Generate a support bundle
Grafana Cloud

Public preview

Generate a support bundle

Note

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.

The /-/support?duration=N endpoint returns a support bundle, a compressed file that contains information about a running Alloy instance, and can be used as a baseline of information when trying to debug an issue.

This feature isn’t covered by the backward-compatibility guarantees.

Note

This endpoint is enabled by default, but may be disabled using the --disable-support-bundle runtime flag.

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 the Alloy HTTP server listen address, which defaults to localhost:12345.

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 to verify the code used to generate these bundles.

A support bundle contains the following data:

  • alloy-components.json contains information about the components running on this Alloy instance, generated by the /api/v0/web/components endpoint.
  • alloy-logs.txt contains the logs during the bundle generation.
  • alloy-metadata.yaml contains the Alloy build version and the installation’s operating system, architecture, and uptime.
  • alloy-metrics.txt contains a snapshot of the internal metrics for Alloy.
  • alloy-peers.json contains information about the identified cluster peers of this Alloy instance, generated by the /api/v0/web/peers endpoint.
  • alloy-runtime-flags.txt contains the values of the runtime flags available in Alloy.
  • The pprof/ directory contains Go runtime profiling data (CPU, heap, goroutine, mutex, block profiles) as exported by the pprof package. Refer to the profile documentation for more details on how to use this information.