Troubleshooting guides in the form of notebooks and dashboards can help you and your team efficiently resolve problems that are similar to the ones you already encountered in the past and reduce the mean time to repair (MTTR).
You can create and share your own troubleshooting guides in notebooks and dashboards or retrieve the existing guides with the help of Davis CoPilot.
This article is for any users who want to share their troubleshooting experience to help their team quickly remediate active problems in their environment.
In this article, you'll learn how to create your own troubleshooting guide and documents the steps taken to resolve the issue.
If you create a troubleshooting guide directly from the
Dashboards or
Notebooks, you have to prefix the document title with [TSG] to indicate it is a Troubleshooting Guide.
However, dashboards and notebooks created directly from the Problems app are automatically recognized as troubleshooting guides and do not require the [TSG] prefix.
Regardless of how the document was created, it still has to be shared at the environment level to be retrievable by any member of your team.
Problems installed from Hub.ALLOW davis-copilot:document-search:execute; permission. To learn how to set up the permissions, see Permissions in Grail.
Problems.Failure rate increase) to open the problem details page.
Notebooks or Dashboards to create a new document in
Dashboards. This creates a troubleshooting guide from the existing template with a title indicating the type of the document ([TSG], troubleshooting guide) the type of the problem (for example, Failure rate increase).
Davis CoPilot only indexes documents that are recognized as troubleshooting guides. Dashboards and notebooks created directly from the Problems app are automatically recognized as troubleshooting guides and do not require the [TSG] prefix, so you can change the title of the troubleshooting guide as you see fit.
Changes made to each section are saved automatically.
Select Incident summary and select Edit. Fill in the necessary details:
Critical, High, Medium or Low) in Severity level.Error) in Category. You can find the even category in
Problems and on top of the problem details page. To learn more about existing event categories, see Categories of Davis events.Select Initial Response & Detection and select Edit. Provide the information on how the problem was detected, for example:
Select Troubleshooting and select Edit. Provide the information on the methods you used to find the cause of the problem, for example:
A limit that was introduced in the latest deployment led to failure rate increase).Select Remediation Steps and select Edit. Provide a step-by-step playbook on how to fix the issue, for example:
Select Helpful Resources and select Edit. Provide the list of resources that helped you resolve the issue, for example:
If you want Davis CoPilot to suggest your troubleshooting guide to other people in your team, you have to share the document on the environment level. To learn more about sharing documents, see Share documents.
You successfully created your own troubleshooting guide and documented all the steps taken to resolve the issue. Now, you'll be able to refer to the guide if the problem appears again.
If you have shared your guide, you and the others on your team will also have this documented suggested to them in case of encountering similar issues.
Problems