| <!doctype html> |
| <html lang="zh" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-deployment/04Exporter" data-has-hydrated="false"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v2.4.3"> |
| <title data-rh="true">RocketMQ Promethus Exporter | RocketMQ</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://your-docusaurus-test-site.com/zh/docs/4.x/deployment/04Exporter"><meta data-rh="true" name="docusaurus_locale" content="zh"><meta data-rh="true" name="docsearch:language" content="zh"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="RocketMQ Promethus Exporter | RocketMQ"><meta data-rh="true" name="description" content="介绍"><meta data-rh="true" property="og:description" content="介绍"><link data-rh="true" rel="icon" href="/zh/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://your-docusaurus-test-site.com/zh/docs/4.x/deployment/04Exporter"><link data-rh="true" rel="alternate" href="https://your-docusaurus-test-site.com/zh/docs/4.x/deployment/04Exporter" hreflang="zh"><link data-rh="true" rel="alternate" href="https://your-docusaurus-test-site.com/docs/4.x/deployment/04Exporter" hreflang="en"><link data-rh="true" rel="alternate" href="https://your-docusaurus-test-site.com/docs/4.x/deployment/04Exporter" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://R2IYF7ETH7-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/zh/blog/rss.xml" title="RocketMQ RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh/blog/atom.xml" title="RocketMQ Atom Feed"> |
| |
| |
| |
| <link rel="search" type="application/opensearchdescription+xml" title="RocketMQ" href="/zh/opensearch.xml"> |
| <script>var _hmt=_hmt||[];!function(){var e=document.createElement("script");e.src="https://hm.baidu.com/hm.js?36428f2b841d08e7405724cbf7f860d2";var t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)}()</script> |
| <link rel="preconnect" href="https://www.google-analytics.com"> |
| <script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-89603173-1","auto"),ga("set","anonymizeIp",!0),ga("send","pageview")</script> |
| <script async src="https://www.google-analytics.com/analytics.js"></script> |
| <link rel="alternate" type="application/rss+xml" href="/zh/events/rss.xml" title="RocketMQ RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh/events/atom.xml" title="RocketMQ Atom Feed"> |
| <link rel="alternate" type="application/rss+xml" href="/zh/release-notes/rss.xml" title="RocketMQ RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh/release-notes/atom.xml" title="RocketMQ Atom Feed"> |
| <link rel="alternate" type="application/rss+xml" href="/zh/news/rss.xml" title="RocketMQ RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh/news/atom.xml" title="RocketMQ Atom Feed"> |
| |
| <link rel="stylesheet" href="//g.alicdn.com/mamba/assets/0.0.13/mse-arc-ui.min.css"> |
| <script src="//g.alicdn.com/mamba/assets/0.0.13/mse-arc-ui.min.js"></script><link rel="stylesheet" href="/zh/assets/css/styles.d2e5c25b.css"> |
| <link rel="preload" href="/zh/assets/js/runtime~main.b17b65ca.js" as="script"> |
| <link rel="preload" href="/zh/assets/js/main.46e74ac2.js" as="script"> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <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="跳到主要内容"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">跳到主要内容</a></div><nav aria-label="主导航" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="切换导航栏" 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="/zh/"><div class="navbar__logo"><img src="/zh/img/Apache_RocketMQ_logo.svg.png" alt="My Site Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/zh/img/Apache_RocketMQ_logo.svg.png" alt="My Site Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache RocketMQ</b></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/apache/rocketmq" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>简体中文</a><ul class="dropdown__menu"><li><a href="/zh/docs/4.x/deployment/04Exporter" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="zh">简体中文</a></li><li><a href="/docs/4.x/deployment/04Exporter" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="en">English</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">文档</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/zh/docs/">5.0</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/zh/docs/4.x/">4.x</a></li></ul></div><a class="navbar__item navbar__link" href="/zh/download">下载</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">博客</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/zh/blog">用户案例</a></li><li><a class="dropdown__link" href="/zh/events">社区活动</a></li><li><a class="dropdown__link" href="/zh/release-notes">版本变化</a></li><li><a class="dropdown__link" href="/zh/news">RocketMQ新闻</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">社区</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/zh/contact">参与社区</a></li><li><a class="dropdown__link" href="/zh/origin">项目起源</a></li><li><a class="dropdown__link" href="/zh/team">贡献团队</a></li><li><a class="dropdown__link" href="/zh/docs/contributionGuide/01how-to-contribute">贡献说明</a></li><li><a class="dropdown__link" href="/zh/enterprise">企业用户</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="切换浅色/暗黑模式（当前为浅色模式）" aria-label="切换浅色/暗黑模式（当前为浅色模式）" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="搜索"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><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">搜索</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="回到顶部" 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="文档侧边栏" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/">基本概念</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/producer/01concept1">生产者</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/consumer/01concept2">消费者</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/zh/docs/4.x/deployment/01deploy">部署 & 运维</a></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-2 menu__list-item"><a class="menu__link" tabindex="0" href="/zh/docs/4.x/deployment/01deploy">部署方式</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="/zh/docs/4.x/deployment/02admintool">Admin Tool</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="/zh/docs/4.x/deployment/03Dashboard">RocketMQ Dashboard</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/zh/docs/4.x/deployment/04Exporter">RocketMQ Promethus Exporter</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/bestPractice/01bestpractice">最佳实践</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/parameterConfiguration/01local">参数配置</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/eventbridge/01RocketMQEventBridgeConcepts">RocketMQ EventBridge</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/mqtt/01RocketMQMQTTOverview">RocketMQ MQTT</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/streams/01RocketMQ Streams Overview">RocketMQ Streams</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/connect/01RocketMQ Connect Overview">RocketMQ Connect</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/zh/docs/4.x/contributionGuide/01how-to-contribute">贡献指南</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="页面路径"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="主页面" class="breadcrumbs__link" href="/zh/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">部署 & 运维</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">RocketMQ Promethus Exporter</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">版本：4.x</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">本页总览</button></div><div class="theme-doc-markdown markdown"><h1>RocketMQ Promethus Exporter</h1><h2 class="anchor anchorWithStickyNavbar_LWe7" id="介绍">介绍<a href="#介绍" class="hash-link" aria-label="介绍的直接链接" title="介绍的直接链接"></a></h2><p><code>Rocketmq-exporter</code> 是用于监控 RocketMQ broker 端和客户端所有相关指标的系统，通过 <code>mqAdmin</code> 从 broker 端获取指标值后封装成 87 个 cache。</p><div class="theme-admonition theme-admonition-caution alert alert--warning admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"></path></svg></span>警告</div><div class="admonitionContent_S0QG"><p>过去版本曾是 87 个 concurrentHashMap，由于 Map 不会删除过期指标，所以一旦有 label 变动就会生成一个新的指标，旧的无用指标无法自动删除，久而久之造成内存溢出。而使用 Cache 结构可可以实现过期删除，且过期时间可配置。</p></div></div><p><code>Rocketmq-expoter</code> 获取监控指标的流程如下图所示，Expoter 通过 MQAdminExt 向 MQ 集群请求数据，请求到的数据通过 MetricService 规范化成 Prometheus 需要的格式，然后通过 /metics 接口暴露给 Promethus。 |
| <img loading="lazy" alt="165754739545" src="/zh/assets/images/RocketMQ Prometheus Exporter-1-569c982f31d232cb9ddcafaf2aaf5ee7.jpeg" width="1798" height="1080" class="img_ev3q"></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="metric-结构">Metric 结构<a href="#metric-结构" class="hash-link" aria-label="Metric 结构的直接链接" title="Metric 结构的直接链接"></a></h3><p><code>Metric</code> 类位于 <code>org.apache.rocketmq.expoter.model.metrics</code> 包下，实质上是一些实体类，每个实体类代表一类指标, 总共 14 个 Metric 类。这些类作为 87 个 Cache 的 key， 用不同的 label 值进行区分。</p><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>实体类中包含了 label 的三个维度：broker、consumer、producer</div><div class="admonitionContent_S0QG"><ul><li><p><strong>broker 相关 metric 类有</strong>: BrokerRuntimeMetric、BrokerMetric、DLQTopicOffsetMetric、TopicPutNumMetric</p></li><li><p><strong>消费者相关类有</strong>: ConsumerRuntimeConsumeFailedMsgsMetric 、ConsumerRuntimeConsumeFailedTPSMetric 、ConsumerRuntimeConsumeOKTPSMetric、ConsumerRuntimeConsumeRTMetric、ConsumerRuntimePullRTMetric、ConsumerRuntimePullTPSMetric、ConsumerCountMetric、ConsumerMetric、ConsumerTopicDiffMetric</p></li><li><p><strong>生产者相关 metric 类有</strong>: ProducerMetric </p></li></ul></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="prometheus-拉取-metrics-的过程">Prometheus 拉取 metrics 的过程<a href="#prometheus-拉取-metrics-的过程" class="hash-link" aria-label="Prometheus 拉取 metrics 的过程的直接链接" title="Prometheus 拉取 metrics 的过程的直接链接"></a></h3><p><code>RocketMQ-exporter</code> 项目和 <code>Prometheus</code> 相当于服务器和客户端的关系，RocketMQ-exporter 项目引入了 Prometheus 的 client 包，该包中规定了需要获取的信息的类型即项目中的 MetricFamilySamples 类，Prometheus 向 expoter 请求 metrics，expoter 将信息封装成相应的类型之后返回给 Prometheus。</p><p>rocketmq-expoter 项目启动后，会获取 rocketmq 的各项 metrics 收集到 mfs 对象中，当浏览器或 Prometheus 访问相应的接口时，会通过 service 将 mfs 对象中的 samples 生成 Prometheus 所支持的格式化数据。主要包含以下步骤：</p><p>浏览器通过访问 ip:5557/metrics，会调用 RMQMetricsController 类下的 metrics 方法，其中 ip 为 rocketmq-expoter 项目运行的主机 ip</p><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">private void metrics(HttpServletResponse response) throws IOException {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> StringWriter writer = new StringWriter();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> metricsService.metrics(writer);</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> response.setHeader("Content-Type", "text/plain; version=0.0.4; charset=utf-8");</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> response.getOutputStream().print(writer.toString());</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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>通过新建 StringWriter 对象用于收集 metrics 指标，调用 MetricsService 类中的方法 metrics 将 expoter 中提取到的指标收集到 writer 对象中，最后将收集到的指标输出到网页上。</p><p>收集到的指标格式为:</p><div class="language-javascript codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-javascript codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token operator" style="color:#393A34"><</span><span class="token plain">metric name</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">{</span><span class="token operator" style="color:#393A34"><</span><span class="token plain">label name</span><span class="token operator" style="color:#393A34">>=</span><span class="token operator" style="color:#393A34"><</span><span class="token plain">label value</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token spread operator" style="color:#393A34">...</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34"><</span><span class="token plain">metric value</span><span class="token operator" style="color:#393A34">></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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>如：</p><div class="language-javascript codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-javascript codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">rocketmq_group_diff</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">group</span><span class="token operator" style="color:#393A34">=</span><span class="token string" style="color:#e3116c">"rmq_group_test_20220114"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">topic</span><span class="token operator" style="color:#393A34">=</span><span class="token string" style="color:#e3116c">"fusion_console_tst"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">countOfOnlineConsumers</span><span class="token operator" style="color:#393A34">=</span><span class="token string" style="color:#e3116c">"0"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">msgModel</span><span class="token operator" style="color:#393A34">=</span><span class="token string" style="color:#e3116c">"1"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">23.0</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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="metriccollecttask-类中的-5-个定时任务">MetricCollectTask 类中的 5 个定时任务<a href="#metriccollecttask-类中的-5-个定时任务" class="hash-link" aria-label="MetricCollectTask 类中的 5 个定时任务的直接链接" title="MetricCollectTask 类中的 5 个定时任务的直接链接"></a></h3><p>MetricCollectTask 类中有 5 个定时任务，分别为 collectTopicOffset、collectConsumerOffset、collectBrokerStatsTopic、collectBrokerStats 和 collectBrokerRuntimeStats。用于收集消费位点信息以及 Broker 状态信息等。其 cron 表达式为：cron: 15 0/1 <!-- -->*<!-- --> <!-- -->*<!-- --> <!-- -->*<!-- --> ?，表示每分钟会收集一次。其核心功能是通过 mqAdminExt 对象从集群中获取 broker 中的信息，然后将其添加到对应的 87 个监控指标中，以 collectTopicOffset 为例：</p><ol><li>首先初始化TopicList对象，通过mqAdminExt.fetchAllTopicList()方法获取到集群的所有topic信息。</li></ol><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> ```java</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> TopicList topicList = null;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> try { topicList = mqAdminExt.fetchAllTopicList();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">} catch (Exception ex) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> log.error(String.format("collectTopicOffset-exception comes getting topic list from namesrv, address is %s",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> JSON.toJSONString(mqAdminExt.getNameServerAddressList())));</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> return;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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><ol start="2"><li>将 topic 加入到 topicSet 中，循环遍历每一个 topic，通过 mqAdminExt.examineTopicStats(topic)函数来检查 topic 状态。</li></ol><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> Set < String > topicSet = topicList != null ? topicList.getTopicList() : null;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> for (String topic: topicSet) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> TopicStatsTable topicStats = null;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> try {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> topicStats = mqAdminExt.examineTopicStats(topic);</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> } catch (Exception ex) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> log.error(String.format("collectTopicOffset-getting topic(%s) stats error. the namesrv address is %s",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> topic,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> JSON.toJSONString(mqAdminExt.getNameServerAddressList())));</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> continue;}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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><ol start="3"><li>初始化 topic 状态 set，用于用于按 broker 划分的 topic 信息位点的 hash 表 brokerOffsetMap，以及一个用于按 broker 名字为 key 的用于存储更新时间戳的 hash 表 brokerUpdateTimestampMap。</li></ol><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> Set<Map.Entry<MessageQueue, TopicOffset>> topicStatusEntries = topicStats.getOffsetTable().entrySet();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> HashMap<String, Long> brokerOffsetMap = new HashMap<>();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> HashMap<String, Long> brokerUpdateTimestampMap = new HashMap<>();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> for (Map.Entry<MessageQueue, TopicOffset> topicStatusEntry : topicStatusEntries) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> MessageQueue q = topicStatusEntry.getKey();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> TopicOffset offset = topicStatusEntry.getValue();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> if (brokerOffsetMap.containsKey(q.getBrokerName())) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> brokerOffsetMap.put(q.getBrokerName(), brokerOffsetMap.get(q.getBrokerName()) + offset.getMaxOffset());</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> } else {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> brokerOffsetMap.put(q.getBrokerName(), offset.getMaxOffset());</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> if (brokerUpdateTimestampMap.containsKey(q.getBrokerName())) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> if (offset.getLastUpdateTimestamp() > brokerUpdateTimestampMap.get(q.getBrokerName())) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> brokerUpdateTimestampMap.put(q.getBrokerName(), offset.getLastUpdateTimestamp());</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> } else {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> brokerUpdateTimestampMap.put(q.getBrokerName(),</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> offset.getLastUpdateTimestamp());</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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><ol start="4"><li>最后通过遍历 brokerOffsetMap 中的每一项，通过调用 metricsService 获取到 metricCollector 对象，调用 RMQMetricsCollector 类中的 addTopicOffsetMetric 方法，将相应的值添加到 RMQMetricsCollector 类中 87 个指标对应的其中一个指标的 cache 中。</li></ol><div class="language-java codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-java codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> Set<Map.Entry<String, Long>> brokerOffsetEntries = brokerOffsetMap.entrySet();</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> for (Map.Entry<String, Long> brokerOffsetEntry : brokerOffsetEntries) {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> metricsService.getCollector().addTopicOffsetMetric(clusterName, brokerOffsetEntry.getKey(), topic,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> brokerUpdateTimestampMap.get(brokerOffsetEntry.getKey()), brokerOffsetEntry.getValue());</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> log.info("topic offset collection task finished...." + (System.currentTimeMillis() - start));</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="复制代码到剪贴板" title="复制" 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="rocketmq-exporter-收集指标流程图">Rocketmq-exporter 收集指标流程图<a href="#rocketmq-exporter-收集指标流程图" class="hash-link" aria-label="Rocketmq-exporter 收集指标流程图的直接链接" title="Rocketmq-exporter 收集指标流程图的直接链接"></a></h3><p><img loading="lazy" alt="dafcvznvkldaf" src="/zh/assets/images/RocketMQ Prometheus Exporter - 2-fdd37b4d6c89244c23bac2bf87ff7e26.jpeg" width="899" height="425" class="img_ev3q"></p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="快速开始">快速开始<a href="#快速开始" class="hash-link" aria-label="快速开始的直接链接" title="快速开始的直接链接"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="配置-applicationyml">配置 <code>application.yml</code><a href="#配置-applicationyml" class="hash-link" aria-label="配置-applicationyml的直接链接" title="配置-applicationyml的直接链接"></a></h3><p><code>application.yml</code> 中重要的配置主要有:</p><ul><li><p>server.port 设置 promethus 监听 rocketmq-exporter 的端口, 默认为 5557</p></li><li><p>rocketmq.config.webTelemetryPath 配置 promethus 获取指标的路径,默认为 /metrics ，使用默认值即可.</p></li><li><p>rocketmq.config.enableACL 如果 RocketMQ 集群开启了 ACL 验证,需要配置为 true, 并在 accessKey 和 secretKey 中配置相应的 ak, sk.</p></li><li><p>rocketmq.config.outOfTimeSeconds 用于配置存储指标和相应的值的过期时间,若超过该时间,cache 中的 key 对应的节点没有发生写更改,则会进行删除.一般配置为 60s 即可(根据 promethus 获取指标的时间间隔进行合理配置,只要保证过期时间大于等于 promethus 收集指标的时间间隔即可)</p></li><li><p>task.<em>.cron 配置 exporter 从 broker 拉取指标的定时任务的时间间隔,默认值为"15 0/1 </em> <!-- -->*<!-- --> <!-- -->*<!-- --> ?" 每分钟的 15s 拉取一次指标.</p></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="启动-exporter-项目">启动 exporter 项目<a href="#启动-exporter-项目" class="hash-link" aria-label="启动 exporter 项目的直接链接" title="启动 exporter 项目的直接链接"></a></h3><h3 class="anchor anchorWithStickyNavbar_LWe7" id="按照-promethus-官网配置启动">按照 promethus 官网配置启动<a href="#按照-promethus-官网配置启动" class="hash-link" aria-label="按照 promethus 官网配置启动的直接链接" title="按照 promethus 官网配置启动的直接链接"></a></h3><p>配置 promethus 的 static_config: -targets 为 exporter 的启动 IP 和端口,如: localhost:5557</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="访问-promethus-页面">访问 promethus 页面<a href="#访问-promethus-页面" class="hash-link" aria-label="访问 promethus 页面的直接链接" title="访问 promethus 页面的直接链接"></a></h3><p>本地启动默认为: localhost:9090 ,则可对收集到的指标值进行查看,如下图所示:</p><p><img loading="lazy" alt="3298559603" src="/zh/assets/images/RocketMQ Prometheus Exporter-3-f5d7bc508a5e4f791de91d2835b261b7.jpeg" width="1510" height="431" class="img_ev3q"></p><div class="theme-admonition theme-admonition-tip alert alert--success admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>提示</div><div class="admonitionContent_S0QG"><p>为了达到更好的可视化效果,观察指标值变化趋势, promethus 搭配 grafana 效果更佳哦!</p></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="可观测性指标">可观测性指标<a href="#可观测性指标" class="hash-link" aria-label="可观测性指标的直接链接" title="可观测性指标的直接链接"></a></h2><p>可观测性指标主要包括两个大类: 服务端指标和客户端指标, 服务端指标由服务端直接生成, 客户端指标在客户端产生, 由服务端通过 rpc 请求客户端获取到. 客户端指标又可细分为生产端指标和消费端指标.所有 87 个可观测性指标及其主要含义如下:</p><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>服务端指标</summary><div><div class="collapsibleContent_i85q"><h3 class="anchor anchorWithStickyNavbar_LWe7" id="服务端指标">服务端指标<a href="#服务端指标" class="hash-link" aria-label="服务端指标的直接链接" title="服务端指标的直接链接"></a></h3><table><thead><tr><th>指标名称</th><th>含义</th><th>对应Broker指标名</th></tr></thead><tbody><tr><td>rocketmq_broker_tps</td><td>Broker级别的生产TPS</td><td></td></tr><tr><td>rocketmq_broker_qps</td><td>Broker级别的消费QPS</td><td></td></tr><tr><td>rocketmq_broker_commitlog_diff</td><td>Broker组从节点同步落后消息size</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_0ms</td><td>服务端开始处理写请求到完成写入的耗时（0ms）</td><td>putMessageDistributeTime</td></tr><tr><td>rocketmq_brokeruntime_pmdt_0to10ms</td><td>服务端开始处理写请求到完成写入的耗时（0~10ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_10to50ms</td><td>服务端开始处理写请求到完成写入的耗时（10~50ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_50to100ms</td><td>服务端开始处理写请求到完成写入的耗时（50~100ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_100to200ms</td><td>服务端开始处理写请求到完成写入的耗时（100~200ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_200to500ms</td><td>服务端开始处理写请求到完成写入的耗时（200~500ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_500to1s</td><td>服务端开始处理写请求到完成写入的耗时（500~1000ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_1to2s</td><td>服务端开始处理写请求到完成写入的耗时（1~2s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_2to3s</td><td>服务端开始处理写请求到完成写入的耗时（2~3s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_3to4s</td><td>服务端开始处理写请求到完成写入的耗时（3~4s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_4to5s</td><td>服务端开始处理写请求到完成写入的耗时（4~5s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_5to10s</td><td>服务端开始处理写请求到完成写入的耗时（5~10s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_10stomore</td><td>服务端开始处理写请求到完成写入的耗时（> 10s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_dispatch_behind_bytes</td><td>到现在为止，未被分发（构建索引之类的操作）的消息bytes</td><td>dispatchBehindBytes</td></tr><tr><td>rocketmq_brokeruntime_put_message_size_total</td><td>broker写入消息size的总和</td><td>putMessageSizeTotal</td></tr><tr><td>rocketmq_brokeruntime_put_message_average_size</td><td>broker写入消息的平均大小</td><td>putMessageAverageSize</td></tr><tr><td>rocketmq_brokeruntime_remain_transientstore_buffer_numbs</td><td>TransientStorePool 中队列的容量</td><td>remainTransientStoreBufferNumbs</td></tr><tr><td>rocketmq_brokeruntime_earliest_message_timestamp</td><td>broker存储的消息最早的时间戳</td><td>earliestMessageTimeStamp</td></tr><tr><td>rocketmq_brokeruntime_putmessage_entire_time_max</td><td>broker自运行以来，写入消息耗时的最大值</td><td>putMessageEntireTimeMax</td></tr><tr><td>rocketmq_brokeruntime_start_accept_sendrequest_time</td><td>开始接受发送请求的时间</td><td>startAcceptSendRequestTimeStamp</td></tr><tr><td>rocketmq_brokeruntime_putmessage_times_total</td><td>broker写入消息的总次数</td><td>putMessageTimesTotal</td></tr><tr><td>rocketmq_brokeruntime_getmessage_entire_time_max</td><td>broker自启动以来，处理消息拉取的最大耗时</td><td>getMessageEntireTimeMax</td></tr><tr><td>rocketmq_brokeruntime_pagecache_lock_time_mills</td><td></td><td>pageCacheLockTimeMills</td></tr><tr><td>rocketmq_brokeruntime_commitlog_disk_ratio</td><td>commitLog所在磁盘的使用比例</td><td>commitLogDiskRatio</td></tr><tr><td>rocketmq_brokeruntime_dispatch_maxbuffer</td><td>broker没有计算，一直为0</td><td>dispatchMaxBuffer</td></tr><tr><td>rocketmq_brokeruntime_pull_threadpoolqueue_capacity</td><td>处理拉取请求线程池队列的容量</td><td>pullThreadPoolQueueCapacity</td></tr><tr><td>rocketmq_brokeruntime_send_threadpoolqueue_capacity</td><td>处理发送请求线程池队列的容量</td><td>sendThreadPoolQueueCapacity</td></tr><tr><td>rocketmq_brokeruntime_query_threadpool_queue_capacity</td><td>处理查询请求线程池队列的容量</td><td>queryThreadPoolQueueCapacity</td></tr><tr><td>rocketmq_brokeruntime_pull_threadpoolqueue_size</td><td>处理拉取请求线程池队列的实际size</td><td>pullThreadPoolQueueSize</td></tr><tr><td>rocketmq_brokeruntime_query_threadpoolqueue_size</td><td>处理查询请求线程池队列的实际size</td><td>queryThreadPoolQueueSize</td></tr><tr><td>rocketmq_brokeruntime_send_threadpool_queue_size</td><td>处理send请求线程池队列的实际size</td><td>sendThreadPoolQueueSize</td></tr><tr><td>rocketmq_brokeruntime_pull_threadpoolqueue_headwait_timemills</td><td>处理拉取请求线程池队列的队头任务等待时间</td><td>pullThreadPoolQueueHeadWaitTimeMills</td></tr><tr><td>rocketmq_brokeruntime_query_threadpoolqueue_headwait_timemills</td><td>处理查询请求线程池队列的队头任务等待时间</td><td>queryThreadPoolQueueHeadWaitTimeMills</td></tr><tr><td>rocketmq_brokeruntime_send_threadpoolqueue_headwait_timemills</td><td>处理发送请求线程池队列的队头任务等待时间</td><td>sendThreadPoolQueueHeadWaitTimeMills</td></tr><tr><td>rocketmq_brokeruntime_msg_gettotal_yesterdaymorning</td><td>到昨晚12点为止，读取消息的总次数</td><td>msgGetTotalYesterdayMorning</td></tr><tr><td>rocketmq_brokeruntime_msg_puttotal_yesterdaymorning</td><td>到昨晚12点为止，写入消息的总次数</td><td>msgPutTotalYesterdayMorning</td></tr><tr><td>rocketmq_brokeruntime_msg_gettotal_todaymorning</td><td>到今晚12点为止，读取消息的总次数</td><td>msgGetTotalTodayMorning</td></tr><tr><td>rocketmq_brokeruntime_msg_puttotal_todaymorning</td><td>到昨晚12点为止，写入消息的总次数</td><td>putMessageTimesTotal</td></tr><tr><td>rocketmq_brokeruntime_msg_put_total_today_now</td><td>每个broker到现在为止，写入的消息次数</td><td>msgPutTotalTodayNow</td></tr><tr><td>rocketmq_brokeruntime_msg_gettotal_today_now</td><td>每个broker到现在为止，读取的消息次数</td><td>msgGetTotalTodayNow</td></tr><tr><td>rocketmq_brokeruntime_commitlogdir_capacity_free</td><td>commitLog所在目录的可用空间</td><td>commitLogDirCapacity</td></tr><tr><td>rocketmq_brokeruntime_commitlogdir_capacity_total</td><td>commitLog所在目录的总空间</td><td></td></tr><tr><td>rocketmq_brokeruntime_commitlog_maxoffset</td><td>commitLog的最大offset</td><td>commitLogMaxOffset</td></tr><tr><td>rocketmq_brokeruntime_commitlog_minoffset</td><td>commitLog的最小offset</td><td>commitLogMinOffset</td></tr><tr><td>rocketmq_brokeruntime_remain_howmanydata_toflush</td><td></td><td>remainHowManyDataToFlush</td></tr><tr><td>rocketmq_brokeruntime_getfound_tps600</td><td>600s内getMessage时get到消息的平均TPS</td><td>getFoundTps</td></tr><tr><td>rocketmq_brokeruntime_getfound_tps60</td><td>60s内getMessage时get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_getfound_tps10</td><td>10s内getMessage时get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_gettotal_tps600</td><td>600s内getMessage次数的平均TPS</td><td>getTotalTps</td></tr><tr><td>rocketmq_brokeruntime_gettotal_tps60</td><td>60s内getMessage次数的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_gettotal_tps10</td><td>10s内getMessage次数的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_gettransfered_tps600</td><td></td><td>getTransferedTps</td></tr><tr><td>rocketmq_brokeruntime_gettransfered_tps60</td><td></td><td></td></tr><tr><td>rocketmq_brokeruntime_gettransfered_tps10</td><td></td><td></td></tr><tr><td>rocketmq_brokeruntime_getmiss_tps600</td><td>600s内getMessage时没有get到消息的平均TPS</td><td>getMissTps</td></tr><tr><td>rocketmq_brokeruntime_getmiss_tps60</td><td>60s内getMessage时没有get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_getmiss_tps10</td><td>10s内getMessage时没有get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_put_tps600</td><td>600s内写入消息次数的平均TPS</td><td>putTps</td></tr><tr><td>rocketmq_brokeruntime_put_tps60</td><td>60s内写入消息次数的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_put_tps10</td><td>10s内写入消息次数的平均TPS</td><td></td></tr></tbody></table><table><thead><tr><th>指标名称</th><th>含义</th><th>对应Broker指标名</th></tr></thead><tbody><tr><td>rocketmq_broker_tps</td><td>Broker级别的生产TPS</td><td></td></tr><tr><td>rocketmq_broker_qps</td><td>Broker级别的消费QPS</td><td></td></tr><tr><td>rocketmq_broker_commitlog_diff</td><td>Broker组从节点同步落后消息size</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_0ms</td><td>服务端开始处理写请求到完成写入的耗时（0ms）</td><td>putMessageDistributeTime</td></tr><tr><td>rocketmq_brokeruntime_pmdt_0to10ms</td><td>服务端开始处理写请求到完成写入的耗时（0~10ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_10to50ms</td><td>服务端开始处理写请求到完成写入的耗时（10~50ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_50to100ms</td><td>服务端开始处理写请求到完成写入的耗时（50~100ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_100to200ms</td><td>服务端开始处理写请求到完成写入的耗时（100~200ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_200to500ms</td><td>服务端开始处理写请求到完成写入的耗时（200~500ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_500to1s</td><td>服务端开始处理写请求到完成写入的耗时（500~1000ms）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_1to2s</td><td>服务端开始处理写请求到完成写入的耗时（1~2s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_2to3s</td><td>服务端开始处理写请求到完成写入的耗时（2~3s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_3to4s</td><td>服务端开始处理写请求到完成写入的耗时（3~4s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_4to5s</td><td>服务端开始处理写请求到完成写入的耗时（4~5s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_5to10s</td><td>服务端开始处理写请求到完成写入的耗时（5~10s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_pmdt_10stomore</td><td>服务端开始处理写请求到完成写入的耗时（> 10s）</td><td></td></tr><tr><td>rocketmq_brokeruntime_dispatch_behind_bytes</td><td>到现在为止，未被分发（构建索引之类的操作）的消息bytes</td><td>dispatchBehindBytes</td></tr><tr><td>rocketmq_brokeruntime_put_message_size_total</td><td>broker写入消息size的总和</td><td>putMessageSizeTotal</td></tr><tr><td>rocketmq_brokeruntime_put_message_average_size</td><td>broker写入消息的平均大小</td><td>putMessageAverageSize</td></tr><tr><td>rocketmq_brokeruntime_remain_transientstore_buffer_numbs</td><td>TransientStorePool 中队列的容量</td><td>remainTransientStoreBufferNumbs</td></tr><tr><td>rocketmq_brokeruntime_earliest_message_timestamp</td><td>broker存储的消息最早的时间戳</td><td>earliestMessageTimeStamp</td></tr><tr><td>rocketmq_brokeruntime_putmessage_entire_time_max</td><td>broker自运行以来，写入消息耗时的最大值</td><td>putMessageEntireTimeMax</td></tr><tr><td>rocketmq_brokeruntime_start_accept_sendrequest_time</td><td>开始接受发送请求的时间</td><td>startAcceptSendRequestTimeStamp</td></tr><tr><td>rocketmq_brokeruntime_putmessage_times_total</td><td>broker写入消息的总次数</td><td>putMessageTimesTotal</td></tr><tr><td>rocketmq_brokeruntime_getmessage_entire_time_max</td><td>broker自启动以来，处理消息拉取的最大耗时</td><td>getMessageEntireTimeMax</td></tr><tr><td>rocketmq_brokeruntime_pagecache_lock_time_mills</td><td></td><td>pageCacheLockTimeMills</td></tr><tr><td>rocketmq_brokeruntime_commitlog_disk_ratio</td><td>commitLog所在磁盘的使用比例</td><td>commitLogDiskRatio</td></tr><tr><td>rocketmq_brokeruntime_dispatch_maxbuffer</td><td>broker没有计算，一直为0</td><td>dispatchMaxBuffer</td></tr><tr><td>rocketmq_brokeruntime_pull_threadpoolqueue_capacity</td><td>处理拉取请求线程池队列的容量</td><td>pullThreadPoolQueueCapacity</td></tr><tr><td>rocketmq_brokeruntime_send_threadpoolqueue_capacity</td><td>处理发送请求线程池队列的容量</td><td>sendThreadPoolQueueCapacity</td></tr><tr><td>rocketmq_brokeruntime_query_threadpool_queue_capacity</td><td>处理查询请求线程池队列的容量</td><td>queryThreadPoolQueueCapacity</td></tr><tr><td>rocketmq_brokeruntime_pull_threadpoolqueue_size</td><td>处理拉取请求线程池队列的实际size</td><td>pullThreadPoolQueueSize</td></tr><tr><td>rocketmq_brokeruntime_query_threadpoolqueue_size</td><td>处理查询请求线程池队列的实际size</td><td>queryThreadPoolQueueSize</td></tr><tr><td>rocketmq_brokeruntime_send_threadpool_queue_size</td><td>处理send请求线程池队列的实际size</td><td>sendThreadPoolQueueSize</td></tr><tr><td>rocketmq_brokeruntime_pull_threadpoolqueue_headwait_timemills</td><td>处理拉取请求线程池队列的队头任务等待时间</td><td>pullThreadPoolQueueHeadWaitTimeMills</td></tr><tr><td>rocketmq_brokeruntime_query_threadpoolqueue_headwait_timemills</td><td>处理查询请求线程池队列的队头任务等待时间</td><td>queryThreadPoolQueueHeadWaitTimeMills</td></tr><tr><td>rocketmq_brokeruntime_send_threadpoolqueue_headwait_timemills</td><td>处理发送请求线程池队列的队头任务等待时间</td><td>sendThreadPoolQueueHeadWaitTimeMills</td></tr><tr><td>rocketmq_brokeruntime_msg_gettotal_yesterdaymorning</td><td>到昨晚12点为止，读取消息的总次数</td><td>msgGetTotalYesterdayMorning</td></tr><tr><td>rocketmq_brokeruntime_msg_puttotal_yesterdaymorning</td><td>到昨晚12点为止，写入消息的总次数</td><td>msgPutTotalYesterdayMorning</td></tr><tr><td>rocketmq_brokeruntime_msg_gettotal_todaymorning</td><td>到今晚12点为止，读取消息的总次数</td><td>msgGetTotalTodayMorning</td></tr><tr><td>rocketmq_brokeruntime_msg_puttotal_todaymorning</td><td>到昨晚12点为止，写入消息的总次数</td><td>putMessageTimesTotal</td></tr><tr><td>rocketmq_brokeruntime_msg_put_total_today_now</td><td>每个broker到现在为止，写入的消息次数</td><td>msgPutTotalTodayNow</td></tr><tr><td>rocketmq_brokeruntime_msg_gettotal_today_now</td><td>每个broker到现在为止，读取的消息次数</td><td>msgGetTotalTodayNow</td></tr><tr><td>rocketmq_brokeruntime_commitlogdir_capacity_free</td><td>commitLog所在目录的可用空间</td><td>commitLogDirCapacity</td></tr><tr><td>rocketmq_brokeruntime_commitlogdir_capacity_total</td><td>commitLog所在目录的总空间</td><td></td></tr><tr><td>rocketmq_brokeruntime_commitlog_maxoffset</td><td>commitLog的最大offset</td><td>commitLogMaxOffset</td></tr><tr><td>rocketmq_brokeruntime_commitlog_minoffset</td><td>commitLog的最小offset</td><td>commitLogMinOffset</td></tr><tr><td>rocketmq_brokeruntime_remain_howmanydata_toflush</td><td></td><td>remainHowManyDataToFlush</td></tr><tr><td>rocketmq_brokeruntime_getfound_tps600</td><td>600s内getMessage时get到消息的平均TPS</td><td>getFoundTps</td></tr><tr><td>rocketmq_brokeruntime_getfound_tps60</td><td>60s内getMessage时get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_getfound_tps10</td><td>10s内getMessage时get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_gettotal_tps600</td><td>600s内getMessage次数的平均TPS</td><td>getTotalTps</td></tr><tr><td>rocketmq_brokeruntime_gettotal_tps60</td><td>60s内getMessage次数的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_gettotal_tps10</td><td>10s内getMessage次数的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_gettransfered_tps600</td><td></td><td>getTransferedTps</td></tr><tr><td>rocketmq_brokeruntime_gettransfered_tps60</td><td></td><td></td></tr><tr><td>rocketmq_brokeruntime_gettransfered_tps10</td><td></td><td></td></tr><tr><td>rocketmq_brokeruntime_getmiss_tps600</td><td>600s内getMessage时没有get到消息的平均TPS</td><td>getMissTps</td></tr><tr><td>rocketmq_brokeruntime_getmiss_tps60</td><td>60s内getMessage时没有get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_getmiss_tps10</td><td>10s内getMessage时没有get到消息的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_put_tps600</td><td>600s内写入消息次数的平均TPS</td><td>putTps</td></tr><tr><td>rocketmq_brokeruntime_put_tps60</td><td>60s内写入消息次数的平均TPS</td><td></td></tr><tr><td>rocketmq_brokeruntime_put_tps10</td><td>10s内写入消息次数的平均TPS</td><td></td></tr></tbody></table></div></div></details><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>生产端指标</summary><div><div class="collapsibleContent_i85q"><h3 class="anchor anchorWithStickyNavbar_LWe7" id="生产端指标">生产端指标<a href="#生产端指标" class="hash-link" aria-label="生产端指标的直接链接" title="生产端指标的直接链接"></a></h3><table><thead><tr><th>指标名称</th><th>含义</th></tr></thead><tbody><tr><td>rocketmq_producer_offset</td><td>topic当前时间的最大offset</td></tr><tr><td>rocketmq_topic_retry_offset</td><td>重试Topic当前时间的最大offset</td></tr><tr><td>rocketmq_topic_dlq_offset</td><td>死信Topic当前时间的最大offset</td></tr><tr><td>rocketmq_producer_tps</td><td>Topic在一个Broker组上的生产TPS</td></tr><tr><td>rocketmq_producer_message_size</td><td>Topic在一个Broker组上的生产消息大小的TPS</td></tr><tr><td>rocketmq_queue_producer_tps</td><td>队列级别生产TPS</td></tr><tr><td>rocketmq_queue_producer_message_size</td><td>队列级别生产消息大小的TPS</td></tr></tbody></table></div></div></details><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>消费端指标</summary><div><div class="collapsibleContent_i85q">### 消费端指标<table><thead><tr><th>指标名称</th><th>含义</th></tr></thead><tbody><tr><td>rocketmq_group_diff</td><td>消费组消息堆积消息数</td></tr><tr><td>rocketmq_group_retrydiff</td><td>消费组重试队列堆积消息数</td></tr><tr><td>rocketmq_group_dlqdiff</td><td>消费组死信队列堆积消息数</td></tr><tr><td>rocketmq_group_count</td><td>消费组内消费者个数</td></tr><tr><td>rocketmq_client_consume_fail_msg_count</td><td>过去1h消费者消费失败的次数</td></tr><tr><td>rocketmq_client_consume_fail_msg_tps</td><td>消费者消费失败的TPS</td></tr><tr><td>rocketmq_client_consume_ok_msg_tps</td><td>消费者消费成功的TPS</td></tr><tr><td>rocketmq_client_consume_rt</td><td>消息从拉取到被消费的时间</td></tr><tr><td>rocketmq_client_consumer_pull_rt</td><td>客户端拉取消息的时间</td></tr><tr><td>rocketmq_client_consumer_pull_tps</td><td>客户端拉取消息的TPS</td></tr><tr><td>rocketmq_consumer_tps</td><td>每个Broker组上订阅组的消费TPS</td></tr><tr><td>rocketmq_group_consume_tps</td><td>订阅组当前消费TPS（对rocketmq_consumer_tps按broker聚合）</td></tr><tr><td>rocketmq_consumer_offset</td><td>订阅组在一个broker组上当前的消费Offset</td></tr><tr><td>rocketmq_group_consume_total_offset</td><td>订阅组当前消费的Offset（对rocketmq_consumer_offset按broker聚合）</td></tr><tr><td>rocketmq_consumer_message_size</td><td>订阅组在一个broker组上消费消息大小的TPS</td></tr><tr><td>rocketmq_send_back_nums</td><td>订阅组在一个broker组上消费失败，写入重试消息的次数</td></tr><tr><td>rocketmq_group_get_latency_by_storetime</td><td>消费组消费延时，exporter get到消息后与当前时间相减</td></tr></tbody></table></div></div></details></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/apache/rocketmq-site/tree/new-official-website/docs/04-deployment/04Exporter.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>编辑此页</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="文件选项卡"><a class="pagination-nav__link pagination-nav__link--prev" href="/zh/docs/4.x/deployment/03Dashboard"><div class="pagination-nav__sublabel">上一页</div><div class="pagination-nav__label">RocketMQ Dashboard</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/zh/docs/4.x/bestPractice/01bestpractice"><div class="pagination-nav__sublabel">下一页</div><div class="pagination-nav__label">基本最佳实践</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="#介绍" class="table-of-contents__link toc-highlight">介绍</a><ul><li><a href="#metric-结构" class="table-of-contents__link toc-highlight">Metric 结构</a></li><li><a href="#prometheus-拉取-metrics-的过程" class="table-of-contents__link toc-highlight">Prometheus 拉取 metrics 的过程</a></li><li><a href="#metriccollecttask-类中的-5-个定时任务" class="table-of-contents__link toc-highlight">MetricCollectTask 类中的 5 个定时任务</a></li><li><a href="#rocketmq-exporter-收集指标流程图" class="table-of-contents__link toc-highlight">Rocketmq-exporter 收集指标流程图</a></li></ul></li><li><a href="#快速开始" class="table-of-contents__link toc-highlight">快速开始</a><ul><li><a href="#配置-applicationyml" class="table-of-contents__link toc-highlight">配置 <code>application.yml</code></a></li><li><a href="#启动-exporter-项目" class="table-of-contents__link toc-highlight">启动 exporter 项目</a></li><li><a href="#按照-promethus-官网配置启动" class="table-of-contents__link toc-highlight">按照 promethus 官网配置启动</a></li><li><a href="#访问-promethus-页面" class="table-of-contents__link toc-highlight">访问 promethus 页面</a></li></ul></li><li><a href="#可观测性指标" class="table-of-contents__link toc-highlight">可观测性指标</a><ul><li><a href="#服务端指标" class="table-of-contents__link toc-highlight">服务端指标</a></li><li><a href="#生产端指标" class="table-of-contents__link toc-highlight">生产端指标</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Learn</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/zh/docs/domainModel/01main">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/zh/docs/quickStart/01quickstart">Installation</a></li><li class="footer__item"><a class="footer__link-item" href="/zh/version">Migration from 4.x to 5.0</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://twitter.com/ApacheRocketMQ" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/apache/rocketmq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github</a></li><li class="footer__item"><a href="https://github.com/apache/rocketmq" target="_blank" rel="noopener noreferrer" class="footer__link-item">Help</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/zh/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" href="/zh/release-notes">Changelog</a></li><li class="footer__item"><a href="https://github.com/apache/rocketmq" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Legal</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Licenses<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Security<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Thanks<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Sponsorship<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><a href="https://rocketmq.apache.org/" rel="noopener noreferrer" class="footerLogoLink_BH7S"><img src="/zh/img/Apache_RocketMQ_logo.svg.png" alt="Meta Open Source Logo" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/zh/img/Apache_RocketMQ_logo.svg.png" alt="Meta Open Source Logo" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></a></div><div class="footer__copyright">Copyright © 2024 The Apache Software Foundation. Licensed under the Apache License, Version 2.0.</div></div></div></footer></div> |
| <script src="/zh/assets/js/runtime~main.b17b65ca.js"></script> |
| <script src="/zh/assets/js/main.46e74ac2.js"></script> |
| </body> |
| </html> |
