/
proc
/
3430793
/
root
/
snap
/
lxd
/
current
/
share
/
lxd-documentation
/
debugging
/
File Upload :
llllll
Current File: //proc/3430793/root/snap/lxd/current/share/lxd-documentation/debugging/index.html
<!doctype html> <html class="no-js" lang="en" data-content_root="../"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta property="og:title" content="How to debug LXD" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://documentation.ubuntu.com/lxd/latest/debugging/" /> <meta property="og:site_name" content="LXD documentation" /> <meta property="og:description" content="For information on debugging instance issues, see How to troubleshoot failing instances. Debugging lxc and lxd: Here are different ways to help troubleshooting lxc and lxd code. lxc --debug: Adding..." /> <meta property="og:image" content="https://documentation.ubuntu.com/lxd/latest/_static/tag.png" /> <meta property="og:image:alt" content="LXD documentation" /> <meta name="description" content="For information on debugging instance issues, see How to troubleshoot failing instances. Debugging lxc and lxd: Here are different ways to help troubleshooting lxc and lxd code. lxc --debug: Adding..." /> <link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" /><link rel="next" title="Frequently asked questions" href="../faq/" /><link rel="prev" title="How to troubleshoot (some) Dqlite errors" href="../howto/dqlite_troubleshoot/" /> <link rel="canonical" href="https://documentation.ubuntu.com/lxd/debugging/" /> <link rel="shortcut icon" href="../_static/favicon.ico"/><!-- Generated with Sphinx 8.2.3 and Furo 2025.07.19 --> <title>How to debug LXD</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=25af2a20" /> <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../_static/youtube.css" /> <link rel="stylesheet" type="text/css" href="../_static/related-links.css" /> <link rel="stylesheet" type="text/css" href="../_static/terminal-output.css" /> <link rel="stylesheet" type="text/css" href="../_static/config-options.css" /> <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" /> <link rel="stylesheet" type="text/css" href="../_static/custom.css?v=66d86e9d" /> <link rel="stylesheet" type="text/css" href="../_static/header.css?v=84f70f09" /> <link rel="stylesheet" type="text/css" href="../_static/github_issue_links.css?v=af88fb93" /> <link rel="stylesheet" type="text/css" href="../_static/furo_colors.css?v=c4ccdb8a" /> <link rel="stylesheet" type="text/css" href="../_static/footer.css?v=bd05fc90" /> <link rel="stylesheet" type="text/css" href="../_static/cookie-banner.css?v=b74831ab" /> </head> <body> <header id="header" class="p-navigation"> <script type="module" src="../_static/js/bundle.js"> </script> <!-- Google Tag Manager --> <script> (function(w, d, s, l, i) { w[l] = w[l] || []; w[l].push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' }); var f = d.getElementsByTagName(s)[0]; var j = d.createElement(s); var dl = ''; if (l != 'dataLayer') { dl = '&l=' + l; } j.async = true; j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; f.parentNode.insertBefore(j, f); })(window, document, 'script', 'dataLayer', 'GTM-KNX3CJC'); </script> <div class="p-navigation__nav" role="menubar"> <ul class="p-navigation__links" role="menu"> <li> <a class="p-logo" href="https://canonical.com/lxd" aria-current="page"> <img src="../_static/tag.png" alt="Logo" class="p-logo-image"> <div class="p-logo-text p-heading--4">LXD </div> </a> </li> <li class="nav-ubuntu-com"> <a href="https://canonical.com/lxd" class="p-navigation__link">canonical.com/lxd</a> </li> <li> <a href="#" class="p-navigation__link nav-more-links">More resources</a> <ul class="more-links-dropdown"> <li> <a href="https://ubuntu.com/lxd/install/" class="p-navigation__sub-link p-dropdown__link">Install LXD</a> </li> <li> <a href="https://ubuntu.com/lxd/manage/" class="p-navigation__sub-link p-dropdown__link">Manage LXD</a> </li> <li> <a href="https://discourse.ubuntu.com/c/lxd/" class="p-navigation__sub-link p-dropdown__link">Forum</a> </li> <li> <a href="https://github.com/canonical/lxd" class="p-navigation__sub-link p-dropdown__link">GitHub</a> </li> </ul> </li> </ul> </div> </header> <script> document.body.dataset.theme = localStorage.getItem("theme") || "auto"; </script> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-toc" viewBox="0 0 24 24"> <title>Contents</title> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line> <line x1="3" y1="6" x2="21" y2="6"></line> <line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24"> <title>Light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24"> <title>Dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> </svg> </symbol> <symbol id="svg-sun-with-moon" viewBox="0 0 24 24"> <title>Auto light/dark, in light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-custom-derived-from-feather-sun-and-tabler-moon"> <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/> <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/> <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/> <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/> <line x1="19" y1="14.05" x2="20.414" y2="15.464"/> <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/> <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/> <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/> <line x1="19" y1="5.05" x2="20.414" y2="3.636"/> <circle cx="14.5" cy="9.55" r="3.6"/> </svg> </symbol> <symbol id="svg-moon-with-sun" viewBox="0 0 24 24"> <title>Auto light/dark, in dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-custom-derived-from-feather-sun-and-tabler-moon"> <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/> <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/> <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/> <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/> <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/> <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/> <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/> <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/> <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/> <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/> </svg> </symbol> <symbol id="svg-pencil" viewBox="0 0 24 24"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code"> <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" /> <path d="M13.5 6.5l4 4" /> <path d="M20 21l2 -2l-2 -2" /> <path d="M17 17l-2 2l2 2" /> </svg> </symbol> <symbol id="svg-eye" viewBox="0 0 24 24"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" /> <path d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" /> <path d="M20 21l2 -2l-2 -2" /> <path d="M17 17l-2 2l2 2" /> </svg> </symbol> </svg> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> <label class="overlay sidebar-overlay" for="__navigation"> <div class="visually-hidden">Hide navigation sidebar</div> </label> <label class="overlay toc-overlay" for="__toc"> <div class="visually-hidden">Hide table of contents sidebar</div> </label> <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> <div class="page"> <header class="mobile-header"> <div class="header-left"> <label class="nav-overlay-icon" for="__navigation"> <div class="visually-hidden">Toggle site navigation sidebar</div> <i class="icon"><svg><use href="#svg-menu"></use></svg></i> </label> </div> <div class="header-center"> <a href="../"><div class="brand">LXD</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> </header> <aside class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky"><a class="sidebar-brand" href="../"> </a><form class="sidebar-search-container" method="get" action="../search/" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> <input type="submit" value="Go"> <input type="hidden" name="check_keywords" value="yes"> <input type="hidden" name="area" value="default"> </form> <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../">LXD</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../tutorial/">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../tutorial/first_steps/">First steps with LXD</a></li> <li class="toctree-l2"><a class="reference internal" href="../tutorial/ui/">Getting started with the UI</a></li> </ul> </li> <li class="toctree-l1 current has-children"><a class="reference internal" href="../howto/">How-to guides</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of How-to guides</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2 has-children"><a class="reference internal" href="../getting_started/">Getting started</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Getting started</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../installing/">Install LXD</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/initialize/">Initialize LXD</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/access_ui/">Access the UI</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/access_documentation/">Access documentation locally</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../operation/">LXD server and client</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of LXD server and client</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/server_expose/">Expose LXD to the network</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/server_configure/">Configure the LXD server</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/oidc_auth0/">Configure OIDC authentication with Auth0</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/oidc_ory/">Configure OIDC authentication with Ory Hydra</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/oidc_keycloak/">Configure OIDC authentication with Keycloak</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/oidc_entra_id/">Configure OIDC authentication with Microsoft Entra ID</a></li> <li class="toctree-l3"><a class="reference internal" href="../remotes/">Add remote servers</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/lxc_alias/">Add command aliases</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../instances/">Instances</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Instances</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_create/">Create instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_configure/">Configure instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_manage/">Manage instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../profiles/">Use profiles</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_troubleshoot/">Troubleshoot errors</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_ubuntu_pro_attach/">Auto attach Ubuntu Pro</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_access_files/">Access files</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_console/">Access the console</a></li> <li class="toctree-l3"><a class="reference internal" href="../instance-exec/">Run commands</a></li> <li class="toctree-l3"><a class="reference internal" href="../cloud-init/">Use cloud-init</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_routed_nic_vm/">Add a routed NIC to a VM</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_backup/">Back up instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_migrate/">Migrate instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/import_machines_to_instances/">Import existing machines</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/container_gpu_passthrough_with_docker/">Pass NVIDIA GPUs</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../images/">Images</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Images</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/images_remote/">Use remote images</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/images_manage/">Manage images</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/images_profiles/">Associate profiles</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/images_copy/">Copy and import images</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/images_create/">Create images</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../projects/">Projects</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of Projects</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/projects_create/">Create and configure</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/projects_work/">Work with projects</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/projects_confine/">Confine users to projects</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../storage/">Storage</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Storage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/storage_pools/">Manage pools</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/storage_volumes/">Manage volumes</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/storage_buckets/">Manage buckets</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/storage_create_instance/">Create an instance in a pool</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/storage_backup_volume/">Back up a volume</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/storage_move_volume/">Move or copy a volume</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../networks/">Networking</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of Networking</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/network_create/">Create a network</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_configure/">Configure a network</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_bgp/">Configure as BGP server</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_acls/">Configure network ACLs</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_forwards/">Configure forwards</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_zones/">Configure network zones</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_firewalld/">Configure your firewall</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_resolved/">Integrate with resolved</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_ovn_setup/">Set up OVN</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_load_balancers/">Configure load balancers</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_ovn_peers/">Configure peer routing</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_ipam/">Display IPAM information</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../clustering/">Clustering</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of Clustering</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_form/">Form a cluster</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_manage/">Manage a cluster</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_config_networks/">Configure networks</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_config_storage/">Configure storage</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_manage_instance/">Manage instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_groups/">Set up cluster groups</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/cluster_recover/">Recover a cluster</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../production-setup/">Production setup</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of Production setup</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../howto/benchmark_performance/">Benchmark performance</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/network_increase_bandwidth/">Increase bandwidth</a></li> <li class="toctree-l3"><a class="reference internal" href="../metrics/">Monitor metrics</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/logs_loki/">Send logs to Loki</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/grafana/">Set up Grafana</a></li> <li class="toctree-l3"><a class="reference internal" href="../backup/">Back up a server</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/disaster_recovery/">Recover instances</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../howto/snap/">Manage the snap</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="../howto/troubleshoot/">Troubleshooting</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of Troubleshooting</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_firewalld/">Configure your firewall</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/instances_troubleshoot/">Troubleshoot instances</a></li> <li class="toctree-l3"><a class="reference internal" href="../howto/dqlite_troubleshoot/">Troubleshoot Dqlite</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">Debug LXD</a></li> <li class="toctree-l3"><a class="reference internal" href="../faq/">Frequently asked</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../support/">Get support</a></li> <li class="toctree-l2"><a class="reference internal" href="../contributing/">Contribute to LXD</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../explanation/">Explanation</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle navigation of Explanation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../explanation/lxd_lxc/"><code class="docutils literal notranslate"><span class="pre">lxd</span></code> and <code class="docutils literal notranslate"><span class="pre">lxc</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/instances/">Containers and VMs</a></li> <li class="toctree-l2"><a class="reference internal" href="../image-handling/">Local and remote images</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/storage/">Storage pools, volumes, and buckets</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/networks/">Networking setups</a></li> <li class="toctree-l2"><a class="reference internal" href="../database/">The LXD Dqlite database</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/lxc_show_info/"><code class="docutils literal notranslate"><span class="pre">lxc</span></code> <code class="docutils literal notranslate"><span class="pre">show</span></code> and <code class="docutils literal notranslate"><span class="pre">info</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="../authentication/">Remote API authentication</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/authorization/">Remote API authorization</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/projects/">Instances grouping with projects</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/clusters/">Clusters</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/performance_tuning/">Performance tuning</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/security/">Security</a></li> <li class="toctree-l2"><a class="reference internal" href="../explanation/bpf/">Privilege delegation using BPF Token</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../reference/">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><div class="visually-hidden">Toggle navigation of Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../requirements/">Requirements</a></li> <li class="toctree-l2"><a class="reference internal" href="../architectures/">Architectures</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/releases-snap/">Releases and snap</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/remote_image_servers/">Remote image servers</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/image_format/">Image format</a></li> <li class="toctree-l2"><a class="reference internal" href="../guest-os-compatibility/">Guest OS compatibility</a></li> <li class="toctree-l2"><a class="reference internal" href="../container-environment/">Container environment</a></li> <li class="toctree-l2"><a class="reference internal" href="../config-options/">Configuration option index</a></li> <li class="toctree-l2"><a class="reference internal" href="../server/">Server configuration</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../explanation/instance_config/">Instance configuration</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><div class="visually-hidden">Toggle navigation of Instance configuration</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../reference/instance_properties/">Instance properties</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/instance_options/">Instance options</a></li> <li class="toctree-l3 has-children"><a class="reference internal" href="../reference/devices/">Devices</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" role="switch" type="checkbox"/><label for="toctree-checkbox-16"><div class="visually-hidden">Toggle navigation of Devices</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l4"><a class="reference internal" href="../reference/standard_devices/">Standard devices</a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_none/">Type: <code class="docutils literal notranslate"><span class="pre">none</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_nic/">Type: <code class="docutils literal notranslate"><span class="pre">nic</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_disk/">Type: <code class="docutils literal notranslate"><span class="pre">disk</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_char/">Type: <code class="docutils literal notranslate"><span class="pre">unix-char</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_block/">Type: <code class="docutils literal notranslate"><span class="pre">unix-block</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_usb/">Type: <code class="docutils literal notranslate"><span class="pre">usb</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_gpu/">Type: <code class="docutils literal notranslate"><span class="pre">gpu</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_infiniband/">Type: <code class="docutils literal notranslate"><span class="pre">infiniband</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_proxy/">Type: <code class="docutils literal notranslate"><span class="pre">proxy</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_hotplug/">Type: <code class="docutils literal notranslate"><span class="pre">unix-hotplug</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_tpm/">Type: <code class="docutils literal notranslate"><span class="pre">tpm</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="../reference/devices_pci/">Type: <code class="docutils literal notranslate"><span class="pre">pci</span></code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="../reference/instance_units/">Units for storage and network limits</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../reference/preseed_yaml_fields/">Preseed YAML file fields</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/projects/">Project configuration</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../reference/storage_drivers/">Storage drivers</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" role="switch" type="checkbox"/><label for="toctree-checkbox-17"><div class="visually-hidden">Toggle navigation of Storage drivers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_btrfs/">Btrfs - <code class="docutils literal notranslate"><span class="pre">btrfs</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_cephfs/">CephFS - <code class="docutils literal notranslate"><span class="pre">cephfs</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_cephobject/">Ceph Object - <code class="docutils literal notranslate"><span class="pre">cephobject</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_ceph/">Ceph RBD - <code class="docutils literal notranslate"><span class="pre">ceph</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_powerflex/">Dell PowerFlex - <code class="docutils literal notranslate"><span class="pre">powerflex</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_pure/">Pure Storage - <code class="docutils literal notranslate"><span class="pre">pure</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_dir/">Directory - <code class="docutils literal notranslate"><span class="pre">dir</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_lvm/">LVM - <code class="docutils literal notranslate"><span class="pre">lvm</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/storage_zfs/">ZFS - <code class="docutils literal notranslate"><span class="pre">zfs</span></code></a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../reference/networks/">Networks</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" role="switch" type="checkbox"/><label for="toctree-checkbox-18"><div class="visually-hidden">Toggle navigation of Networks</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../reference/network_bridge/">Bridge network</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/network_ovn/">OVN network</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/network_macvlan/">Macvlan network</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/network_physical/">Physical network</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/network_sriov/">SR-IOV network</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../reference/cluster_member_config/">Cluster configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/server_settings/">Production server settings</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/provided_metrics/">Provided metrics</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/permissions/">Permissions</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../restapi_landing/">REST API</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" role="switch" type="checkbox"/><label for="toctree-checkbox-19"><div class="visually-hidden">Toggle navigation of REST API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../rest-api/">Main API documentation</a></li> <li class="toctree-l3"><a class="reference internal" href="../api/">Main API specification</a></li> <li class="toctree-l3"><a class="reference internal" href="../api-extensions/">Main API extensions</a></li> <li class="toctree-l3"><a class="reference internal" href="../events/">Events API documentation</a></li> <li class="toctree-l3"><a class="reference internal" href="../dev-lxd/">Instance API</a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../reference/manpages/">Man pages</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" role="switch" type="checkbox"/><label for="toctree-checkbox-20"><div class="visually-hidden">Toggle navigation of Man pages</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../reference/manpages/lxc/"><code class="docutils literal notranslate"><span class="pre">lxc</span></code></a></li> </ul> </li> <li class="toctree-l2 has-children"><a class="reference internal" href="../internals/">Internals</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" role="switch" type="checkbox"/><label for="toctree-checkbox-21"><div class="visually-hidden">Toggle navigation of Internals</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../environment/">Environment variables</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/uefi_variables/">UEFI variables for VMs</a></li> <li class="toctree-l3"><a class="reference internal" href="../daemon-behavior/">Daemon behavior</a></li> <li class="toctree-l3"><a class="reference internal" href="../syscall-interception/">System call interception</a></li> <li class="toctree-l3"><a class="reference internal" href="../userns-idmap/">User namespace setup</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/ovn-internals/">OVN implementation</a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/vm_live_migration_internals/">VM live migration implementation</a></li> </ul> </li> <li class="toctree-l2"><a class="reference external" href="https://github.com/canonical/lxd">Project repository</a></li> <li class="toctree-l2"><a class="reference external" href="https://images.lxd.canonical.com">Image server</a></li> </ul> </li> </ul> </div> </div> </div> </div> </aside> <div class="main"> <div class="content"> <div class="article-container"> <a href="#" class="back-to-top muted-link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> </svg> <span>Back to top</span> </a> <div class="content-icon-container"> <div class="view-this-page"> <a class="muted-link" href="../_sources/debugging.md.txt" title="View this page"> <svg><use href="#svg-eye"></use></svg> <span class="visually-hidden">View this page</span> </a> </div> <div class="theme-toggle-container theme-toggle-content"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> <article role="main" id="furo-main-content"> <section id="how-to-debug-lxd"> <h1>How to debug LXD<a class="headerlink" href="#how-to-debug-lxd" title="Link to this heading">¶</a></h1> <p>For information on debugging instance issues, see <a class="reference internal" href="../howto/instances_troubleshoot/#instances-troubleshoot"><span class="std std-ref">How to troubleshoot failing instances</span></a>.</p> <section id="debugging-lxc-and-lxd"> <h2>Debugging <code class="docutils literal notranslate"><span class="pre">lxc</span></code> and <code class="docutils literal notranslate"><span class="pre">lxd</span></code><a class="headerlink" href="#debugging-lxc-and-lxd" title="Link to this heading">¶</a></h2> <p>Here are different ways to help troubleshooting <code class="docutils literal notranslate"><span class="pre">lxc</span></code> and <code class="docutils literal notranslate"><span class="pre">lxd</span></code> code.</p> <section id="lxc-debug"> <h3><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">--debug</span></code><a class="headerlink" href="#lxc-debug" title="Link to this heading">¶</a></h3> <p>Adding <code class="docutils literal notranslate"><span class="pre">--debug</span></code> flag to any client command will give extra information about internals. If there is no useful info, it can be added with the logging call:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>logger.Debugf("Hello: %s", "Debug") </pre></div> </div> </section> <section id="lxc-monitor"> <h3><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">monitor</span></code><a class="headerlink" href="#lxc-monitor" title="Link to this heading">¶</a></h3> <p>This command will monitor messages as they appear on remote server.</p> </section> </section> <section id="rest-api-through-local-socket"> <h2>REST API through local socket<a class="headerlink" href="#rest-api-through-local-socket" title="Link to this heading">¶</a></h2> <p>On server side the most easy way is to communicate with LXD through local socket. This command accesses <code class="docutils literal notranslate"><span class="pre">GET</span> <span class="pre">/1.0</span></code> and formats JSON into human readable form using <a class="reference external" href="https://stedolan.github.io/jq/tutorial/">jq</a> utility:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>--unix-socket<span class="w"> </span>/var/lib/lxd/unix.socket<span class="w"> </span>lxd/1.0<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>. </pre></div> </div> <p>or for snap users:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>--unix-socket<span class="w"> </span>/var/snap/lxd/common/lxd/unix.socket<span class="w"> </span>lxd/1.0<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq<span class="w"> </span>. </pre></div> </div> <p>See the <a class="reference internal" href="../rest-api/"><span class="std std-doc">RESTful API</span></a> for available API.</p> </section> <section id="rest-api-through-https"> <h2>REST API through HTTPS<a class="headerlink" href="#rest-api-through-https" title="Link to this heading">¶</a></h2> <p><a class="reference internal" href="../explanation/security/#security"><span class="std std-ref">HTTPS connection to LXD</span></a> requires valid client certificate that is generated on first <a class="reference internal" href="../reference/manpages/lxc/remote/add/#lxc-remote-add-md"><span class="std std-ref"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">remote</span> <span class="pre">add</span></code></span></a>. This certificate should be passed to connection tools for authentication and encryption.</p> <p>If desired, <code class="docutils literal notranslate"><span class="pre">openssl</span></code> can be used to examine the certificate (<code class="docutils literal notranslate"><span class="pre">~/.config/lxc/client.crt</span></code> or <code class="docutils literal notranslate"><span class="pre">~/snap/lxd/common/config/client.crt</span></code> for snap users):</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>openssl<span class="w"> </span>x509<span class="w"> </span>-text<span class="w"> </span>-noout<span class="w"> </span>-in<span class="w"> </span>client.crt </pre></div> </div> <p>Among the lines you should see:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Certificate purposes: SSL client : Yes </pre></div> </div> <section id="with-command-line-tools"> <h3>With command line tools<a class="headerlink" href="#with-command-line-tools" title="Link to this heading">¶</a></h3> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>wget<span class="w"> </span>--no-check-certificate<span class="w"> </span>--certificate<span class="o">=</span><span class="nv">$HOME</span>/.config/lxc/client.crt<span class="w"> </span>--private-key<span class="o">=</span><span class="nv">$HOME</span>/.config/lxc/client.key<span class="w"> </span>-qO<span class="w"> </span>-<span class="w"> </span>https://127.0.0.1:8443/1.0 <span class="c1"># or for snap users</span> wget<span class="w"> </span>--no-check-certificate<span class="w"> </span>--certificate<span class="o">=</span><span class="nv">$HOME</span>/snap/lxd/common/config/client.crt<span class="w"> </span>--private-key<span class="o">=</span><span class="nv">$HOME</span>/snap/lxd/common/config/client.key<span class="w"> </span>-qO<span class="w"> </span>-<span class="w"> </span>https://127.0.0.1:8443/1.0 </pre></div> </div> </section> <section id="with-browser"> <h3>With browser<a class="headerlink" href="#with-browser" title="Link to this heading">¶</a></h3> <p>Some browser plugins provide convenient interface to create, modify and replay web requests. To authenticate against LXD server, convert <code class="docutils literal notranslate"><span class="pre">lxc</span></code> client certificate into importable format and import it into browser.</p> <p>For example this produces <code class="docutils literal notranslate"><span class="pre">client.pfx</span></code> in Windows-compatible format:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>openssl<span class="w"> </span>pkcs12<span class="w"> </span>-clcerts<span class="w"> </span>-inkey<span class="w"> </span>client.key<span class="w"> </span>-in<span class="w"> </span>client.crt<span class="w"> </span>-export<span class="w"> </span>-out<span class="w"> </span>client.pfx </pre></div> </div> <p>After that, opening <a class="reference external" href="https://127.0.0.1:8443/1.0"><code class="docutils literal notranslate"><span class="pre">https://127.0.0.1:8443/1.0</span></code></a> should work as expected.</p> </section> </section> <section id="debug-lxd-using-pprof"> <h2>Debug LXD using <code class="docutils literal notranslate"><span class="pre">pprof</span></code><a class="headerlink" href="#debug-lxd-using-pprof" title="Link to this heading">¶</a></h2> <p>LXD provides a Go <a class="reference external" href="https://pkg.go.dev/net/http/pprof"><code class="docutils literal notranslate"><span class="pre">pprof</span></code></a> server when the <a class="configref reference internal" href="../server/#server-core:core.debug_address"><code class="docutils literal notranslate"><span class="pre">core.debug_address</span></code></a> is set.</p> <p>The debug server should not be exposed to an externally accessible address for production use cases. Use the following command to enable the server on the loopback interface:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>lxc config set core.debug_address=localhost:8080 </pre></div> </div> <p>If the LXD server is running on your workstation, you can view a summary of available information by navigating to <a class="reference external" href="http://localhost:8080/debug/pprof/"><code class="docutils literal notranslate"><span class="pre">http://localhost:8080/debug/pprof/</span></code></a>.</p> </section> <section id="debug-the-lxd-database"> <h2>Debug the LXD database<a class="headerlink" href="#debug-the-lxd-database" title="Link to this heading">¶</a></h2> <p>The files of the global <a class="reference internal" href="../database/#database"><span class="std std-ref">database</span></a> are stored under the <code class="docutils literal notranslate"><span class="pre">./database/global</span></code> sub-directory of your LXD data directory (e.g. <code class="docutils literal notranslate"><span class="pre">/var/lib/lxd/database/global</span></code> or <code class="docutils literal notranslate"><span class="pre">/var/snap/lxd/common/lxd/database/global</span></code> for snap users).</p> <p>Since each member of the cluster also needs to keep some data which is specific to that member, LXD also uses a plain SQLite database (the “local” database), which you can find in <code class="docutils literal notranslate"><span class="pre">./database/local.db</span></code>.</p> <p>Backups of the global database directory and of the local database file are made before upgrades, and are tagged with the <code class="docutils literal notranslate"><span class="pre">.bak</span></code> suffix. You can use those if you need to revert the state as it was before the upgrade.</p> <section id="dumping-the-database-content-or-schema"> <h3>Dumping the database content or schema<a class="headerlink" href="#dumping-the-database-content-or-schema" title="Link to this heading">¶</a></h3> <p>If you want to get a SQL text dump of the content or the schema of the databases, use the <code class="docutils literal notranslate"><span class="pre">lxd</span> <span class="pre">sql</span> <span class="pre"><local|global></span> <span class="pre">[.dump|.schema]</span></code> command, which produces the equivalent output of the <code class="docutils literal notranslate"><span class="pre">.dump</span></code> or <code class="docutils literal notranslate"><span class="pre">.schema</span></code> directives of the <code class="docutils literal notranslate"><span class="pre">sqlite3</span></code> command line tool.</p> </section> <section id="running-custom-queries-from-the-console"> <h3>Running custom queries from the console<a class="headerlink" href="#running-custom-queries-from-the-console" title="Link to this heading">¶</a></h3> <p>If you need to perform SQL queries (e.g. <code class="docutils literal notranslate"><span class="pre">SELECT</span></code>, <code class="docutils literal notranslate"><span class="pre">INSERT</span></code>, <code class="docutils literal notranslate"><span class="pre">UPDATE</span></code>) against the local or global database, you can use the <code class="docutils literal notranslate"><span class="pre">lxd</span> <span class="pre">sql</span></code> command (run <code class="docutils literal notranslate"><span class="pre">lxd</span> <span class="pre">sql</span> <span class="pre">--help</span></code> for details).</p> <p>You should only need to do that in order to recover from broken updates or bugs. Please consult the LXD team first (creating a <a class="reference external" href="https://github.com/canonical/lxd/issues/new">GitHub issue</a> or <a class="reference external" href="https://discourse.ubuntu.com/c/lxd/126">forum</a> post).</p> </section> <section id="running-custom-queries-at-lxd-daemon-startup"> <h3>Running custom queries at LXD daemon startup<a class="headerlink" href="#running-custom-queries-at-lxd-daemon-startup" title="Link to this heading">¶</a></h3> <p>In case the LXD daemon fails to start after an upgrade because of SQL data migration bugs or similar problems, it’s possible to recover the situation by creating <code class="docutils literal notranslate"><span class="pre">.sql</span></code> files containing queries that repair the broken update.</p> <p>To perform repairs against the local database, write a <code class="docutils literal notranslate"><span class="pre">./database/patch.local.sql</span></code> file containing the relevant queries, and similarly a <code class="docutils literal notranslate"><span class="pre">./database/patch.global.sql</span></code> for global database repairs.</p> <p>Those files will be loaded very early in the daemon startup sequence and deleted if the queries were successful (if they fail, no state will change as they are run in a SQL transaction).</p> <p>As above, please consult the LXD team first.</p> </section> <section id="syncing-the-cluster-database-to-disk"> <h3>Syncing the cluster database to disk<a class="headerlink" href="#syncing-the-cluster-database-to-disk" title="Link to this heading">¶</a></h3> <p>If you want to flush the content of the cluster database to disk, use the <code class="docutils literal notranslate"><span class="pre">lxd</span> <span class="pre">sql</span> <span class="pre">global</span> <span class="pre">.sync</span></code> command, that will write a plain SQLite database file into <code class="docutils literal notranslate"><span class="pre">./database/global/db.bin</span></code>, which you can then inspect with the <code class="docutils literal notranslate"><span class="pre">sqlite3</span></code> command line tool.</p> </section> </section> <section id="inspect-a-core-dump-file"> <h2>Inspect a core dump file<a class="headerlink" href="#inspect-a-core-dump-file" title="Link to this heading">¶</a></h2> <p>In our continuous integration tests, we have configured the <code class="docutils literal notranslate"><span class="pre">core_pattern</span></code> as follows:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>echo '|/bin/sh -c $@ -- eval exec gzip --fast > /var/crash/core-%e.%p.gz' | sudo tee /proc/sys/kernel/core_pattern </pre></div> </div> <p>Additionally, we have set the <code class="docutils literal notranslate"><span class="pre">GOTRACEBACK</span></code> environment variable to <code class="docutils literal notranslate"><span class="pre">crash</span></code>. Together, these ensure that when LXD crashes a core dump is compressed with <code class="docutils literal notranslate"><span class="pre">gzip</span></code> and placed in <code class="docutils literal notranslate"><span class="pre">/var/crash</span></code>.</p> <p>To inspect a core dump file, you will need the LXD binary that was running at the time of the crash. The binary must include symbols; you can check this with the <code class="docutils literal notranslate"><span class="pre">file</span></code> utility. You will also need any C libraries that are used by LXD which must also include symbols.</p> <p>You can inspect a core dump using <a class="reference external" href="https://github.com/go-delve/delve">Delve</a> (see the <a class="reference external" href="https://go.dev/wiki/CoreDumpDebugging">Go Wiki</a> for more information), but this does not support any dynamically linked C libraries. Instead, you can use <a class="reference external" href="https://sourceware.org/gdb/">GDB</a> which can inspect linked libraries and allows sourcing a file to load Golang support.</p> <p>To do this, run:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>gdb <LXD binary> <coredump file> </pre></div> </div> <p>Then in the GDB REPL, run:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) source <GOROOT>/src/runtime/runtime-gdb.py </pre></div> </div> <p>Substituting in the actual path to your <code class="docutils literal notranslate"><span class="pre">$GOROOT</span></code>. This will add Golang runtime support.</p> <p>Finally, set the search path for C libraries using:</p> <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>(gdb) set solib-search-path <path to C libraries> </pre></div> </div> <p>You can now use the GDB REPL to inspect the core dump. Some useful commands are:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">backtrace</span></code> (print stack trace).</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">goroutines</span></code> (show goroutines).</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">info</span> <span class="pre">threads</span></code> (show threads).</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">thread</span> <span class="pre"><thread_number></span></code> (change thread).</p></li> </ul> </section> </section> </article> </div> <footer> <div class="related-pages"> <a class="next-page" href="../faq/"> <div class="page-info"> <div class="context"> <span>Next</span> </div> <div class="title">Frequently asked questions</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> <a class="prev-page" href="../howto/dqlite_troubleshoot/"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> <div class="title">How to troubleshoot (some) Dqlite errors</div> </div> </a> </div> <div class="bottom-of-page"> <div class="left-details"> <div class="copyright"> Copyright © 2014-2025 LXD contributors </div> <div class="last-updated"> Last updated on Sep 08, 2025</div> <div class="show-source"> <a class="muted-link" href="../_sources/debugging.md.txt" rel="nofollow">Show source</a> </div> </div> <div> <a class="display-contributors">Thanks to the 10 contributors!</a> <div id="overlay"></div> <ul class="all-contributors"> <li> <a href="https://github.com/canonical/lxd/commit/f331b8cf5baa3b3e6cda36e7c2ee8ecbbbba3f25" class="contributor">Alberto Donato</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/13c4bf70fad13b970f82b5054a7729ad5d60ae28" class="contributor">Brett</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/906114c8c7db9efab2e7c96cbb82d7834c1e174d" class="contributor">KATOH Yasufumi</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/c79184bf7aded58b6b9b503a4e3cf550bddf9c05" class="contributor">Mark Laing</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/757ced37284196c18ba9845c7f23acd331d843fe" class="contributor">Rob Thomas</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/f8f21e824c1b10a13cbe1a2c620709db8cb6efe5" class="contributor">Ruth Fuchss</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/c2568b9e42fc7e3a7d799202f59468a1a2973a24" class="contributor">Simon Deziel</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/505048b34f19820f007ca6ac96e1d7780fb1f704" class="contributor">Stéphane Graber</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/c5cd05c3613f1542dfba19a97836b306a481a3cc" class="contributor">Wesley Hershberger</a> </li> <li> <a href="https://github.com/canonical/lxd/commit/2bed9dbf2395f7fd5f99a3af5a4017d02cb12ce2" class="contributor">anatoly techtonik</a> </li> </ul> </div> <div class="right-details"> <div class="ask-discourse"> <a class="muted-link" href="https://discourse.ubuntu.com/c/lxd/">Ask a question on Discourse</a> </div> <div class="ask-matrix"> <a class="muted-link" href="https://matrix.to/#/#documentation:ubuntu.com">Ask a question on Matrix</a> </div> <div class="issue-github"> <a class="muted-link" href="https://github.com/canonical/lxd/issues/new?title=doc%3A+ADD+A+TITLE&body=DESCRIBE+THE+ISSUE%0A%0A---%0ADocument: debugging.md">Open a GitHub issue for this page</a> </div> <div class="edit-github"> <a class="muted-link" href="https://github.com/canonical/lxd/edit/main/doc/debugging.md">Edit this page on GitHub</a> </div> </div> </div> </div> </footer> </div> <aside class="toc-drawer"> <div class="toc-sticky toc-scroll"> <div class="toc-title-container"> <span class="toc-title"> Contents </span> </div> <div class="toc-tree-container"> <div class="toc-tree"> <ul> <li><a class="reference internal" href="#">How to debug LXD</a><ul> <li><a class="reference internal" href="#debugging-lxc-and-lxd">Debugging <code class="docutils literal notranslate"><span class="pre">lxc</span></code> and <code class="docutils literal notranslate"><span class="pre">lxd</span></code></a><ul> <li><a class="reference internal" href="#lxc-debug"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">--debug</span></code></a></li> <li><a class="reference internal" href="#lxc-monitor"><code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">monitor</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#rest-api-through-local-socket">REST API through local socket</a></li> <li><a class="reference internal" href="#rest-api-through-https">REST API through HTTPS</a><ul> <li><a class="reference internal" href="#with-command-line-tools">With command line tools</a></li> <li><a class="reference internal" href="#with-browser">With browser</a></li> </ul> </li> <li><a class="reference internal" href="#debug-lxd-using-pprof">Debug LXD using <code class="docutils literal notranslate"><span class="pre">pprof</span></code></a></li> <li><a class="reference internal" href="#debug-the-lxd-database">Debug the LXD database</a><ul> <li><a class="reference internal" href="#dumping-the-database-content-or-schema">Dumping the database content or schema</a></li> <li><a class="reference internal" href="#running-custom-queries-from-the-console">Running custom queries from the console</a></li> <li><a class="reference internal" href="#running-custom-queries-at-lxd-daemon-startup">Running custom queries at LXD daemon startup</a></li> <li><a class="reference internal" href="#syncing-the-cluster-database-to-disk">Syncing the cluster database to disk</a></li> </ul> </li> <li><a class="reference internal" href="#inspect-a-core-dump-file">Inspect a core dump file</a></li> </ul> </li> </ul> </div> </div> </div> </aside> </div> </div><script src="../_static/jquery.js?v=5d32c60e"></script> <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../_static/documentation_options.js?v=187304be"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=46bd48cc"></script> <script src="../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../_static/copybutton.js?v=f281be69"></script> <script src="../_static/config-options.js"></script> <script src="../_static/design-tabs.js?v=f930bc37"></script> <script src="../_static/header-nav.js?v=e117ad08"></script> <script src="../_static/footer.js?v=5acea47a"></script> <script src="../_static/github_issue_links.js?v=32bb732f"></script> <script src="../_static/js/bundle.js?v=a4d88309"></script> <script> const github_url = "https://github.com/canonical/lxd"; </script> </body> </html>
Copyright ©2k19 -
Hexid
|
Tex7ure