mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-30 06:54:09 +00:00
30 lines
81 KiB
HTML
30 lines
81 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-2.5 plugin-docs plugin-id-default docs-doc-id-reference-guides/monitoring-v2-configuration/receivers" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v2.4.3">
|
||
<title data-rh="true">Receiver Configuration | 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="https://ranchermanager.docs.rancher.com/v2.5/reference-guides/monitoring-v2-configuration/receivers"><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="2.5"><meta data-rh="true" name="docusaurus_tag" content="docs-default-2.5"><meta data-rh="true" name="docsearch:version" content="2.5"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-2.5"><meta data-rh="true" property="og:title" content="Receiver Configuration | Rancher"><meta data-rh="true" name="description" content="The Alertmanager Config Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus."><meta data-rh="true" property="og:description" content="The Alertmanager Config Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="alternate" href="https://ranchermanager.docs.rancher.com/v2.5/reference-guides/monitoring-v2-configuration/receivers" hreflang="en"><link data-rh="true" rel="alternate" href="https://ranchermanager.docs.rancher.com/zh/v2.5/reference-guides/monitoring-v2-configuration/receivers" hreflang="zh"><link data-rh="true" rel="alternate" href="https://ranchermanager.docs.rancher.com/v2.5/reference-guides/monitoring-v2-configuration/receivers" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://30NEY6C9UY-dsn.algolia.net" crossorigin="anonymous"><link data-rh="true" rel="canonical" href="https://ranchermanager.docs.rancher.com/reference-guides/monitoring-v2-configuration/receivers"><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.dea80607.css">
|
||
<link rel="preload" href="/assets/js/runtime~main.d98f8a34.js" as="script">
|
||
<link rel="preload" href="/assets/js/main.e9ebdfba.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=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||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.5">v2.5</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/reference-guides/monitoring-v2-configuration/receivers">Latest</a></li><li><a class="dropdown__link" href="/v2.9/reference-guides/monitoring-v2-configuration/receivers">v2.9 (Preview)</a></li><li><a class="dropdown__link" href="/v2.8/reference-guides/monitoring-v2-configuration/receivers">v2.8</a></li><li><a class="dropdown__link" href="/v2.7/reference-guides/monitoring-v2-configuration/receivers">v2.7</a></li><li><a class="dropdown__link" href="/v2.6/reference-guides/monitoring-v2-configuration/receivers">v2.6</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/v2.5/reference-guides/monitoring-v2-configuration/receivers">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 class="navbar__item dropdown dropdown--hoverable"><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="/v2.5/reference-guides/monitoring-v2-configuration/receivers" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh/v2.5/reference-guides/monitoring-v2-configuration/receivers" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">简体中文</a></li></ul></div><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 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">Quick Links</a><ul class="dropdown__menu"><li><a href="https://github.com/rancher/rancher" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" 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></li><li><a href="https://github.com/rancher/rancher-docs" target="_blank" rel="noopener noreferrer" class="dropdown__link">Docs GitHub<svg width="12" height="12" 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></li></ul></div><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">More from SUSE</a><ul class="dropdown__menu"><li><a href="https://www.rancher.com" target="_blank" rel="noopener noreferrer" class="dropdown__link navbar__icon navbar__rancher">Rancher<svg width="12" height="12" 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></li><li><hr style="margin: 0.3rem 0;"></li><li><a href="https://elemental.docs.rancher.com/" target="_blank" rel="noopener noreferrer" class="dropdown__link navbar__icon navbar__elemental">Elemental<svg width="12" height="12" 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></li><li><a href="https://fleet.rancher.io/" target="_blank" rel="noopener noreferrer" class="dropdown__link navbar__icon navbar__fleet">Fleet<svg width="12" height="12" 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></li><li><a href="https://harvesterhci.io" target="_blank" rel="noopener noreferrer" class="dropdown__link navbar__icon navbar__harvester">Harvester<svg width="12" height="12" 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></li><li><a href="https://rancherdesktop.io/" target="_blank" rel="noopener noreferrer" class="dropdown__link navbar__icon navbar__rancher__desktop">Rancher Desktop<svg width="12" height="12" 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></li><li><hr style="margin: 0.3rem 0;"></li><li><a href="https://opensource.suse.com" target="_blank" rel="noopener noreferrer" class="dropdown__link navbar__icon navbar__suse">More Projects...<svg width="12" height="12" 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></li></ul></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="/v2.5">Rancher 2.5</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" aria-expanded="false" href="/v2.5/getting-started">Getting Started</a><button aria-label="Toggle the collapsible sidebar category 'Getting Started'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/v2.5/how-to-guides">How-to Guides</a><button aria-label="Toggle the collapsible sidebar category 'How-to Guides'" type="button" class="clean-btn menu__caret"></button></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--active" aria-expanded="true" href="/v2.5/reference-guides">Reference Guides</a><button aria-label="Toggle the collapsible sidebar category 'Reference Guides'" 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-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="/v2.5/reference-guides/best-practices">Best Practice Guides</a><button aria-label="Toggle the collapsible sidebar category 'Best Practice Guides'" 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="/v2.5/reference-guides/rancher-manager-architecture">Rancher Architecture</a><button aria-label="Toggle the collapsible sidebar category 'Rancher Architecture'" 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="/v2.5/reference-guides/cluster-configuration">Cluster Configuration</a><button aria-label="Toggle the collapsible sidebar category 'Cluster Configuration'" 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="/v2.5/reference-guides/single-node-rancher-in-docker">Single-Node Rancher in Docker</a><button aria-label="Toggle the collapsible sidebar category 'Single-Node Rancher in Docker'" 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="/v2.5/reference-guides/installation-references">Installation References</a><button aria-label="Toggle the collapsible sidebar category 'Installation References'" 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="/v2.5/reference-guides/amazon-eks-permissions">Amazon EKS Permissions</a><button aria-label="Toggle the collapsible sidebar category 'Amazon EKS Permissions'" 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="/v2.5/reference-guides/backup-restore-configuration">Backup & Restore Configuration</a><button aria-label="Toggle the collapsible sidebar category 'Backup & Restore Configuration'" 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="/v2.5/reference-guides/configure-openldap">Configuring OpenLDAP</a><button aria-label="Toggle the collapsible sidebar category 'Configuring OpenLDAP'" 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="/v2.5/reference-guides/kubernetes-concepts">Kubernetes Concepts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" tabindex="0" href="/v2.5/reference-guides/monitoring-v2-configuration">Monitoring V2 Configuration</a><button aria-label="Toggle the collapsible sidebar category 'Monitoring V2 Configuration'" 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 menu__link--active" aria-current="page" tabindex="0" href="/v2.5/reference-guides/monitoring-v2-configuration/receivers">Receiver Configuration</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="/v2.5/reference-guides/monitoring-v2-configuration/routes">Route Configuration</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="/v2.5/reference-guides/monitoring-v2-configuration/servicemonitors-and-podmonitors">ServiceMonitor and PodMonitor Configuration</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="/v2.5/reference-guides/monitoring-v2-configuration/helm-chart-options">Helm Chart Options</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="/v2.5/reference-guides/monitoring-v2-configuration/examples">Monitoring V2 Configuration Examples</a></li></ul></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="/v2.5/reference-guides/user-settings">User Settings</a><button aria-label="Toggle the collapsible sidebar category 'User Settings'" 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="/v2.5/reference-guides/cli-with-rancher">CLI with Rancher</a><button aria-label="Toggle the collapsible sidebar category 'CLI with Rancher'" 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="/v2.5/reference-guides/about-the-api">About the API</a><button aria-label="Toggle the collapsible sidebar category 'About the API'" 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="/v2.5/reference-guides/rancher-cluster-tools">Tools for Logging, Monitoring, and Visibility</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="/v2.5/reference-guides/rancher-project-tools">Tools for Logging, Monitoring, and Visibility</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="/v2.5/reference-guides/system-tools">System Tools</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="/v2.5/reference-guides/rke1-template-example-yaml">RKE1 Example YAML</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="/v2.5/reference-guides/rancher-security">Rancher Security Guides</a><button aria-label="Toggle the collapsible sidebar category 'Rancher Security Guides'" type="button" class="clean-btn menu__caret"></button></div></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" aria-expanded="false" href="/v2.5/explanations">Explanations</a><button aria-label="Toggle the collapsible sidebar category 'Explanations'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/v2.5/faq">FAQ</a><button aria-label="Toggle the collapsible sidebar category 'FAQ'" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/v2.5/troubleshooting">Troubleshooting</a><button aria-label="Toggle the collapsible sidebar category 'Troubleshooting'" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/v2.5/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="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->Rancher<!-- --> <b>v2.5</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/reference-guides/monitoring-v2-configuration/receivers">latest version</a></b> (<!-- -->Latest<!-- -->).</div></div><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 itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/v2.5/reference-guides"><span itemprop="name">Reference Guides</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/v2.5/reference-guides/monitoring-v2-configuration"><span itemprop="name">Monitoring V2 Configuration</span></a><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Receiver Configuration</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: v2.5</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>Receiver Configuration</h1></header><p>The <a href="https://prometheus.io/docs/alerting/latest/configuration/#configuration-file" target="_blank" rel="noopener noreferrer">Alertmanager Config</a> Secret contains the configuration of an Alertmanager instance that sends out notifications based on alerts it receives from Prometheus.</p><blockquote><p>This section assumes familiarity with how monitoring components work together. For more information about Alertmanager, see <a href="/v2.5/explanations/integrations-in-rancher/monitoring-and-alerting/how-monitoring-works#3-how-alertmanager-works">this section.</a></p></blockquote><h2 class="anchor anchorWithStickyNavbar_LWe7" id="creating-receivers-in-the-rancher-ui">Creating Receivers in the Rancher UI<a href="#creating-receivers-in-the-rancher-ui" class="hash-link" aria-label="Direct link to Creating Receivers in the Rancher UI" title="Direct link to Creating Receivers in the Rancher UI"></a></h2><p><em>Available as of v2.5.4</em></p><blockquote><p><strong>Prerequisites:</strong></p><ul><li>The monitoring application needs to be installed.</li><li>If you configured monitoring with an existing Alertmanager Secret, it must have a format that is supported by Rancher's UI. Otherwise you will only be able to make changes based on modifying the Alertmanager Secret directly. Note: We are continuing to make enhancements to what kinds of Alertmanager Configurations we can support using the Routes and Receivers UI, so please <a href="https://github.com/rancher/rancher/issues/new" target="_blank" rel="noopener noreferrer">file an issue</a> if you have a request for a feature enhancement.</li></ul></blockquote><p>To create notification receivers in the Rancher UI,</p><ol><li>Click <strong>Cluster Explorer > Monitoring</strong> and click <strong>Receiver.</strong></li><li>Enter a name for the receiver.</li><li>Configure one or more providers for the receiver. For help filling out the forms, refer to the configuration options below.</li><li>Click <strong>Create.</strong></li></ol><p><strong>Result:</strong> Alerts can be configured to send notifications to the receiver(s).</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="receiver-configuration">Receiver Configuration<a href="#receiver-configuration" class="hash-link" aria-label="Direct link to Receiver Configuration" title="Direct link to Receiver Configuration"></a></h2><p>The notification integrations are configured with the <code>receiver</code>, which is explained in the <a href="https://prometheus.io/docs/alerting/latest/configuration/#receiver" target="_blank" rel="noopener noreferrer">Prometheus documentation.</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="native-vs-non-native-receivers">Native vs. Non-native Receivers<a href="#native-vs-non-native-receivers" class="hash-link" aria-label="Direct link to Native vs. Non-native Receivers" title="Direct link to Native vs. Non-native Receivers"></a></h3><p>By default, AlertManager provides native integration with some receivers, which are listed in <a href="https://prometheus.io/docs/alerting/latest/configuration/#receiver" target="_blank" rel="noopener noreferrer">this section.</a> All natively supported receivers are configurable through the Rancher UI.</p><p>For notification mechanisms not natively supported by AlertManager, integration is achieved using the <a href="https://prometheus.io/docs/alerting/latest/configuration/#webhook_config" target="_blank" rel="noopener noreferrer">webhook receiver.</a> A list of third-party drivers providing such integrations can be found <a href="https://prometheus.io/docs/operating/integrations/#alertmanager-webhook-receiver" target="_blank" rel="noopener noreferrer">here.</a> Access to these drivers, and their associated integrations, is provided through the Alerting Drivers app. Once enabled, configuring non-native receivers can also be done through the Rancher UI.</p><p>Currently the Rancher Alerting Drivers app provides access to the following integrations:</p><ul><li>Microsoft Teams, based on the <a href="https://github.com/idealista/prom2teams" target="_blank" rel="noopener noreferrer">prom2teams</a> driver</li><li>SMS, based on the <a href="https://github.com/messagebird/sachet" target="_blank" rel="noopener noreferrer">Sachet</a> driver</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="changes-in-rancher-v258">Changes in Rancher v2.5.8<a href="#changes-in-rancher-v258" class="hash-link" aria-label="Direct link to Changes in Rancher v2.5.8" title="Direct link to Changes in Rancher v2.5.8"></a></h3><p>Rancher v2.5.8 added Microsoft Teams and SMS as configurable receivers in the Rancher UI.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="changes-in-rancher-v254">Changes in Rancher v2.5.4<a href="#changes-in-rancher-v254" class="hash-link" aria-label="Direct link to Changes in Rancher v2.5.4" title="Direct link to Changes in Rancher v2.5.4"></a></h3><p>Rancher v2.5.4 introduced the capability to configure receivers by filling out forms in the Rancher UI.</p><div class="tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">Rancher v2.5.8+</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Rancher v2.5.4-2.5.7</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">Rancher v2.5.0-2.5.3</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><p>The following types of receivers can be configured in the Rancher UI:</p><ul><li><a href="#slack">Slack</a></li><li><a href="#email">Email</a></li><li><a href="#pagerduty">PagerDuty</a></li><li><a href="#opsgenie">Opsgenie</a></li><li><a href="#webhook">Webhook</a></li><li><a href="#custom">Custom</a></li><li><a href="#teams">Teams</a></li><li><a href="#sms">SMS</a></li></ul><p>The custom receiver option can be used to configure any receiver in YAML that cannot be configured by filling out the other forms in the Rancher UI.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="slack">Slack<a href="#slack" class="hash-link" aria-label="Direct link to Slack" title="Direct link to Slack"></a></h2><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>URL</td><td>String</td><td>Enter your Slack webhook URL. For instructions to create a Slack webhook, see the <a href="https://get.slack.help/hc/en-us/articles/115005265063-Incoming-WebHooks-for-Slack" target="_blank" rel="noopener noreferrer">Slack documentation.</a></td></tr><tr><td>Default Channel</td><td>String</td><td>Enter the name of the channel that you want to send alert notifications in the following format: <code>#<channelname></code>.</td></tr><tr><td>Proxy URL</td><td>String</td><td>Proxy for the webhook notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Bool</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="email">Email<a href="#email" class="hash-link" aria-label="Direct link to Email" title="Direct link to Email"></a></h2><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Default Recipient Address</td><td>String</td><td>The email address that will receive notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Bool</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><p>SMTP options:</p><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Sender</td><td>String</td><td>Enter an email address available on your SMTP mail server that you want to send the notification from.</td></tr><tr><td>Host</td><td>String</td><td>Enter the IP address or hostname for your SMTP server. Example: <code>smtp.email.com</code>.</td></tr><tr><td>Use TLS</td><td>Bool</td><td>Use TLS for encryption.</td></tr><tr><td>Username</td><td>String</td><td>Enter a username to authenticate with the SMTP server.</td></tr><tr><td>Password</td><td>String</td><td>Enter a password to authenticate with the SMTP server.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="pagerduty">PagerDuty<a href="#pagerduty" class="hash-link" aria-label="Direct link to PagerDuty" title="Direct link to PagerDuty"></a></h2><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Integration Type</td><td>String</td><td><code>Events API v2</code> or <code>Prometheus</code>.</td></tr><tr><td>Default Integration Key</td><td>String</td><td>For instructions to get an integration key, see the <a href="https://www.pagerduty.com/docs/guides/prometheus-integration-guide/" target="_blank" rel="noopener noreferrer">PagerDuty documentation.</a></td></tr><tr><td>Proxy URL</td><td>String</td><td>Proxy for the PagerDuty notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Bool</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="opsgenie">Opsgenie<a href="#opsgenie" class="hash-link" aria-label="Direct link to Opsgenie" title="Direct link to Opsgenie"></a></h2><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td>API Key</td><td>For instructions to get an API key, refer to the <a href="https://docs.opsgenie.com/docs/api-key-management" target="_blank" rel="noopener noreferrer">Opsgenie documentation.</a></td></tr><tr><td>Proxy URL</td><td>Proxy for the Opsgenie notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><p>Opsgenie Responders:</p><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Type</td><td>String</td><td>Schedule, Team, User, or Escalation. For more information on alert responders, refer to the <a href="https://docs.opsgenie.com/docs/alert-recipients-and-teams" target="_blank" rel="noopener noreferrer">Opsgenie documentation.</a></td></tr><tr><td>Send To</td><td>String</td><td>Id, Name, or Username of the Opsgenie recipient.</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="webhook">Webhook<a href="#webhook" class="hash-link" aria-label="Direct link to Webhook" title="Direct link to Webhook"></a></h2><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td>URL</td><td>Webhook URL for the app of your choice.</td></tr><tr><td>Proxy URL</td><td>Proxy for the webhook notification.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="custom">Custom<a href="#custom" class="hash-link" aria-label="Direct link to Custom" title="Direct link to Custom"></a></h2><p>The YAML provided here will be directly appended to your receiver within the Alertmanager Config Secret.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="teams">Teams<a href="#teams" class="hash-link" aria-label="Direct link to Teams" title="Direct link to Teams"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="enabling-the-teams-receiver-for-rancher-managed-clusters">Enabling the Teams Receiver for Rancher Managed Clusters<a href="#enabling-the-teams-receiver-for-rancher-managed-clusters" class="hash-link" aria-label="Direct link to Enabling the Teams Receiver for Rancher Managed Clusters" title="Direct link to Enabling the Teams Receiver for Rancher Managed Clusters"></a></h3><p>The Teams receiver is not a native receiver and must be enabled before it can be used. You can enable the Teams receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the Teams option selected.</p><ol><li>In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click <strong>Cluster Explorer</strong>.</li><li>Click <strong>Apps</strong>.</li><li>Click the <strong>Alerting Drivers</strong> app.</li><li>Click the <strong>Helm Deploy Options</strong> tab</li><li>Select the <strong>Teams</strong> option and click <strong>Install</strong>.</li><li>Take note of the namespace used as it will be required in a later step.</li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="configure-the-teams-receiver">Configure the Teams Receiver<a href="#configure-the-teams-receiver" class="hash-link" aria-label="Direct link to Configure the Teams Receiver" title="Direct link to Configure the Teams Receiver"></a></h3><p>The Teams receiver can be configured by updating its ConfigMap. For example, the following is a minimal Teams receiver configuration.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">Microsoft Teams</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">teams-instance-1</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> https</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain">//your</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">teams</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">webhook</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">url</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When configuration is complete, add the receiver using the steps in <a href="#creating-receivers-in-the-rancher-ui">this section</a>.</p><p>Use the example below as the URL where:</p><ul><li><code>ns-1</code> is replaced with the namespace where the <code>rancher-alerting-drivers</code> app is installed</li></ul><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">url</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> http</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain">//rancher</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">alerting</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">drivers</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">prom2teams.ns</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">1.svc</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain">8089/v2/teams</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">instance</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sms">SMS<a href="#sms" class="hash-link" aria-label="Direct link to SMS" title="Direct link to SMS"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="enabling-the-sms-receiver-for-rancher-managed-clusters">Enabling the SMS Receiver for Rancher Managed Clusters<a href="#enabling-the-sms-receiver-for-rancher-managed-clusters" class="hash-link" aria-label="Direct link to Enabling the SMS Receiver for Rancher Managed Clusters" title="Direct link to Enabling the SMS Receiver for Rancher Managed Clusters"></a></h3><p>The SMS receiver is not a native receiver and must be enabled before it can be used. You can enable the SMS receiver for a Rancher managed cluster by going to the Apps page and installing the rancher-alerting-drivers app with the SMS option selected.</p><ol><li>In the Rancher UI, go to the cluster where you want to install rancher-alerting-drivers and click <strong>Cluster Explorer</strong>.</li><li>Click <strong>Apps</strong>.</li><li>Click the <strong>Alerting Drivers</strong> app.</li><li>Click the <strong>Helm Deploy Options</strong> tab</li><li>Select the <strong>SMS</strong> option and click <strong>Install</strong>.</li><li>Take note of the namespace used as it will be required in a later step.</li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="configure-the-sms-receiver">Configure the SMS Receiver<a href="#configure-the-sms-receiver" class="hash-link" aria-label="Direct link to Configure the SMS Receiver" title="Direct link to Configure the SMS Receiver"></a></h3><p>The SMS receiver can be configured by updating its ConfigMap. For example, the following is a minimal SMS receiver configuration.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">providers</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">telegram</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">token</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'your-token-from-telegram'</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 key atrule">receivers</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'telegram-receiver-1'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">provider</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'telegram'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">to</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'123456789'</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When configuration is complete, add the receiver using the steps in <a href="#creating-receivers-in-the-rancher-ui">this section</a>.</p><p>Use the example below as the name and URL, where:</p><ul><li>the name assigned to the receiver, e.g. <code>telegram-receiver-1</code>, must match the name in the <code>receivers.name</code> field in the ConfigMap, e.g. <code>telegram-receiver-1</code></li><li><code>ns-1</code> in the URL is replaced with the namespace where the <code>rancher-alerting-drivers</code> app is installed</li></ul><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> telegram</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">receiver</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token number" style="color:rgb(247, 140, 108)">1</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">url http</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain">//rancher</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">alerting</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">drivers</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">sachet.ns</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">1.svc</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain">9876/alert</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>The following types of receivers can be configured in the Rancher UI:</p><ul><li><a href="#slack-254-257">Slack</a></li><li><a href="#email-254-257">Email</a></li><li><a href="#pagerduty-254-257">PagerDuty</a></li><li><a href="#opsgenie-254-257">Opsgenie</a></li><li><a href="#webhook-254-257">Webhook</a></li><li><a href="#custom-254-257">Custom</a></li></ul><p>The custom receiver option can be used to configure any receiver in YAML that cannot be configured by filling out the other forms in the Rancher UI.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="slack-254-257">Slack<a href="#slack-254-257" class="hash-link" aria-label="Direct link to Slack" title="Direct link to Slack"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>URL</td><td>String</td><td>Enter your Slack webhook URL. For instructions to create a Slack webhook, see the <a href="https://get.slack.help/hc/en-us/articles/115005265063-Incoming-WebHooks-for-Slack" target="_blank" rel="noopener noreferrer">Slack documentation.</a></td></tr><tr><td>Default Channel</td><td>String</td><td>Enter the name of the channel that you want to send alert notifications in the following format: <code>#<channelname></code>.</td></tr><tr><td>Proxy URL</td><td>String</td><td>Proxy for the webhook notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Bool</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="email-254-257">Email<a href="#email-254-257" class="hash-link" aria-label="Direct link to Email" title="Direct link to Email"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Default Recipient Address</td><td>String</td><td>The email address that will receive notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Bool</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><p>SMTP options:</p><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Sender</td><td>String</td><td>Enter an email address available on your SMTP mail server that you want to send the notification from.</td></tr><tr><td>Host</td><td>String</td><td>Enter the IP address or hostname for your SMTP server. Example: <code>smtp.email.com</code>.</td></tr><tr><td>Use TLS</td><td>Bool</td><td>Use TLS for encryption.</td></tr><tr><td>Username</td><td>String</td><td>Enter a username to authenticate with the SMTP server.</td></tr><tr><td>Password</td><td>String</td><td>Enter a password to authenticate with the SMTP server.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="pagerduty-254-257">PagerDuty<a href="#pagerduty-254-257" class="hash-link" aria-label="Direct link to PagerDuty" title="Direct link to PagerDuty"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Integration Type</td><td>String</td><td><code>Events API v2</code> or <code>Prometheus</code>.</td></tr><tr><td>Default Integration Key</td><td>String</td><td>For instructions to get an integration key, see the <a href="https://www.pagerduty.com/docs/guides/prometheus-integration-guide/" target="_blank" rel="noopener noreferrer">PagerDuty documentation.</a></td></tr><tr><td>Proxy URL</td><td>String</td><td>Proxy for the PagerDuty notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Bool</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="opsgenie-254-257">Opsgenie<a href="#opsgenie-254-257" class="hash-link" aria-label="Direct link to Opsgenie" title="Direct link to Opsgenie"></a></h3><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td>API Key</td><td>For instructions to get an API key, refer to the <a href="https://docs.opsgenie.com/docs/api-key-management" target="_blank" rel="noopener noreferrer">Opsgenie documentation.</a></td></tr><tr><td>Proxy URL</td><td>Proxy for the Opsgenie notifications.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><p>Opsgenie Responders:</p><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Type</td><td>String</td><td>Schedule, Team, User, or Escalation. For more information on alert responders, refer to the <a href="https://docs.opsgenie.com/docs/alert-recipients-and-teams" target="_blank" rel="noopener noreferrer">Opsgenie documentation.</a></td></tr><tr><td>Send To</td><td>String</td><td>Id, Name, or Username of the Opsgenie recipient.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="webhook-1">Webhook<a href="#webhook-1" class="hash-link" aria-label="Direct link to Webhook" title="Direct link to Webhook"></a></h3><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td>URL</td><td>Webhook URL for the app of your choice.</td></tr><tr><td>Proxy URL</td><td>Proxy for the webhook notification.</td></tr><tr><td>Enable Send Resolved Alerts</td><td>Whether to send a follow-up notification if an alert has been resolved (e.g. <!-- -->[Resolved]<!-- --> High CPU Usage).</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="custom-254-257">Custom<a href="#custom-254-257" class="hash-link" aria-label="Direct link to Custom" title="Direct link to Custom"></a></h3><p>The YAML provided here will be directly appended to your receiver within the Alertmanager Config Secret.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden="">The Alertmanager must be configured in YAML, as shown in these [examples.](#example-alertmanager-configs)</div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="configuring-multiple-receivers">Configuring Multiple Receivers<a href="#configuring-multiple-receivers" class="hash-link" aria-label="Direct link to Configuring Multiple Receivers" title="Direct link to Configuring Multiple Receivers"></a></h2><p>By editing the forms in the Rancher UI, you can set up a Receiver resource with all the information Alertmanager needs to send alerts to your notification system.</p><p>It is also possible to send alerts to multiple notification systems. One way is to configure the Receiver using custom YAML, in which case you can add the configuration for multiple notification systems, as long as you are sure that both systems should receive the same messages.</p><p>You can also set up multiple receivers by using the <code>continue</code> option for a route, so that the alerts sent to a receiver continue being evaluated in the next level of the routing tree, which could contain another receiver.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="example-alertmanager-configs">Example Alertmanager Configs<a href="#example-alertmanager-configs" class="hash-link" aria-label="Direct link to Example Alertmanager Configs" title="Direct link to Example Alertmanager Configs"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="slack-1">Slack<a href="#slack-1" class="hash-link" aria-label="Direct link to Slack" title="Direct link to Slack"></a></h3><p>To set up notifications via Slack, the following Alertmanager Config YAML can be placed into the <code>alertmanager.yaml</code> key of the Alertmanager Config Secret, where the <code>api_url</code> should be updated to use your Webhook URL from Slack:</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">route</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_by</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(195, 232, 141)">'job'</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_wait</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 30s</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_interval</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 5m</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">repeat_interval</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 3h</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">receiver</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'slack-notifications'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">receivers</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'slack-notifications'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">slack_configs</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">send_resolved</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token boolean important" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">text</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'{{ template "slack.rancher.text" . }}'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">api_url</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> <user</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">provided slack webhook url here</span><span class="token punctuation" style="color:rgb(199, 146, 234)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token key atrule">templates</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> /etc/alertmanager/config/</span><span class="token important">*.tmpl</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="pagerduty-1">PagerDuty<a href="#pagerduty-1" class="hash-link" aria-label="Direct link to PagerDuty" title="Direct link to PagerDuty"></a></h3><p>To set up notifications via PagerDuty, use the example below from the <a href="https://www.pagerduty.com/docs/guides/prometheus-integration-guide/" target="_blank" rel="noopener noreferrer">PagerDuty documentation</a> as a guideline. This example sets up a route that captures alerts for a database service and sends them to a receiver linked to a service that will directly notify the DBAs in PagerDuty, while all other alerts will be directed to a default receiver with a different PagerDuty integration key.</p><p>The following Alertmanager Config YAML can be placed into the <code>alertmanager.yaml</code> key of the Alertmanager Config Secret. The <code>service_key</code> should be updated to use your PagerDuty integration key and can be found as per the "Integrating with Global Event Routing" section of the PagerDuty documentation. For the full list of configuration options, refer to the <a href="https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config" target="_blank" rel="noopener noreferrer">Prometheus documentation</a>.</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">route</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_by</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">cluster</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">receiver</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'pagerduty-notifications'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_interval</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 5m</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">routes</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">match</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">service</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> database</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">receiver</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'database-notifcations'</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 key atrule">receivers</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'pagerduty-notifications'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">pagerduty_configs</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">service_key</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'primary-integration-key'</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 punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">name</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'database-notifcations'</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">pagerduty_configs</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain"> </span><span class="token key atrule">service_key</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(195, 232, 141)">'database-integration-key'</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="example-route-config-for-cis-scan-alerts">Example Route Config for CIS Scan Alerts<a href="#example-route-config-for-cis-scan-alerts" class="hash-link" aria-label="Direct link to Example Route Config for CIS Scan Alerts" title="Direct link to Example Route Config for CIS Scan Alerts"></a></h2><p>While configuring the routes for <code>rancher-cis-benchmark</code> alerts, you can specify the matching using the key-value pair <code>job: rancher-cis-scan</code>.</p><p>For example, the following example route configuration could be used with a Slack receiver named <code>test-cis</code>:</p><div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token key atrule">spec</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">receiver</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> test</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">cis</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_by</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></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"># - string</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_wait</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 30s</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">group_interval</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 30s</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">repeat_interval</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> 30s</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">match</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">job</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"> rancher</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">cis</span><span class="token punctuation" style="color:rgb(199, 146, 234)">-</span><span class="token plain">scan</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"># key: string</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token key atrule">match_re</span><span class="token punctuation" style="color:rgb(199, 146, 234)">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">{</span><span class="token punctuation" style="color:rgb(199, 146, 234)">}</span><span class="token plain"></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"># key: string</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 viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" 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 viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>For more information on enabling alerting for <code>rancher-cis-benchmark</code>, see <a href="/v2.5/how-to-guides/advanced-user-guides/cis-scan-guides/enable-alerting-for-rancher-cis-benchmark">this section.</a></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="trusted-ca-for-notifiers">Trusted CA for Notifiers<a href="#trusted-ca-for-notifiers" class="hash-link" aria-label="Direct link to Trusted CA for Notifiers" title="Direct link to Trusted CA for Notifiers"></a></h2><p>If you need to add a trusted CA to your notifier, follow the steps in <a href="/v2.5/reference-guides/monitoring-v2-configuration/helm-chart-options#trusted-ca-for-notifiers">this section.</a></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/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/receivers.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-10-05T23:32:09.000Z">Oct 5, 2023</time></b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/v2.5/reference-guides/monitoring-v2-configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Monitoring V2 Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/v2.5/reference-guides/monitoring-v2-configuration/routes"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Route Configuration</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="#creating-receivers-in-the-rancher-ui" class="table-of-contents__link toc-highlight">Creating Receivers in the Rancher UI</a></li><li><a href="#receiver-configuration" class="table-of-contents__link toc-highlight">Receiver Configuration</a><ul><li><a href="#native-vs-non-native-receivers" class="table-of-contents__link toc-highlight">Native vs. Non-native Receivers</a></li><li><a href="#changes-in-rancher-v258" class="table-of-contents__link toc-highlight">Changes in Rancher v2.5.8</a></li><li><a href="#changes-in-rancher-v254" class="table-of-contents__link toc-highlight">Changes in Rancher v2.5.4</a></li></ul></li><li><a href="#slack" class="table-of-contents__link toc-highlight">Slack</a></li><li><a href="#email" class="table-of-contents__link toc-highlight">Email</a></li><li><a href="#pagerduty" class="table-of-contents__link toc-highlight">PagerDuty</a></li><li><a href="#opsgenie" class="table-of-contents__link toc-highlight">Opsgenie</a></li><li><a href="#webhook" class="table-of-contents__link toc-highlight">Webhook</a></li><li><a href="#custom" class="table-of-contents__link toc-highlight">Custom</a></li><li><a href="#teams" class="table-of-contents__link toc-highlight">Teams</a><ul><li><a href="#enabling-the-teams-receiver-for-rancher-managed-clusters" class="table-of-contents__link toc-highlight">Enabling the Teams Receiver for Rancher Managed Clusters</a></li><li><a href="#configure-the-teams-receiver" class="table-of-contents__link toc-highlight">Configure the Teams Receiver</a></li></ul></li><li><a href="#sms" class="table-of-contents__link toc-highlight">SMS</a><ul><li><a href="#enabling-the-sms-receiver-for-rancher-managed-clusters" class="table-of-contents__link toc-highlight">Enabling the SMS Receiver for Rancher Managed Clusters</a></li><li><a href="#configure-the-sms-receiver" class="table-of-contents__link toc-highlight">Configure the SMS Receiver</a></li><li><a href="#slack-254-257" class="table-of-contents__link toc-highlight">Slack</a></li><li><a href="#email-254-257" class="table-of-contents__link toc-highlight">Email</a></li><li><a href="#pagerduty-254-257" class="table-of-contents__link toc-highlight">PagerDuty</a></li><li><a href="#opsgenie-254-257" class="table-of-contents__link toc-highlight">Opsgenie</a></li><li><a href="#webhook-1" class="table-of-contents__link toc-highlight">Webhook</a></li><li><a href="#custom-254-257" class="table-of-contents__link toc-highlight">Custom</a></li></ul></li><li><a href="#configuring-multiple-receivers" class="table-of-contents__link toc-highlight">Configuring Multiple Receivers</a></li><li><a href="#example-alertmanager-configs" class="table-of-contents__link toc-highlight">Example Alertmanager Configs</a><ul><li><a href="#slack-1" class="table-of-contents__link toc-highlight">Slack</a></li><li><a href="#pagerduty-1" class="table-of-contents__link toc-highlight">PagerDuty</a></li></ul></li><li><a href="#example-route-config-for-cis-scan-alerts" class="table-of-contents__link toc-highlight">Example Route Config for CIS Scan Alerts</a></li><li><a href="#trusted-ca-for-notifiers" class="table-of-contents__link toc-highlight">Trusted CA for Notifiers</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 © 2024 SUSE Rancher. All Rights Reserved.</div></div></div></footer></div>
|
||
<script src="/assets/js/runtime~main.d98f8a34.js"></script>
|
||
<script src="/assets/js/main.e9ebdfba.js"></script>
|
||
</body>
|
||
</html> |