SupportBundles: Add support bundle documentation (#61855)

* add support bundle page

* Update docs/sources/troubleshooting/support-bundles/index.md

* Update docs/sources/troubleshooting/support-bundles/index.md

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

* copy edit

* Update docs/sources/troubleshooting/support-bundles/index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

---------

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
This commit is contained in:
Jo
2023-02-07 10:39:47 +01:00
committed by GitHub
parent 3a8f2bb726
commit f6d856f082
3 changed files with 143 additions and 2 deletions

View File

@@ -27,6 +27,12 @@ For more information, refer to [Enable debug logging in Grafana CLI]({{< relref
If you have an issue with your Dashboard panel, you can send us debug information. For more information, refer to [Send a panel to Grafana Labs support]({{< relref "./send-panel-to-grafana-support/" >}}).
## Troubleshoot with support bundles
If you have an issue with your Grafana instance, you can generate an archive containing information concerning the state and the configuration of the instance.
To send us a bundle for advanced support, refer to [Send a support bundle to Grafana Labs support]({{< relref "./support-bundles/" >}}).
## Troubleshoot transformations
Order of transformations matters. If the final data output from multiple transformations looks wrong, try changing the transformation order. Each transformation transforms data returned by the previous transformation, not the original raw data.
@@ -47,5 +53,4 @@ sudo yum install urw-fonts
## FAQs
Check out the [FAQ section](https://community.grafana.com/c/howto/faq) on the Grafana Community page for answers to frequently
asked questions.
Check out the [FAQ section](https://community.grafana.com/c/howto/faq) on the Grafana Community page for answers to frequently asked questions.

View File

@@ -0,0 +1,54 @@
---
description: Learn how to send a support bundle to Grafana Labs support for troubleshooting
keywords:
- grafana
- troubleshooting
- support
- bundles
title: Send a support bundle to Grafana Labs support
menutitle: Send a support bundle to support
weight: 200
---
# Send a support bundle to Grafana Labs support
When you encounter problems with your Grafana instance, you can send us a support bundle that contains information about your Grafana instance, including:
- Grafana version
- Installed plugins
- Grafana configuration
- Deployed database information and migrations
## Available support bundle components
A support bundle can include any of the following components:
- **Usage statistics**: Usage statistic for the Grafana instance
- **User information**: A list of users of the Grafana instance
- **Database and Migration information**: Database information and migration log
- **Plugin information**: Plugin information for the Grafana instance
- **Basic information**: Basic information about the Grafana instance (version, memory usage, and so on)
- **Settings**: Settings for the Grafana instance
- **SAML**: Healthcheck connection and metadata for SAML (only displayed if SAML is enabled)
## Steps
To generate a support bundle and send the support bundle to Grafana Labs via a support ticket:
1. Click the Help icon.
1. Click **Support Bundles**.
![Support bundle panel](/static/img/docs/troubleshooting/support-bundle.png)
1. Click **New Support Bundle**.
1. Select the components that you want to include in the support bundle.
1. Click **Create**.
1. After the support bundle is ready, click **Download**.
Grafana downloads the support bundle to an archive (tar.gz) file.
1. Attach the archive (tar.gz) file to a support ticket that you send to Grafana Labs Technical Support.