deploy: 9fefbc7dff

v2.5/pages-for-subheaders/logging.html

@@ -10,7 +10,7 @@
 
 <script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" charset="UTF-8" data-domain-script="0f98beb0-fc4c-417d-a42e-564e2cae42d2" async></script>
 <script src="/scripts/optanonwrapper.js" async></script><link rel="stylesheet" href="/assets/css/styles.f7a82f66.css">
-<link rel="preload" href="/assets/js/runtime~main.7cb70a0f.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.c0888e46.js" as="script">
 <link rel="preload" href="/assets/js/main.bc6fd292.js" as="script">
 </head>
 <body class="navigation-with-keyboard">
@@ -19,7 +19,7 @@
 Only Linux node logs are able to be exported.</p><p>To allow the logging pods to be scheduled on Linux nodes, tolerations must be added to the pods. Refer to the <a href="/v2.5/explanations/integrations-in-rancher/logging/taints-and-tolerations">Working with Taints and Tolerations</a> section for details and an example.</p></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="working-with-a-custom-docker-root-directory">Working with a Custom Docker Root Directory<a class="hash-link" href="#working-with-a-custom-docker-root-directory" title="Direct link to heading">​</a></h3><p>For details on using a custom Docker root directory, see <a href="/v2.5/explanations/integrations-in-rancher/logging/logging-helm-chart-options#working-with-a-custom-docker-root-directory">this section.</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="working-with-taints-and-tolerations">Working with Taints and Tolerations<a class="hash-link" href="#working-with-taints-and-tolerations" title="Direct link to heading">​</a></h3><p>For information on how to use taints and tolerations with the logging application, see <a href="/v2.5/explanations/integrations-in-rancher/logging/taints-and-tolerations">this page.</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="logging-v2-with-selinux">Logging V2 with SELinux<a class="hash-link" href="#logging-v2-with-selinux" title="Direct link to heading">​</a></h3><p><em>Available as of v2.5.8</em></p><p>For information on enabling the logging application for SELinux-enabled nodes, see <a href="/v2.5/explanations/integrations-in-rancher/logging/logging-helm-chart-options#enabling-the-logging-application-to-work-with-selinux">this section.</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="additional-logging-sources">Additional Logging Sources<a class="hash-link" href="#additional-logging-sources" title="Direct link to heading">​</a></h3><p>By default, Rancher collects logs for control plane components and node components for all cluster types. In some cases additional logs can be collected. For details, see <a href="/v2.5/explanations/integrations-in-rancher/logging/logging-helm-chart-options#additional-logging-sources">this section.</a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="troubleshooting">Troubleshooting<a class="hash-link" href="#troubleshooting" title="Direct link to heading">​</a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="the-logging-buffer-overloads-pods">The Logging Buffer Overloads Pods<a class="hash-link" href="#the-logging-buffer-overloads-pods" title="Direct link to heading">​</a></h3><p>Depending on your configuration, the default buffer size may be too large and cause pod failures. One way to reduce the load is to lower the logger&#x27;s flush interval. This prevents logs from overfilling the buffer. You can also add more flush threads to handle moments when many logs are attempting to fill the buffer at once. </p><p>For a more complete description of how to configure the logging buffer to suit your organization&#x27;s needs, see the official BanzaiCloud documentation on <a href="https://banzaicloud.com/docs/one-eye/logging-operator/configuration/plugins/outputs/buffer/" target="_blank" rel="noopener noreferrer">buffers</a> and on <a href="https://banzaicloud.com/docs/one-eye/logging-operator/configuration/fluentd/" target="_blank" rel="noopener noreferrer">Fluentd configuration</a>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="the-cattle-logging-namespace-being-recreated">The <code>cattle-logging</code> Namespace Being Recreated<a class="hash-link" href="#the-cattle-logging-namespace-being-recreated" title="Direct link to heading">​</a></h3><p>If your cluster previously deployed logging from the Cluster Manager UI, you may encounter an issue where its <code>cattle-logging</code> namespace is continually being recreated.</p><p>The solution is to delete all <code>clusterloggings.management.cattle.io</code> and <code>projectloggings.management.cattle.io</code> custom resources from the cluster specific namespace in the management cluster.
 The existence of these custom resources causes Rancher to create the <code>cattle-logging</code> namespace in the downstream cluster if it does not exist.</p><p>The cluster namespace matches the cluster ID, so we need to find the cluster ID for each cluster.</p><ol><li>In your web browser, navigate to your cluster(s) in either the Cluster Manager UI or the Cluster Explorer UI.</li><li>Copy the <code>&lt;cluster-id&gt;</code> portion from one of the URLs below. The <code>&lt;cluster-id&gt;</code> portion is the cluster namespace name.</li></ol><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Cluster Management UI</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">https://</span><span class="token operator" style="color:rgb(137, 221, 255)">&lt;</span><span class="token plain">your-url</span><span class="token operator" style="color:rgb(137, 221, 255)">&gt;</span><span class="token plain">/c/</span><span class="token operator" style="color:rgb(137, 221, 255)">&lt;</span><span class="token plain">cluster-id</span><span class="token operator" style="color:rgb(137, 221, 255)">&gt;</span><span class="token plain">/</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token comment" style="color:rgb(105, 112, 152);font-style:italic"># Cluster Explorer UI (Dashboard)</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">https://</span><span class="token operator" style="color:rgb(137, 221, 255)">&lt;</span><span class="token plain">your-url</span><span class="token operator" style="color:rgb(137, 221, 255)">&gt;</span><span class="token plain">/dashboard/c/</span><span class="token operator" style="color:rgb(137, 221, 255)">&lt;</span><span class="token plain">cluster-id</span><span class="token operator" style="color:rgb(137, 221, 255)">&gt;</span><span class="token plain">/</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Now that we have the <code>&lt;cluster-id&gt;</code> namespace, we can delete the CRs that cause <code>cattle-logging</code> to be continually recreated.
 <em>Warning:</em> ensure that logging, the version installed from the Cluster Manager UI, is not currently in use.</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">kubectl delete clusterloggings.management.cattle.io -n </span><span class="token operator" style="color:rgb(137, 221, 255)">&lt;</span><span class="token plain">cluster-id</span><span class="token operator" style="color:rgb(137, 221, 255)">&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">kubectl delete projectloggings.management.cattle.io -n </span><span class="token operator" style="color:rgb(137, 221, 255)">&lt;</span><span class="token plain">cluster-id</span><span class="token operator" style="color:rgb(137, 221, 255)">&gt;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.5/pages-for-subheaders/logging.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2023-02-15T21:24:10.000Z">Feb 15, 2023</time></b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/v2.5/explanations/integrations-in-rancher/longhorn"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Longhorn - Cloud native distributed block storage for Kubernetes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/v2.5/explanations/integrations-in-rancher/logging/logging-architecture"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Architecture</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#enabling-logging" class="table-of-contents__link toc-highlight">Enabling Logging</a></li><li><a href="#uninstall-logging" class="table-of-contents__link toc-highlight">Uninstall Logging</a></li><li><a href="#architecture" class="table-of-contents__link toc-highlight">Architecture</a></li><li><a href="#role-based-access-control" class="table-of-contents__link toc-highlight">Role-based Access Control</a></li><li><a href="#configuring-logging-custom-resources" class="table-of-contents__link toc-highlight">Configuring Logging Custom Resources</a><ul><li><a href="#flows-and-clusterflows" class="table-of-contents__link toc-highlight">Flows and ClusterFlows</a></li><li><a href="#outputs-and-clusteroutputs" class="table-of-contents__link toc-highlight">Outputs and ClusterOutputs</a></li></ul></li><li><a href="#configuring-the-logging-helm-chart" class="table-of-contents__link toc-highlight">Configuring the Logging Helm Chart</a><ul><li><a href="#windows-support" class="table-of-contents__link toc-highlight">Windows Support</a></li><li><a href="#working-with-a-custom-docker-root-directory" class="table-of-contents__link toc-highlight">Working with a Custom Docker Root Directory</a></li><li><a href="#working-with-taints-and-tolerations" class="table-of-contents__link toc-highlight">Working with Taints and Tolerations</a></li><li><a href="#logging-v2-with-selinux" class="table-of-contents__link toc-highlight">Logging V2 with SELinux</a></li><li><a href="#additional-logging-sources" class="table-of-contents__link toc-highlight">Additional Logging Sources</a></li></ul></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a><ul><li><a href="#the-logging-buffer-overloads-pods" cLine truncated
-<script src="/assets/js/runtime~main.7cb70a0f.js"></script>
+<script src="/assets/js/runtime~main.c0888e46.js"></script>
 <script src="/assets/js/main.bc6fd292.js"></script>
 <!-- Google Tag Manager (noscript) -->
     <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-57KS2MW" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>