/docs/troubleshooting/diagnostictools/ Recent content in Diagnostic Tools on Verrazzano Enterprise Container Platform Hugo -- gohugo.io /docs/troubleshooting/diagnostictools/verrazzanoanalysistool/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/troubleshooting/diagnostictools/verrazzanoanalysistool/ <p>Verrazzano provides the <code>vz analyze</code> command-line tool, which assists in troubleshooting issues in your environment. You can use it to analyze a cluster as well as, to analyze a cluster snapshot captured by the <code>vz bug-report</code> tool. For detailed information about <code>vz bug-report</code>, see <a href="../../../docs/troubleshooting/diagnostictools/vzbugreportcli/">here</a>.</p> <p>The <code>vz analyze</code> command-line tool analyzes the cluster or a cluster snapshot, reports the issues found, and prescribes related actions to take. Users, developers, and Continuous Integration (CI) can use this tooling to quickly identify the root cause of encountered problems, determine mitigation actions, and provide a sharable report with other users or tooling.</p> <h2 id="set-up-the-cli-tool">Set up the CLI tool</h2> <p>To set up the <code>vz</code> command-line tool, follow the steps <a href="../../../docs/setup/install/prepare/cli-setup/">here</a>.</p> <h2 id="analyze-clusters">Analyze clusters</h2> <p>To analyze a Kubernetes cluster: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz analyze </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <h2 id="analyze-cluster-snapshots">Analyze cluster snapshots</h2> <ol> <li> <p>Use the <code>vz bug-report</code> tool to capture a cluster snapshot.</p> <p>To create a bug report in a TAR file named <code>my-bug-report.tar.gz</code> and extract it to a directory <code>my-cluster-snapshot</code>: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report my-bug-report.tar.gz </span></span><span style="display:flex;"><span> mkdir my-cluster-snapshot </span></span><span style="display:flex;"><span> tar -xvf my-bug-report.tar.gz -C my-cluster-snapshot </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> <li> <p>Use the <code>vz analyze</code> tool to analyze the cluster snapshot.</p> <p>To perform an analysis of the cluster snapshot under <code>my-cluster-snapshot</code>: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz analyze --capture-dir my-cluster-snapshot </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> </ol> <h3 id="use-the-vz-analyze-tool-to-analyze-multiple-snapshots">Use the vz analyze tool to analyze multiple snapshots</h3> <p>The <code>vz analyze</code> tool will find and analyze all cluster snapshot directories found under a specified root directory. This lets you create a directory to hold the cluster snapshots of related clusters in subdirectories, which the tool can then analyze.</p> <p>For example:</p> <pre><code>my-cluster-snapshots CAPTURE_DIR-1 cluster-snapshot ... CAPTURE_DIR-2 cluster-snapshot ... </code></pre> <p>To perform an analysis of the clusters under <code>my-cluster-snapshots</code>: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz analyze --capture-dir my-cluster-snapshots </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <h3 id="usage-information">Usage information</h3> <p>Use the following syntax to run <code>vz</code> commands from your terminal window.</p> <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz analyze <span style="color:#ce5c00;font-weight:bold">[</span>flags<span style="color:#ce5c00;font-weight:bold">]</span> </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script> <h4 id="available-options">Available options</h4> <table> <thead> <tr> <th>Command</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td><code>--capture-dir string</code></td> <td>Directory holding the captured data.</td> </tr> <tr> <td><code>-h, --help</code></td> <td>Help for the <code>vz analyze</code> command.</td> </tr> <tr> <td><code>--report-file string</code></td> <td>Name of the report output file. (Default <code>stdout</code>)</td> </tr> <tr> <td><code>--report-format string</code></td> <td>The format of the report output. Valid report formats are &ldquo;summary&rdquo; and &ldquo;detailed&rdquo;. (Default &ldquo;summary&rdquo;)</td> </tr> <tr> <td><code>-v, --verbose</code></td> <td>Enable verbose output.</td> </tr> </tbody> </table> <h4 id="available-flags">Available flags</h4> <p>These flags apply to all the commands.</p> <table> <thead> <tr> <th>Flag</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td><code>--context string</code></td> <td>The name of the kubeconfig file context to use.</td> </tr> <tr> <td><code>--kubeconfig string</code></td> <td>Path to the kubeconfig file to use.</td> </tr> </tbody> </table> /docs/troubleshooting/diagnostictools/vzbugreportcli/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/troubleshooting/diagnostictools/vzbugreportcli/ <p>Use the <code>vz bug-report</code> tool to selectively capture cluster information and create an archive (<code>*.tar.gz</code>) file to help diagnose problems. The archive file helps development and support teams analyze issues and provide recommendations. If a failure occurs while Verrazzano is being installed, upgraded, or uninstalled using the Verrazzano CLI, then the archive file is generated automatically.</p> <h2 id="cli-setup">CLI setup</h2> <p>To set up the <code>vz</code> command-line tool, follow the steps <a href="../../../docs/setup/install/prepare/cli-setup/">here</a>.</p> <h2 id="use-the-vz-bug-report-tool">Use the vz bug-report tool</h2> <p>To create a bug report in a TAR file named <code>my-bug-report.tar.gz</code>: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report --report-file my-bug-report.tar.gz </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <p>We suggest that you review the contents of the bug report before sharing it with support and development teams.</p> <h3 id="usage-information">Usage information</h3> <p>Use the following syntax to run <code>vz</code> commands from your terminal window. <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report <span style="color:#ce5c00;font-weight:bold">[</span>flags<span style="color:#ce5c00;font-weight:bold">]</span> </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <h3 id="available-options">Available options</h3> <table> <thead> <tr> <th>Command</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td><code>-h, --help </code></td> <td>Help for the <code>vz bug-report</code> command.</td> </tr> <tr> <td><code>-i, --include-namespaces strings</code></td> <td>A comma-separated list of namespaces, in addition to the ones collected by default (system namespaces), for collecting cluster information. This flag can be specified multiple times, such as <code>--include-namespaces ns1 --include-namespaces ns...</code></td> </tr> <tr> <td><code>-r, --report-file string</code></td> <td>The report file created by the <code>vz bug-report</code> command, as a <code>*.tar.gz</code> file. Defaults to <code>bug-report.tar.gz</code> in the current directory.</td> </tr> <tr> <td><code>-l --include-logs</code></td> <td>Include logs from the pods in one or more namespaces; this is specified along with the <code>--include-namespaces</code> flag.</td> </tr> <tr> <td><code>-d --duration duration</code></td> <td>The time period during which the logs are collected in seconds, minutes, and hours.</td> </tr> <tr> <td><code>-v, --verbose</code></td> <td>Enable verbose output.</td> </tr> </tbody> </table> <h3 id="available-flags">Available flags</h3> <p>These flags apply to all the commands.</p> <table> <thead> <tr> <th>Flag</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td><code>--context string</code></td> <td>The name of the kubeconfig file context to use.</td> </tr> <tr> <td><code>--kubeconfig string</code></td> <td>Path to the kubeconfig file to use.</td> </tr> </tbody> </table> <h3 id="examples">Examples</h3> <ul> <li> <p>Create a bug report file, <code>bugreport.tar.gz</code>, by collecting data from the cluster: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tar.gz </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <p>When <code>--report-file</code> is not provided, the command creates <code>bug-report.tar.gz</code> in the current directory.</p> </li> <li> <p>Create a bug report file, <code>bugreport.tar.gz</code>, including the additional namespace <code>ns1</code> from the cluster: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1 </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> <li> <p>The flag <code>--include-namespaces</code> accepts comma-separated values and can be specified multiple times. For example, the following commands create a bug report by including the additional namespaces <code>ns1</code>, <code>ns2</code>, and <code>ns3</code>: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2,ns3 </span></span><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-namespaces ns3 </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> <li> <p>Use the <code>--include-logs</code> flag to collect the logs from the pods in one or more namespaces, by specifying the <code>--include-namespaces</code> flag. For example, the following command creates a bug report by including the logs from the additional namespaces <code>ns1</code> and <code>ns2</code>: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> </li> <li> <p>The <code>--duration</code> flag collects logs for the specified time period. The default value is zero (<code>0</code>), which collects the complete pod log. You can specify seconds, minutes, and hours. For example, the following commands create bug reports by including the logs from the additional namespaces <code>ns1</code> and <code>ns2</code> during the specified periods of time: <style type="text/css"> code { margin: 0; padding: 0; } .copy-code-button { position: absolute; right: 0; top: -29px; font-size: 12px; line-height: 14px; width: 65px; color: white; background-color: #30638E; border: 1px solid #30638E; white-space: nowrap; padding: 6px 6px 7px 6px; } .copy-code-button:hover, .copy-code-button:focus{ background-color: gray; opacity: 1; } </style> <div class="clipboard"> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 5m </span></span><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 2h </span></span><span style="display:flex;"><span>$ vz bug-report --report-file bugreport.tgz --include-namespaces ns1,ns2 --include-logs --duration 300s </span></span></code></pre></div> </div> <script> function createCopyButton(highlightDiv) { const button = document.createElement("button"); button.innerText = "Copy"; button.className = "copy-code-button"; button.addEventListener("click", () => copyCodeToClipboard(button, highlightDiv) ); addCopyButton(button, highlightDiv); } function addCopyButton(button, highlightDiv) { highlightDiv.insertBefore(button, highlightDiv.firstChild); const wrapper = document.createElement("div"); highlightDiv.parentNode.insertBefore(wrapper, highlightDiv); wrapper.appendChild(highlightDiv); } async function copyCodeToClipboard(button, highlightDiv) { let codeToCopy = highlightDiv.querySelector(":last-child > code, pre").innerText; let codeBlock = codeToCopy.split("\n"); let expectedLine = codeBlock.findIndex(line => line.toLowerCase().startsWith("# expected response") || line.toLowerCase().startsWith("# sample output")); if (expectedLine !== -1) { codeBlock.splice(expectedLine); } codeToCopy = codeBlock.join("\n"); codeToCopy = codeToCopy.replace(/^#(.*)$/gm, '').trim(); codeToCopy = codeToCopy.replace(/\$\s+/gm, '').trim(); codeToCopy = codeToCopy.replace(/\n{2,}/g,'\n'); console.log(codeToCopy); try { await navigator.clipboard.writeText(codeToCopy); } catch (err) { const textarea = document.createElement('textarea'); textarea.value = codeToCopy; document.body.appendChild(textarea); textarea.select(); document.execCommand('copy'); textarea.remove(); } button.blur(); button.innerText = "Copied"; setTimeout(function () { button.innerText = "Copy"; }, 2000); } document .querySelectorAll(".highlight") .forEach((highlightDiv) => createCopyButton(highlightDiv)); </script></p> <p>The values specified for the flag <code>--include-namespaces</code> are case-sensitive.</p> </li> </ul> /docs/troubleshooting/diagnostictools/analysisadvice/ Mon, 01 Jan 0001 00:00:00 +0000 /docs/troubleshooting/diagnostictools/analysisadvice/