Files
rancher-docs/pages-for-subheaders/monitoring-and-alerting.html
T

26 lines
31 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-pages-for-subheaders/monitoring-and-alerting">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.3.1">
<title data-rh="true">Monitoring and Alerting | Rancher</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="http://ranchermanager.docs.rancher.com/pages-for-subheaders/monitoring-and-alerting"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Monitoring and Alerting | Rancher"><meta data-rh="true" name="description" content="Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Learn about the scope of monitoring and how to enable cluster monitoring"><meta data-rh="true" property="og:description" content="Prometheus lets you view metrics from your different Rancher and Kubernetes objects. Learn about the scope of monitoring and how to enable cluster monitoring"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="http://ranchermanager.docs.rancher.com/pages-for-subheaders/monitoring-and-alerting"><link data-rh="true" rel="alternate" href="http://ranchermanager.docs.rancher.com/pages-for-subheaders/monitoring-and-alerting" hreflang="en"><link data-rh="true" rel="alternate" href="http://ranchermanager.docs.rancher.com/zh/pages-for-subheaders/monitoring-and-alerting" hreflang="zh"><link data-rh="true" rel="alternate" href="http://ranchermanager.docs.rancher.com/pages-for-subheaders/monitoring-and-alerting" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://30NEY6C9UY-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.googletagmanager.com">
<script>window.dataLayer=window.dataLayer||[]</script>
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-57KS2MW",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script>
<link rel="search" type="application/opensearchdescription+xml" title="Rancher" href="/opensearch.xml">
<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.35be4547.css">
<link rel="preload" href="/assets/js/runtime~main.b0c4bb1a.js" as="script">
<link rel="preload" href="/assets/js/main.d8782442.js" as="script">
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-57KS2MW" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/rancher-logo-horiz-color.svg" alt="logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/rancher-logo-horiz-color.svg" alt="logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate"></b></a><div class="navbar__item dropdown dropdown--hoverable"><a aria-current="page" class="navbar__link active" aria-haspopup="true" aria-expanded="false" role="button" href="/">v2.7</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/pages-for-subheaders/monitoring-and-alerting">v2.7</a></li><li><a class="dropdown__link" href="/v2.6/pages-for-subheaders/monitoring-and-alerting">v2.6</a></li><li><a class="dropdown__link" href="/v2.5/pages-for-subheaders/monitoring-and-alerting">v2.5</a></li><li><a class="dropdown__link" href="/v2.0-v2.4">v2.0-v2.4</a></li><li><a class="dropdown__link" href="/versions">All versions</a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/pages-for-subheaders/monitoring-and-alerting" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh/pages-for-subheaders/monitoring-and-alerting" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">简体中文</a></li></ul></div><a href="https://github.com/rancher/rancher-docs" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link navbar__github">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://rancher.com" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">Rancher Home<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">What is Rancher?</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/getting-started/overview">Getting Started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/pages-for-subheaders/new-user-guides">How-to Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/pages-for-subheaders/best-practices">Reference Guides</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/pages-for-subheaders/cloud-marketplace">Integrations in Rancher</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/cloud-marketplace">Cloud Marketplace Integration</a><button aria-label="Toggle the collapsible sidebar category &#x27;Cloud Marketplace Integration&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/cis-scans">CIS Scans</a><button aria-label="Toggle the collapsible sidebar category &#x27;CIS Scans&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/fleet-gitops-at-scale">Continuous Delivery with Fleet</a><button aria-label="Toggle the collapsible sidebar category &#x27;Continuous Delivery with Fleet&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/harvester">Harvester Integration</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/istio">Istio</a><button aria-label="Toggle the collapsible sidebar category &#x27;Istio&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/longhorn">Longhorn - Cloud native distributed block storage for Kubernetes</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" tabindex="0" href="/pages-for-subheaders/logging">Logging</a><button aria-label="Toggle the collapsible sidebar category &#x27;Logging&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current="page" aria-expanded="true" tabindex="0" href="/pages-for-subheaders/monitoring-and-alerting">Monitoring and Alerting</a><button aria-label="Toggle the collapsible sidebar category &#x27;Monitoring and Alerting&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works">How Monitoring Works</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring">Role-based Access Control</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards">Built-in Dashboards</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/monitoring-and-alerting/windows-support">Windows Cluster Support for Monitoring V2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/monitoring-and-alerting/promql-expressions">PromQL Expression Reference</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/neuvector">NeuVector Integration</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/opa-gatekeeper">OPA Gatekeeper</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/integrations-in-rancher/rancher-extensions">Rancher Extensions</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/faq/general-faq">FAQ</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/troubleshooting/general-troubleshooting">Troubleshooting</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/contribute-to-rancher">Contributing to Rancher</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Integrations in Rancher</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Monitoring and Alerting</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: v2.7</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Monitoring and Alerting</h1></header><p>Using the <code>rancher-monitoring</code> application, you can quickly deploy leading open-source monitoring and alerting solutions onto your cluster.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="features">Features<a href="#features" class="hash-link" aria-label="Direct link to Features" title="Direct link to Features">​</a></h3><p>Prometheus lets you view metrics from your Rancher and Kubernetes objects. Using timestamps, Prometheus lets you query and view these metrics in easy-to-read graphs and visuals, either through the Rancher UI or Grafana, which is an analytics viewing platform deployed along with Prometheus.</p><p>By viewing data that Prometheus scrapes from your cluster control plane, nodes, and deployments, you can stay on top of everything happening in your cluster. You can then use these analytics to better run your organization: stop system emergencies before they start, develop maintenance strategies, or restore crashed servers.</p><p>The <code>rancher-monitoring</code> operator, introduced in Rancher v2.5, is powered by <a href="https://prometheus.io/" target="_blank" rel="noopener noreferrer">Prometheus</a>, <a href="https://grafana.com/grafana/" target="_blank" rel="noopener noreferrer">Grafana</a>, <a href="https://prometheus.io/docs/alerting/latest/alertmanager/" target="_blank" rel="noopener noreferrer">Alertmanager</a>, the <a href="https://github.com/prometheus-operator/prometheus-operator" target="_blank" rel="noopener noreferrer">Prometheus Operator</a>, and the <a href="https://github.com/DirectXMan12/k8s-prometheus-adapter" target="_blank" rel="noopener noreferrer">Prometheus adapter.</a></p><p>The monitoring application:</p><ul><li>Monitors the state and processes of your cluster nodes, Kubernetes components, and software deployments.</li><li>Defines alerts based on metrics collected via Prometheus.</li><li>Creates custom Grafana dashboards.</li><li>Configures alert-based notifications via email, Slack, PagerDuty, etc. using Prometheus Alertmanager.</li><li>Defines precomputed, frequently needed or computationally expensive expressions as new time series based on metrics collected via Prometheus.</li><li>Exposes collected metrics from Prometheus to the Kubernetes Custom Metrics API via Prometheus Adapter for use in HPA.</li></ul><p>See <a href="/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works">How Monitoring Works</a> for an explanation of how the monitoring components work together.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="default-components-and-deployments">Default Components and Deployments<a href="#default-components-and-deployments" class="hash-link" aria-label="Direct link to Default Components and Deployments" title="Direct link to Default Components and Deployments">​</a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="built-in-dashboards">Built-in Dashboards<a href="#built-in-dashboards" class="hash-link" aria-label="Direct link to Built-in Dashboards" title="Direct link to Built-in Dashboards">​</a></h3><p>By default, the monitoring application deploys Grafana dashboards (curated by the <a href="https://github.com/prometheus-operator/kube-prometheus" target="_blank" rel="noopener noreferrer">kube-prometheus</a> project) onto a cluster.</p><p>It also deploys an Alertmanager UI and a Prometheus UI. For more information about these tools, see <a href="/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards">Built-in Dashboards.</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="default-metrics-exporters">Default Metrics Exporters<a href="#default-metrics-exporters" class="hash-link" aria-label="Direct link to Default Metrics Exporters" title="Direct link to Default Metrics Exporters">​</a></h3><p>By default, Rancher Monitoring deploys exporters (such as <a href="https://github.com/prometheus/node_exporter" target="_blank" rel="noopener noreferrer">node-exporter</a> and <a href="https://github.com/kubernetes/kube-state-metrics" target="_blank" rel="noopener noreferrer">kube-state-metrics</a>).</p><p>These default exporters automatically scrape metrics for CPU and memory from all components of your Kubernetes cluster, including your workloads.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="default-alerts">Default Alerts<a href="#default-alerts" class="hash-link" aria-label="Direct link to Default Alerts" title="Direct link to Default Alerts">​</a></h3><p>The monitoring application deploys some alerts by default. To see the default alerts, go to the <a href="/integrations-in-rancher/monitoring-and-alerting/built-in-dashboards#alertmanager-ui">Alertmanager UI</a> and click <strong>Expand all groups.</strong></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="components-exposed-in-the-rancher-ui">Components Exposed in the Rancher UI<a href="#components-exposed-in-the-rancher-ui" class="hash-link" aria-label="Direct link to Components Exposed in the Rancher UI" title="Direct link to Components Exposed in the Rancher UI">​</a></h3><p>For a list of monitoring components exposed in the Rancher UI, along with common use cases for editing them, see <a href="/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works#components-exposed-in-the-rancher-ui">this section.</a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="role-based-access-control">Role-based Access Control<a href="#role-based-access-control" class="hash-link" aria-label="Direct link to Role-based Access Control" title="Direct link to Role-based Access Control">​</a></h2><p>For information on configuring access to monitoring, see <a href="/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring">this page.</a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="guides">Guides<a href="#guides" class="hash-link" aria-label="Direct link to Guides" title="Direct link to Guides">​</a></h2><ul><li><a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/enable-monitoring">Enable monitoring</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/uninstall-monitoring">Uninstall monitoring</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/set-up-monitoring-for-workloads">Monitoring workloads</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/customize-grafana-dashboard">Customizing Grafana dashboards</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/create-persistent-grafana-dashboard">Persistent Grafana dashboards</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage">Debugging high memory usage</a></li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="configuration">Configuration<a href="#configuration" class="hash-link" aria-label="Direct link to Configuration" title="Direct link to Configuration">​</a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="configuring-monitoring-resources-in-rancher">Configuring Monitoring Resources in Rancher<a href="#configuring-monitoring-resources-in-rancher" class="hash-link" aria-label="Direct link to Configuring Monitoring Resources in Rancher" title="Direct link to Configuring Monitoring Resources in Rancher">​</a></h3><p>The configuration reference assumes familiarity with how monitoring components work together. For more information, see <a href="/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works">How Monitoring Works.</a></p><ul><li><a href="/reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors">ServiceMonitor and PodMonitor</a></li><li><a href="/reference-guides/monitoring-v2-configuration/receivers">Receiver</a></li><li><a href="/reference-guides/monitoring-v2-configuration/routes">Route</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheusrules">PrometheusRule</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/prometheus">Prometheus</a></li><li><a href="/how-to-guides/advanced-user-guides/monitoring-v2-configuration-guides/advanced-configuration/alertmanager">Alertmanager</a></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="configuring-helm-chart-options">Configuring Helm Chart Options<a href="#configuring-helm-chart-options" class="hash-link" aria-label="Direct link to Configuring Helm Chart Options" title="Direct link to Configuring Helm Chart Options">​</a></h3><p>For more information on <code>rancher-monitoring</code> chart options, including options to set resource limits and requests, see <a href="/reference-guides/monitoring-v2-configuration/helm-chart-options">Helm Chart Options</a>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="windows-cluster-support">Windows Cluster Support<a href="#windows-cluster-support" class="hash-link" aria-label="Direct link to Windows Cluster Support" title="Direct link to Windows Cluster Support">​</a></h2><p>When deployed onto an RKE1 Windows cluster, Monitoring V2 will now automatically deploy a <a href="https://github.com/prometheus-community/windows_exporter" target="_blank" rel="noopener noreferrer">windows-exporter</a> DaemonSet and set up a ServiceMonitor to collect metrics from each of the deployed Pods. This will populate Prometheus with <code>windows_</code> metrics that are akin to the <code>node_</code> metrics exported by <a href="https://github.com/prometheus/node_exporter" target="_blank" rel="noopener noreferrer">node_exporter</a> for Linux hosts.</p><p>To be able to fully deploy Monitoring V2 for Windows, all of your Windows hosts must have a minimum <a href="https://github.com/rancher/wins" target="_blank" rel="noopener noreferrer">wins</a> version of v0.1.0.</p><p>For more details on how to upgrade wins on existing Windows hosts, see <a href="/integrations-in-rancher/monitoring-and-alerting/windows-support">Windows cluster support for Monitoring V2.</a>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="known-issues">Known Issues<a href="#known-issues" class="hash-link" aria-label="Direct link to Known Issues" title="Direct link to Known Issues">​</a></h2><p>There is a <a href="https://github.com/rancher/rancher/issues/28787#issuecomment-693611821" target="_blank" rel="noopener noreferrer">known issue</a> that K3s clusters require more than the allotted default memory. If you enable monitoring on a K3s cluster, set <code>prometheus.prometheusSpec.resources.memory.limit</code> to 2500 Mi and <code>prometheus.prometheusSpec.resources.memory.request</code> to 1750 Mi.</p><p>See <a href="/how-to-guides/advanced-user-guides/monitoring-alerting-guides/debug-high-memory-usage">Debugging High Memory Usage</a> for advice and recommendations.</p></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/docs/pages-for-subheaders/monitoring-and-alerting.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-03-24T14:37:42.000Z">Mar 24, 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="/integrations-in-rancher/logging/custom-resource-configuration/outputs-and-clusteroutputs"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Outputs and ClusterOutputs</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">How Monitoring Works</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="#features" class="table-of-contents__link toc-highlight">Features</a></li><li><a href="#default-components-and-deployments" class="table-of-contents__link toc-highlight">Default Components and Deployments</a><ul><li><a href="#built-in-dashboards" class="table-of-contents__link toc-highlight">Built-in Dashboards</a></li><li><a href="#default-metrics-exporters" class="table-of-contents__link toc-highlight">Default Metrics Exporters</a></li><li><a href="#default-alerts" class="table-of-contents__link toc-highlight">Default Alerts</a></li><li><a href="#components-exposed-in-the-rancher-ui" class="table-of-contents__link toc-highlight">Components Exposed in the Rancher UI</a></li></ul></li><li><a href="#role-based-access-control" class="table-of-contents__link toc-highlight">Role-based Access Control</a></li><li><a href="#guides" class="table-of-contents__link toc-highlight">Guides</a></li><li><a href="#configuration" class="table-of-contents__link toc-highlight">Configuration</a><ul><li><a href="#configuring-monitoring-resources-in-rancher" class="table-of-contents__link toc-highlight">Configuring Monitoring Resources in Rancher</a></li><li><a href="#configuring-helm-chart-options" class="table-of-contents__link toc-highlight">Configuring Helm Chart Options</a></li></ul></li><li><a href="#windows-cluster-support" class="table-of-contents__link toc-highlight">Windows Cluster Support</a></li><li><a href="#known-issues" class="table-of-contents__link toc-highlight">Known Issues</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 SUSE Rancher. All Rights Reserved.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.b0c4bb1a.js"></script>
<script src="/assets/js/main.d8782442.js"></script>
</body>
</html>