| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.26" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.99" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Alerting","image":[""],"dateModified":"2025-02-14T07:03:32.000Z","author":[]}</script><meta property="og:url" content="https://iotdb.apache.org/UserGuide/V0.13.x/Process-Data/Alerting.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="Alerting"><meta property="og:description" content="Alerting Overview The alerting of IoTDB is expected to support two modes: Writing triggered: the user writes data to the original time series, and every time a piece of data is ..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2025-02-14T07:03:32.000Z"><meta property="article:modified_time" content="2025-02-14T07:03:32.000Z"><link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/V0.13.x/Process-Data/Alerting.html"><script async src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="2d37bfdd-8d98-40ba-9223-9d4f81bfb327" data-project-name="Apache IoTDB" data-project-color="#FFFFFF" data-button-z-index="1999" data-button-padding="4px" data-button-border-radius="4px" data-button-image-height="24px" data-button-image-width="20px" data-button-text-color="#9E2878" data-project-logo="https://iotdb.apache.org/img/logo.svg" data-button-position-right="16px" data-button-position-bottom="8px" data-button-height="56px" data-button-width="48px" data-button-text="Ask" data-modal-override-open-selector="#custom-ask-ai-button" data-modal-image-width="150px" data-modal-title="AI Docs" data-modal-title-color="#9E2878" data-deep-thinking-button-active-bg-color="#F6F7F8" data-deep-thinking-button-active-text-color="#9E2878" data-deep-thinking-button-active-hover-text-color="#9E2878" data-modal-disclaimer="This is a custom LLM for Apache IoTDB with access to all [documentation](iotdb.apache.org/docs/), [GitHub Open Issues, PRs and READMEs](github.com/apache/iotdb). |
| |
| If you encounter <Error in verifying browser for feedback submission. Captcha token could not be obtained.> please ensure that you can access Google services." data-user-analytics-fingerprint-enabled="true" data-consent-required="true" data-consent-screen-disclaimer="By clicking <I agree, let's chat>, you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript">var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>Alerting | IoTDB Website</title><meta name="description" content="Alerting Overview The alerting of IoTDB is expected to support two modes: Writing triggered: the user writes data to the original time series, and every time a piece of data is ..."> |
| <link rel="preload" href="/assets/style-JraSdRX4.css" as="style"><link rel="stylesheet" href="/assets/style-JraSdRX4.css"> |
| <link rel="modulepreload" href="/assets/app-C72F_R_b.js"><link rel="modulepreload" href="/assets/Alerting.html-nxTe0XR4.js"><link rel="modulepreload" href="/assets/115957896-a9791080-a537-11eb-9962-541412bdcee6-BXLNTglc.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div class="docsearch-placeholder"><button type="button" aria-label="Search" aria-keyshortcuts="Control+k" class="DocSearch DocSearch-Button"><span class="DocSearch-Button-Container"><svg width="20" height="20" viewBox="0 0 24 24" aria-hidden="true" class="DocSearch-Search-Icon"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key DocSearch-Button-Key--ctrl">Ctrl</kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><div><button id="custom-ask-ai-button"> ✨ Ask AI </button></div><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Committers.html" aria-label="Committers"><!---->Committers<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/V0.13.x/Process-Data/Alerting.html" aria-label="English"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/V0.13.x/Process-Data/Alerting.html" aria-label="简体中文"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title">IoTDB User Guide (V0.13.x)</span></p><!----><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><p class="vp-sidebar-header"><!----><span class="vp-sidebar-title">IoTDB User Guide (V0.13.x)</span><!----></p><ul class="vp-sidebar-links"></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">IoTDB Introduction</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Quick Start</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Data Concept</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Syntax Conventions</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">API</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Operate Metadata</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Write and Delete Data</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Query Data</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable active" type="button"><!----><span class="vp-sidebar-title">Process Data</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V0.13.x/Process-Data/UDF-User-Defined-Function.html" aria-label="UDF (User Defined Function)"><!---->UDF (User Defined Function)<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V0.13.x/Process-Data/Select-Into.html" aria-label="Select Into"><!---->Select Into<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V0.13.x/Process-Data/Continuous-Query.html" aria-label="Continuous Query"><!---->Continuous Query<!----></a></li><li><a class="route-link auto-link vp-sidebar-link" href="/UserGuide/V0.13.x/Process-Data/Triggers.html" aria-label="Triggers"><!---->Triggers<!----></a></li><li><a class="route-link route-link-active auto-link vp-sidebar-link active" href="/UserGuide/V0.13.x/Process-Data/Alerting.html" aria-label="Alerting"><!---->Alerting<!----></a></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Administration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Maintenance Tools</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Ecosystem Integration</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">UDF Library</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-header clickable" type="button"><!----><span class="vp-sidebar-title">Reference</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->Alerting</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">7/10/23</span><meta property="datePublished" content="2023-07-10T03:11:17.000Z"></span><!----><span class="page-reading-time-info" aria-label="Reading Time⌛" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>About 5 min</span><meta property="timeRequired" content="PT5M"></span><!----><!----></div><hr></div><!----><div class="" vp-content><!----><div id="markdown-content"><h1 id="alerting" tabindex="-1"><a class="header-anchor" href="#alerting"><span>Alerting</span></a></h1><h2 id="overview" tabindex="-1"><a class="header-anchor" href="#overview"><span>Overview</span></a></h2><p>The alerting of IoTDB is expected to support two modes:</p><ul><li><p>Writing triggered: the user writes data to the original time series, and every time a piece of data is inserted, the judgment logic of <code>trigger</code> will be triggered.<br> If the alerting requirements are met, an alert is sent to the data sink,<br> The data sink then forwards the alert to the external terminal.</p><ul><li>This mode is suitable for scenarios that need to monitor every piece of data in real time.</li><li>Since the operation in the trigger will affect the data writing performance, it is suitable for scenarios that are not sensitive to the original data writing performance.</li></ul></li><li><p>Continuous query: the user writes data to the original time series,<br><code>ContinousQuery</code> periodically queries the original time series, and writes the query results into the new time series,<br> Each write triggers the judgment logic of <code>trigger</code>,<br> If the alerting requirements are met, an alert is sent to the data sink,<br> The data sink then forwards the alert to the external terminal.</p><ul><li>This mode is suitable for scenarios where data needs to be regularly queried within a certain period of time.</li><li>It is Suitable for scenarios where the original data needs to be down-sampled and persisted.</li><li>Since the timing query hardly affects the writing of the original time series, it is suitable for scenarios that are sensitive to the performance of the original data writing performance.</li></ul></li></ul><p>With the introduction of the <code>trigger</code> module and the <code>sink</code> module into IoTDB,<br> at present, users can use these two modules with <code>AlertManager</code> to realize the writing triggered alerting mode.</p><h2 id="deploying-alertmanager" tabindex="-1"><a class="header-anchor" href="#deploying-alertmanager"><span>Deploying AlertManager</span></a></h2><h3 id="installation" tabindex="-1"><a class="header-anchor" href="#installation"><span>Installation</span></a></h3><h4 id="precompiled-binaries" tabindex="-1"><a class="header-anchor" href="#precompiled-binaries"><span>Precompiled binaries</span></a></h4><p>The pre-compiled binary file can be downloaded <a href="https://prometheus.io/download/" target="_blank" rel="noopener noreferrer">here</a>.</p><p>Running command:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">./alertmanager</span><span style="color:#D19A66;"> --config.file=</span><span style="color:#ABB2BF;"><</span><span style="color:#D19A66;">your_file</span><span style="color:#ABB2BF;">></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h4 id="docker-image" tabindex="-1"><a class="header-anchor" href="#docker-image"><span>Docker image</span></a></h4><p>Available at <a href="https://hub.docker.com/r/prom/alertmanager/" target="_blank" rel="noopener noreferrer">Quay.io</a><br> or <a href="https://quay.io/repository/prometheus/alertmanager" target="_blank" rel="noopener noreferrer">Docker Hub</a>.</p><p>Running command:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-shell"><span class="line"><span style="color:#61AFEF;">docker</span><span style="color:#98C379;"> run</span><span style="color:#D19A66;"> --name</span><span style="color:#98C379;"> alertmanager</span><span style="color:#D19A66;"> -d</span><span style="color:#D19A66;"> -p</span><span style="color:#98C379;"> 127.0.0.1:9093:9093</span><span style="color:#98C379;"> quay.io/prometheus/alertmanager</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h3 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h3><p>The following is an example, which can cover most of the configuration rules. For detailed configuration rules, see<br><a href="https://prometheus.io/docs/alerting/latest/configuration/" target="_blank" rel="noopener noreferrer">here</a>.</p><p>Example:</p><div class="language-yaml line-numbers-mode" data-highlighter="shiki" data-ext="yaml" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-yaml"><span class="line"><span style="color:#7F848E;font-style:italic;"># alertmanager.yml</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">global</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # The smarthost and SMTP sender used for mail notifications.</span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_smarthost</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'localhost:25'</span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_from</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'alertmanager@example.org'</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># The root route on which each incoming alert enters.</span></span> |
| <span class="line"><span style="color:#E06C75;">route</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # The root route must not have any matchers as it is the entry point for</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # all alerts. It needs to have a receiver configured so alerts that do not</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # match any of the sub-routes are sent to someone.</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-X-mails'</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # The labels by which incoming alerts are grouped together. For example,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # multiple alerts coming in for cluster=A and alertname=LatencyHigh would</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # be batched into a single group.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> #</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # To aggregate by all possible labels use '...' as the sole label name.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # This effectively disables aggregation entirely, passing through all</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # alerts as-is. This is unlikely to be what you want, unless you have</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # a very low alert volume or your upstream notification system performs</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # its own grouping. Example: group_by: [...]</span></span> |
| <span class="line"><span style="color:#E06C75;"> group_by</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">'alertname'</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">'cluster'</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # When a new group of alerts is created by an incoming alert, wait at</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # least 'group_wait' to send the initial notification.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # This way ensures that you get multiple alerts for the same group that start</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # firing shortly after another are batched together on the first</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # notification.</span></span> |
| <span class="line"><span style="color:#E06C75;"> group_wait</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">30s</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # When the first notification was sent, wait 'group_interval' to send a batch</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # of new alerts that started firing for that group.</span></span> |
| <span class="line"><span style="color:#E06C75;"> group_interval</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">5m</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # If an alert has successfully been sent, wait 'repeat_interval' to</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # resend them.</span></span> |
| <span class="line"><span style="color:#E06C75;"> repeat_interval</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">3h</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # All the above attributes are inherited by all child routes and can</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # overwritten on each.</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # The child route trees.</span></span> |
| <span class="line"><span style="color:#E06C75;"> routes</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # This routes performs a regular expression match on alert labels to</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # catch alerts that are related to a list of services.</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match_re</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> service</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">^(foo1|foo2|baz)$</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-X-mails</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # The service has a sub-route for critical alerts, any alerts</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # that do not match, i.e. severity != critical, fall-back to the</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # parent node and are sent to 'team-X-mails'</span></span> |
| <span class="line"><span style="color:#E06C75;"> routes</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> severity</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">critical</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-X-pager</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> service</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">files</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-Y-mails</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;"> routes</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> severity</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">critical</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-Y-pager</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # This route handles all alerts coming from a database service. If there's</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # no team to handle it, it defaults to the DB team.</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> service</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">database</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-DB-pager</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Also group alerts by affected database.</span></span> |
| <span class="line"><span style="color:#E06C75;"> group_by</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">alertname</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">cluster</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">database</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;"> routes</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> owner</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-X</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-X-pager</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> owner</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-Y</span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">team-Y-pager</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># Inhibition rules allow to mute a set of alerts given that another alert is</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># firing.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># We use this to mute any warning-level notifications if the same alert is</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"># already critical.</span></span> |
| <span class="line"><span style="color:#E06C75;">inhibit_rules</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;">- </span><span style="color:#E06C75;">source_match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> severity</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'critical'</span></span> |
| <span class="line"><span style="color:#E06C75;"> target_match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> severity</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'warning'</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # Apply inhibition if the alertname is the same.</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # CAUTION: </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # If all label names listed in `equal` are missing </span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # from both the source and target alerts,</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;"> # the inhibition rule will apply!</span></span> |
| <span class="line"><span style="color:#E06C75;"> equal</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">'alertname'</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">receivers</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;">- </span><span style="color:#E06C75;">name</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-X-mails'</span></span> |
| <span class="line"><span style="color:#E06C75;"> email_configs</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">to</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-X+alerts@example.org, team-Y+alerts@example.org'</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">- </span><span style="color:#E06C75;">name</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-X-pager'</span></span> |
| <span class="line"><span style="color:#E06C75;"> email_configs</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">to</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-X+alerts-critical@example.org'</span></span> |
| <span class="line"><span style="color:#E06C75;"> pagerduty_configs</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">routing_key</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;"><team-X-key></span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">- </span><span style="color:#E06C75;">name</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-Y-mails'</span></span> |
| <span class="line"><span style="color:#E06C75;"> email_configs</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">to</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-Y+alerts@example.org'</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">- </span><span style="color:#E06C75;">name</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-Y-pager'</span></span> |
| <span class="line"><span style="color:#E06C75;"> pagerduty_configs</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">routing_key</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;"><team-Y-key></span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;">- </span><span style="color:#E06C75;">name</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'team-DB-pager'</span></span> |
| <span class="line"><span style="color:#E06C75;"> pagerduty_configs</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">routing_key</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;"><team-DB-key></span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>In the following example, we used the following configuration:</p><div class="language-yaml line-numbers-mode" data-highlighter="shiki" data-ext="yaml" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-yaml"><span class="line"><span style="color:#7F848E;font-style:italic;"># alertmanager.yml</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">global</span><span style="color:#ABB2BF;">: </span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_smarthost</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">''</span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_from</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">''</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_auth_username</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">''</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_auth_password</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">''</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#E06C75;"> smtp_require_tls</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">false</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">route</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> group_by</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">'alertname'</span><span style="color:#ABB2BF;">] </span></span> |
| <span class="line"><span style="color:#E06C75;"> group_wait</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">1m</span></span> |
| <span class="line"><span style="color:#E06C75;"> group_interval</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">10m</span></span> |
| <span class="line"><span style="color:#E06C75;"> repeat_interval</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">10h</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"><span style="color:#E06C75;"> receiver</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'email'</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">receivers</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">name</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'email'</span></span> |
| <span class="line"><span style="color:#E06C75;"> email_configs</span><span style="color:#ABB2BF;">: </span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">to</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">''</span><span style="color:#ABB2BF;"> </span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E06C75;">inhibit_rules</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> - </span><span style="color:#E06C75;">source_match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> severity</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'critical'</span></span> |
| <span class="line"><span style="color:#E06C75;"> target_match</span><span style="color:#ABB2BF;">:</span></span> |
| <span class="line"><span style="color:#E06C75;"> severity</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">'warning'</span></span> |
| <span class="line"><span style="color:#E06C75;"> equal</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">'alertname'</span><span style="color:#ABB2BF;">]</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="api" tabindex="-1"><a class="header-anchor" href="#api"><span>API</span></a></h3><p>The <code>AlertManager</code> API is divided into two versions, <code>v1</code> and <code>v2</code>. The current <code>AlertManager</code> API version is <code>v2</code><br> (For configuration see<br><a href="https://github.com/prometheus/alertmanager/blob/master/api/v2/openapi.yaml" target="_blank" rel="noopener noreferrer">api/v2/openapi.yaml</a>).</p><p>By default, the prefix is <code>/api/v1</code> or <code>/api/v2</code> and the endpoint for sending alerts is <code>/api/v1/alerts</code> or <code>/api/v2/alerts</code>.<br> If the user specifies <code>--web.route-prefix</code>,<br> for example <code>--web.route-prefix=/alertmanager/</code>,<br> then the prefix will become <code>/alertmanager/api/v1</code> or <code>/alertmanager/api/v2</code>,<br> and the endpoint that sends the alert becomes <code>/alertmanager/api/v1/alerts</code><br> or <code>/alertmanager/api/v2/alerts</code>.</p><h2 id="creating-trigger" tabindex="-1"><a class="header-anchor" href="#creating-trigger"><span>Creating trigger</span></a></h2><h3 id="writing-the-trigger-class" tabindex="-1"><a class="header-anchor" href="#writing-the-trigger-class"><span>Writing the trigger class</span></a></h3><p>The user defines a trigger by creating a Java class and writing the logic in the hook.<br> Please refer to <a class="route-link" href="/UserGuide/V0.13.x/Process-Data/Triggers.html">Triggers</a> for the specific configuration process and the usage method of <code>AlertManagerSink</code> related tools provided by the Sink module.</p><p>The following example creates the <code>org.apache.iotdb.trigger.AlertingExample</code> class,<br> Its alertManagerHandler member variables can send alerts to the AlertManager instance<br> at the address of <code>http://127.0.0.1:9093/</code>.</p><p>When <code>value> 100.0</code>, send an alert of <code>critical</code> severity;<br> when <code>50.0 <value <= 100.0</code>, send an alert of <code>warning</code> severity<br> .</p><div class="language-java line-numbers-mode" data-highlighter="shiki" data-ext="java" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-java"><span class="line"><span style="color:#C678DD;">package</span><span style="color:#C678DD;"> org.apache.iotdb.trigger</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">/*</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">package importing is omitted here</span></span> |
| <span class="line"><span style="color:#7F848E;font-style:italic;">*/</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;">public</span><span style="color:#C678DD;"> class</span><span style="color:#E5C07B;"> AlertingExample</span><span style="color:#C678DD;"> implements</span><span style="color:#E5C07B;"> Trigger</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> final</span><span style="color:#E5C07B;"> AlertManagerHandler</span><span style="color:#E06C75;"> alertManagerHandler </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> AlertManagerHandler</span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> final</span><span style="color:#E5C07B;"> AlertManagerConfiguration</span><span style="color:#E06C75;"> alertManagerConfiguration </span><span style="color:#56B6C2;">=</span></span> |
| <span class="line"><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> AlertManagerConfiguration</span><span style="color:#E06C75;">(</span><span style="color:#98C379;">"http://127.0.0.1:9093/api/v2/alerts"</span><span style="color:#E06C75;">)</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#E5C07B;"> String</span><span style="color:#E06C75;"> alertname</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> final</span><span style="color:#E5C07B;"> HashMap</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#ABB2BF;">></span><span style="color:#E06C75;"> labels </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> HashMap</span><span style="color:#ABB2BF;"><></span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> private</span><span style="color:#C678DD;"> final</span><span style="color:#E5C07B;"> HashMap</span><span style="color:#ABB2BF;"><</span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">,</span><span style="color:#E5C07B;"> String</span><span style="color:#ABB2BF;">></span><span style="color:#E06C75;"> annotations </span><span style="color:#56B6C2;">=</span><span style="color:#C678DD;"> new</span><span style="color:#E5C07B;"> HashMap</span><span style="color:#ABB2BF;"><></span><span style="color:#E06C75;">()</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> @</span><span style="color:#E5C07B;">Override</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> onCreate</span><span style="color:#ABB2BF;">(</span><span style="color:#E5C07B;">TriggerAttributes</span><span style="color:#E06C75;font-style:italic;"> attributes</span><span style="color:#ABB2BF;">)</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> Exception</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(alertManagerConfiguration);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> alertname </span><span style="color:#56B6C2;">=</span><span style="color:#98C379;"> "alert_test"</span><span style="color:#ABB2BF;">;</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"series"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.ln.wf01.wt01.temperature"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"value"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">""</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"severity"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">""</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#E5C07B;"> annotations</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"summary"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"high temperature"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> annotations</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"description"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"{{.alertname}}: {{.series}} is {{.value}}"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> @</span><span style="color:#E5C07B;">Override</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> onDrop</span><span style="color:#ABB2BF;">()</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> IOException</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> @</span><span style="color:#E5C07B;">Override</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> onStart</span><span style="color:#ABB2BF;">()</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">open</span><span style="color:#ABB2BF;">(alertManagerConfiguration);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> @</span><span style="color:#E5C07B;">Override</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> void</span><span style="color:#61AFEF;"> onStop</span><span style="color:#ABB2BF;">()</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> Exception</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">close</span><span style="color:#ABB2BF;">();</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> @</span><span style="color:#E5C07B;">Override</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#E5C07B;"> Double</span><span style="color:#61AFEF;"> fire</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">long</span><span style="color:#E06C75;font-style:italic;"> timestamp</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">Double</span><span style="color:#E06C75;font-style:italic;"> value</span><span style="color:#ABB2BF;">)</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> Exception</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (value </span><span style="color:#56B6C2;">></span><span style="color:#D19A66;"> 100.0</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"value"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">valueOf</span><span style="color:#ABB2BF;">(value));</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"severity"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"critical"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> AlertManagerEvent</span><span style="color:#E06C75;"> alertManagerEvent</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> AlertManagerEvent</span><span style="color:#ABB2BF;">(alertname, labels, annotations);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">onEvent</span><span style="color:#ABB2BF;">(alertManagerEvent);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> } </span><span style="color:#C678DD;">else</span><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (value </span><span style="color:#56B6C2;">></span><span style="color:#D19A66;"> 50.0</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"value"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">valueOf</span><span style="color:#ABB2BF;">(value));</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"severity"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"warning"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> AlertManagerEvent</span><span style="color:#E06C75;"> alertManagerEvent</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> AlertManagerEvent</span><span style="color:#ABB2BF;">(alertname, labels, annotations);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">onEvent</span><span style="color:#ABB2BF;">(alertManagerEvent);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#C678DD;"> return</span><span style="color:#ABB2BF;"> value;</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"></span> |
| <span class="line"><span style="color:#ABB2BF;"> @</span><span style="color:#E5C07B;">Override</span></span> |
| <span class="line"><span style="color:#C678DD;"> public</span><span style="color:#C678DD;"> double</span><span style="color:#61AFEF;">[] fire</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">long</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">timestamps</span><span style="color:#ABB2BF;">, </span><span style="color:#C678DD;">double</span><span style="color:#ABB2BF;">[] </span><span style="color:#E06C75;font-style:italic;">values</span><span style="color:#ABB2BF;">)</span><span style="color:#C678DD;"> throws</span><span style="color:#E5C07B;"> Exception</span><span style="color:#ABB2BF;"> {</span></span> |
| <span class="line"><span style="color:#C678DD;"> for</span><span style="color:#ABB2BF;"> (</span><span style="color:#C678DD;">double</span><span style="color:#E06C75;"> value</span><span style="color:#C678DD;"> :</span><span style="color:#ABB2BF;"> values) {</span></span> |
| <span class="line"><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (value </span><span style="color:#56B6C2;">></span><span style="color:#D19A66;"> 100.0</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"value"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">valueOf</span><span style="color:#ABB2BF;">(value));</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"severity"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"critical"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> AlertManagerEvent</span><span style="color:#E06C75;"> alertManagerEvent</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> AlertManagerEvent</span><span style="color:#ABB2BF;">(alertname, labels, annotations);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">onEvent</span><span style="color:#ABB2BF;">(alertManagerEvent);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> } </span><span style="color:#C678DD;">else</span><span style="color:#C678DD;"> if</span><span style="color:#ABB2BF;"> (value </span><span style="color:#56B6C2;">></span><span style="color:#D19A66;"> 50.0</span><span style="color:#ABB2BF;">) {</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"value"</span><span style="color:#ABB2BF;">, </span><span style="color:#E5C07B;">String</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">valueOf</span><span style="color:#ABB2BF;">(value));</span></span> |
| <span class="line"><span style="color:#E5C07B;"> labels</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">put</span><span style="color:#ABB2BF;">(</span><span style="color:#98C379;">"severity"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"warning"</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> AlertManagerEvent</span><span style="color:#E06C75;"> alertManagerEvent</span><span style="color:#56B6C2;"> =</span><span style="color:#C678DD;"> new</span><span style="color:#61AFEF;"> AlertManagerEvent</span><span style="color:#ABB2BF;">(alertname, labels, annotations);</span></span> |
| <span class="line"><span style="color:#E5C07B;"> alertManagerHandler</span><span style="color:#ABB2BF;">.</span><span style="color:#61AFEF;">onEvent</span><span style="color:#ABB2BF;">(alertManagerEvent);</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#C678DD;"> return</span><span style="color:#ABB2BF;"> values;</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> }</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="creating-trigger-1" tabindex="-1"><a class="header-anchor" href="#creating-trigger-1"><span>Creating trigger</span></a></h3><p>The following SQL statement registered the trigger<br> named <code>root-ln-wf01-wt01-alert</code><br> on the <code>root.ln.wf01.wt01.temperature</code> time series,<br> whose operation logic is defined<br> by <code>org.apache.iotdb.trigger.AlertingExample</code> java class.</p><div class="language-sql line-numbers-mode" data-highlighter="shiki" data-ext="sql" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-sql"><span class="line"><span style="color:#C678DD;"> CREATE</span><span style="color:#ABB2BF;"> TRIGGER </span><span style="color:#98C379;">`root-ln-wf01-wt01-alert`</span></span> |
| <span class="line"><span style="color:#C678DD;"> AFTER</span><span style="color:#C678DD;"> INSERT</span></span> |
| <span class="line"><span style="color:#C678DD;"> ON</span><span style="color:#D19A66;"> root</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">ln</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wf01</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wt01</span><span style="color:#ABB2BF;">.temperature</span></span> |
| <span class="line"><span style="color:#C678DD;"> AS</span><span style="color:#98C379;"> "org.apache.iotdb.trigger.AlertingExample"</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="writing-data" tabindex="-1"><a class="header-anchor" href="#writing-data"><span>Writing data</span></a></h2><p>When we finish the deployment and startup of AlertManager as well as the creation of Trigger,<br> we can test the alerting<br> by writing data to the time series.</p><div class="language-sql line-numbers-mode" data-highlighter="shiki" data-ext="sql" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code class="language-sql"><span class="line"><span style="color:#C678DD;">INSERT INTO</span><span style="color:#D19A66;"> root</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">ln</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wf01</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wt01</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">timestamp</span><span style="color:#ABB2BF;">, temperature) </span><span style="color:#C678DD;">VALUES</span><span style="color:#ABB2BF;"> (</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;">INSERT INTO</span><span style="color:#D19A66;"> root</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">ln</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wf01</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wt01</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">timestamp</span><span style="color:#ABB2BF;">, temperature) </span><span style="color:#C678DD;">VALUES</span><span style="color:#ABB2BF;"> (</span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">30</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;">INSERT INTO</span><span style="color:#D19A66;"> root</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">ln</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wf01</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wt01</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">timestamp</span><span style="color:#ABB2BF;">, temperature) </span><span style="color:#C678DD;">VALUES</span><span style="color:#ABB2BF;"> (</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">60</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;">INSERT INTO</span><span style="color:#D19A66;"> root</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">ln</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wf01</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wt01</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">timestamp</span><span style="color:#ABB2BF;">, temperature) </span><span style="color:#C678DD;">VALUES</span><span style="color:#ABB2BF;"> (</span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">90</span><span style="color:#ABB2BF;">);</span></span> |
| <span class="line"><span style="color:#C678DD;">INSERT INTO</span><span style="color:#D19A66;"> root</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">ln</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wf01</span><span style="color:#ABB2BF;">.</span><span style="color:#D19A66;">wt01</span><span style="color:#ABB2BF;">(</span><span style="color:#C678DD;">timestamp</span><span style="color:#ABB2BF;">, temperature) </span><span style="color:#C678DD;">VALUES</span><span style="color:#ABB2BF;"> (</span><span style="color:#D19A66;">5</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">120</span><span style="color:#ABB2BF;">);</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>After executing the above writing statements,<br> we can receive an alerting email. Because our <code>AlertManager</code> configuration above<br> makes alerts of <code>critical</code> severity inhibit those of <code>warning</code> severity,<br> the alerting email we receive only contains the alert triggered<br> by the writing of <code>(5, 120)</code>.</p><img width="669" alt="alerting" src="/img/github/115957896-a9791080-a537-11eb-9962-541412bdcee6.png"></div><!----><!----><!----></div><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/V0.13.x/Process-Data/Alerting.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last Updated: </span><time class="vp-meta-info" datetime="2025-02-14T07:03:32.000Z" data-allow-mismatch>2/14/25, 7:03 AM</time></div><!----></div></footer><nav class="vp-page-nav"><a class="route-link auto-link prev" href="/UserGuide/V0.13.x/Process-Data/Triggers.html" aria-label="Triggers"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link"><!---->Triggers</div></a><!----></nav><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">V0.13.x</span><p class="copyright-text">Copyright © 2026 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-C72F_R_b.js" defer></script> |
| </body> |
| </html> |
