|
| 1 | +#Generate and upload a Support Bundle to Coder Support |
| 2 | + |
| 3 | +When you engage with Coder support to diagnose an issue with your deployment, |
| 4 | +you may be asked to generate and upload a "Support Bundle" for offline analysis. |
| 5 | +This document explains the contents of a support bundle and the steps to submit |
| 6 | +a support bundle to Coder staff. |
| 7 | + |
| 8 | +##What is a Support Bundle? |
| 9 | + |
| 10 | +A support bundle is an archive containing a snapshot of information about your |
| 11 | +Coder deployment. |
| 12 | + |
| 13 | +It contains information about the workspace, the template it uses, running |
| 14 | +agents in the workspace, and other detailed information useful for |
| 15 | +troubleshooting. |
| 16 | + |
| 17 | +It is primarily intended for troubleshooting connectivity issues to workspaces, |
| 18 | +but can be useful for diagnosing other issues as well. |
| 19 | + |
| 20 | +**While we attempt to redact sensitive information from support bundles, they |
| 21 | +may contain information deemed sensitive by your organization and should be |
| 22 | +treated as such.** |
| 23 | + |
| 24 | +A brief overview of all files contained in the bundle is provided below: |
| 25 | + |
| 26 | +>Note: detailed descriptions of all the information available in the bundle is |
| 27 | +>out of scope, as support bundles are primarily intended for internal use. |
| 28 | +
|
| 29 | +| Filename| Description| |
| 30 | +| ---------------------------------| ------------------------------------------------------------------------------------------------| |
| 31 | +|`agent/agent.json`| The agent used to connect to the workspace with environment variables stripped.| |
| 32 | +|`agent/agent_magicsock.html`| The contents of the HTTP debug endpoint of the agent's Tailscale connection.| |
| 33 | +|`agent/client_magicsock.html`| The contents of the HTTP debug endpoint of the client's Tailscale connection.| |
| 34 | +|`agent/listening_ports.json`| The listening ports detected by the selected agent running in the workspace.| |
| 35 | +|`agent/logs.txt`| The logs of the selected agent running in the workspace.| |
| 36 | +|`agent/manifest.json`| The manifest of the selected agent with environment variables stripped.| |
| 37 | +|`agent/startup_logs.txt`| Startup logs of the workspace agent.| |
| 38 | +|`agent/prometheus.txt`| The contents of the agent's Prometheus endpoint.| |
| 39 | +|`cli_logs.txt`| Logs from running the`coder support bundle` command.| |
| 40 | +|`deployment/buildinfo.json`| Coder version and build information.| |
| 41 | +|`deployment/config.json`| Deployment[configuration](../api/general.md#get-deployment-config), with secret values removed.| |
| 42 | +|`deployment/experiments.json`| Any[experiments](../cli/server.md#experiments) currently enabled for the deployment.| |
| 43 | +|`deployment/health.json`| A snapshot of the[health status](../admin/healthcheck.md) of the deployment.| |
| 44 | +|`logs.txt`| Logs from the`codersdk.Client` used to generate the bundle.| |
| 45 | +|`network/connection_info.json`| Information used by workspace agents used to connect to Coder (DERP map etc.)| |
| 46 | +|`network/coordinator_debug.html`| Peers currently connected to each Coder instance and the tunnels established between peers.| |
| 47 | +|`network/netcheck.json`| Results of running`coder netcheck` locally.| |
| 48 | +|`network/tailnet_debug.html`| Tailnet coordinators, their heartbeat ages, connected peers, and tunnels.| |
| 49 | +|`workspace/build_logs.txt`| Build logs of the selected workspace.| |
| 50 | +|`workspace/workspace.json`| Details of the selected workspace.| |
| 51 | +|`workspace/parameters.json`| Build parameters of the selected workspace.| |
| 52 | +|`workspace/template.json`| The template currently in use by the selected workspace.| |
| 53 | +|`workspace/template_file.zip`| The source code of the template currently in use by the selected workspace.| |
| 54 | +|`workspace/template_version.json`| The template version currently in use by the selected workspace.| |
| 55 | + |
| 56 | +##How do I generate a Support Bundle? |
| 57 | + |
| 58 | +1. Ensure your deployment is up and running. Generating a support bundle |
| 59 | + requires the Coder deployment to be available. |
| 60 | + |
| 61 | +2. Ensure you have the Coder CLI installed on a local machine. See |
| 62 | + (installation)[../install/index.md] for steps on how to do this. |
| 63 | + |
| 64 | +>Note: It is recommended to generate a support bundle from a location |
| 65 | +>experiencing workspace connectivity issues. |
| 66 | +
|
| 67 | +3. Ensure you are[logged in](../cli/login.md#login) to your Coder deployment as |
| 68 | + a user with the Owner privilege. |
| 69 | + |
| 70 | +4. Run`coder support bundle [owner/workspace]`, and respond`yes` to the |
| 71 | + prompt. The support bundle will be generated in the current directory with |
| 72 | + the filename`coder-support-$TIMESTAMP.zip`. |
| 73 | + |
| 74 | +>While support bundles can be generated without a running workspace, it is |
| 75 | +>recommended to specify one to maximize troubleshooting information. |
| 76 | +
|
| 77 | +5. (Recommended) Extract the support bundle and review its contents, redacting |
| 78 | + any information you deem necessary. |
| 79 | + |
| 80 | +6. Coder staff will provide you a link where you can upload the bundle along |
| 81 | + with any other necessary supporting files. |
| 82 | + |
| 83 | +>Note: It is helpful to leave an informative message regarding the nature of |
| 84 | +>supporting files. |
| 85 | +
|
| 86 | +Coder support will then review the information you provided and respond to you |
| 87 | +with next steps. |