Skip to content
Snippets Groups Projects
Unverified Commit ac639eaa authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - download diagnostics (#42930)

parent acbfc6b5
No related branches found
No related tags found
No related merge requests found
---
title: Diagnostic information for troubleshooting
---
# Diagnostic information for troubleshooting
To download diagnostic information, hit `Cmd + F1` on Macs, `Ctrl + F1` on PCs.
Select the info you want to include in the diagnostic JSON file. Options include:
- Item definition (like information about a dashboard)
- Browser error messages
- All server error messages
- All server logs
- Server logs from the current user only
- Metabase instance version information
What data Metabase captures depends on the page you're on when you hit `Cmd/Ctrl + F1`.
> Review the downloaded file before sharing it, as the diagnostic info may contain sensitive data.
## Metabase server and console logs
Metabase will log errors, both on the server and in the browser console, depending on where the error occurs, which can help you track down an issue. Administrators will have access to the server logs, and everyone with a browser can open the developer tools to see the console logs.
**Accessing the Metabase server logs**: You can look for the logs that Metabase leaves on the server's file system (or wherever else you collect logs). If you're logged into Metabase with an Admin account, you can also access the logs by going to the top right of the screen and clicking on the **gear** icon > **Admin settings** > **Troubleshooting** > **Logs**. Check out [How to read the server logs](./server-logs.md)
**Checking for Javascript console errors:** Metabase will send debugging information and errors to your browser's developer console. To open the developer console, follow the instructions for your web browser:
- [Chrome](https://developers.google.com/web/tools/chrome-devtools/open#console)
- [Edge](https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide-chromium)
- [Firefox](https://developer.mozilla.org/en-US/docs/Tools/Web_Console/Opening_the_Web_Console)
- [Safari](https://support.apple.com/guide/safari-developer/develop-menu-dev39df999c1/mac)
**Creating a HAR file**: HAR files record network requests generated by your browser. HAR files can be helpful when troubleshooting issues with Metabase performance. Check out [Creating HAR files for troubleshooting](./create-har-file.md).
......@@ -6,6 +6,11 @@ title: Troubleshooting guides
Problems, their causes, how to detect them, and how to fix them.
## Getting diagnostic info
- [Download diagnostic info](./diagnostic-info.md)
- [Create a HAR file](./create-har-file.md)
## Installation
- [Running the Metabase JAR][running].
......@@ -63,21 +68,6 @@ Problems, their causes, how to detect them, and how to fix them.
See [Requesting new features][feature-request].
## Metabase server and console logs
Metabase will log errors, both on the server and in the browser console, depending on where the error occurs, which can help you track down an issue. Administrators will have access to the server logs, and everyone with a browser can open the developer tools to see the console logs.
**Accessing the Metabase server logs**: You can look for the logs that Metabase leaves on the server's file system (or wherever else you collect logs). If you're logged into Metabase with an Admin account, you can also access the logs by going to the top right of the screen and clicking on the **gear** icon > **Admin settings** > **Troubleshooting** > **Logs**. Check out [How to read the server logs][server-logs].
**Checking for Javascript console errors:** Metabase will send debugging information and errors to your browser's developer console. To open the developer console, follow the instructions for your web browser:
- [Chrome][chrome]
- [Firefox][firefox]
- [Safari][safari]
- [Edge][edge]
**Creating a HAR file**: HAR files record network requests generated by your browser. HAR files can be helpful when troubleshooting issues with Metabase performance. Check out [Creating HAR files for troubleshooting](./create-har-file.md).
## Metabase tutorials
For tutorials that walk you through how to use Metabase features, check out [Learn Metabase][learn].
......@@ -93,16 +83,13 @@ Metabase adds new features and squashes bugs with each release. [Upgrading to th
[appdb]: ./loading-from-h2.md
[bugs]: ./bugs.md
[cant-see-tables]: ./cant-see-tables.md
[chrome]: https://developers.google.com/web/tools/chrome-devtools/open#console
[cloud]: https://www.metabase.com/start/
[db-connection]: ./db-connection.md
[db-performance]: ./db-performance.md
[docker]: ./docker.md
[edge]: https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide-chromium
[error-message]: error-message.md
[feature-request]: requesting-new-features.md
[filters]: ./filters.md
[firefox]: https://developer.mozilla.org/en-US/docs/Tools/Web_Console/Opening_the_Web_Console
[forum]: https://discourse.metabase.com/
[incorrect-times]: ./timezones.md
[known-issues]: ./known-issues.md
......@@ -116,8 +103,6 @@ Metabase adds new features and squashes bugs with each release. [Upgrading to th
[proxies]: ./proxies.md
[releases]: https://github.com/metabase/metabase/releases
[running]: ./running.md
[safari]: https://support.apple.com/guide/safari-developer/develop-menu-dev39df999c1/mac
[server-logs]: ./server-logs.md
[saml]: ./saml.md
[sandbox]: ./sandboxing.md
[slow-dashboard]: ./my-dashboard-is-slow.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment