| <!doctype html> |
| <html lang="en" dir="ltr"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-beta.4"> |
| <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache ShenYu Blog Atom Feed"> |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache ShenYu" href="/opensearch.xml"> |
| <link rel="alternate" type="application/rss+xml" href="/news/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/news/atom.xml" title="Apache ShenYu Blog Atom Feed"><title data-react-helmet="true">Metrics Plugin | Apache ShenYu</title><meta data-react-helmet="true" property="og:url" content="https://shenyu.apache.org//docs/2.6.0/plugin-center/observability/metrics-plugin"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="2.6.0"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-2.6.0"><meta data-react-helmet="true" property="og:title" content="Metrics Plugin | Apache ShenYu"><meta data-react-helmet="true" name="description" content="Metrics plugin"><meta data-react-helmet="true" property="og:description" content="Metrics plugin"><meta data-react-helmet="true" name="keywords" content="Metrics"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.svg"><link data-react-helmet="true" rel="canonical" href="https://shenyu.apache.org//docs/2.6.0/plugin-center/observability/metrics-plugin"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/2.6.0/plugin-center/observability/metrics-plugin" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//zh/docs/2.6.0/plugin-center/observability/metrics-plugin" hreflang="zh"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/2.6.0/plugin-center/observability/metrics-plugin" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.cc2d0c98.css"> |
| <link rel="preload" href="/assets/js/runtime~main.19526316.js" as="script"> |
| <link rel="preload" href="/assets/js/main.0feaae07.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><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="/"><img src="/img/logo.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/logo-light.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/download">Download</a><a class="navbar__item navbar__link" href="/document">Docs</a><a class="navbar__item navbar__link" href="/community/contributor-guide">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/event">Event</a><a class="navbar__item navbar__link" href="/news">News</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/users">Users</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><a href="https://github.com/apache/shenyu" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><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></span></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" class="navbar__item navbar__link"><span><svg t="1631348384596" class="icon" viewBox="0 0 1024 1024" version="1.1" style="vertical-align:text-bottom;margin-right:5px" p-id="557" width="20" height="20"><path d="M547.797333 638.208l-104.405333-103.168 1.237333-1.28a720.170667 720.170667 0 0 0 152.490667-268.373333h120.448V183.082667h-287.744V100.906667H347.605333v82.218666H59.818667V265.386667h459.178666a648.234667 648.234667 0 0 1-130.304 219.946666 643.242667 643.242667 0 0 1-94.976-137.728H211.541333a722.048 722.048 0 0 0 122.453334 187.434667l-209.194667 206.378667 58.368 58.368 205.525333-205.525334 127.872 127.829334 31.232-83.84m231.424-208.426667h-82.218666l-184.96 493.312h82.218666l46.037334-123.306667h195.242666l46.464 123.306667h82.218667l-185.002667-493.312m-107.690666 287.744l66.56-178.005333 66.602666 178.005333z" fill="currentColor" p-id="558"></path></svg><span>English</span></span></a><ul class="dropdown__menu"><li><a href="/docs/2.6.0/plugin-center/observability/metrics-plugin" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" style="text-transform:capitalize">English</a></li><li><a href="/zh/docs/2.6.0/plugin-center/observability/metrics-plugin" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">简体中文</a></li></ul></div><div class="react-toggle toggle_2i4l react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_iYfV">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_iYfV">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><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">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_lDyR"><button class="clean-btn backToTopButton_i9tI" type="button" title="Scroll to top"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh menuWithAnnouncementBar_+O1J"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/2.6.0/index">Overview</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Design</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Deployment</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Quick Start</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">User Guide</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">Plugin Center</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Http Process</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Proxy</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Fault Tolerance</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Security</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#" tabindex="0">Observability</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-aliyun-sls">Logging Aliyun Sls Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-elasticsearch">Logging-ElasticSearch Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-huawei-lts">Logging-Huawei llts日志插件</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-kafka">Logging-Kafka Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-plugin">Logging Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-pulsar">Logging-Pulsar Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-rocketmq">Logging-RocketMQ Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/plugin-center/observability/logging-tencent-cls">Logging-Tencent cls日志插件</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/2.6.0/plugin-center/observability/metrics-plugin">Metrics Plugin</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Common</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Cache</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Mock</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">discovery</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Developer</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Benchmark Test</a></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for Apache ShenYu <b>2.6.0</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/plugin-center/observability/metrics-plugin">latest version</a></b> (2.7.0).</div></div><div class="docItemContainer_oiyr"><article><span class="badge badge--secondary">Version: 2.6.0</span><div class="tocCollapsible_aw-L tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="markdown"><header><h1 class="h1Heading_dC7a">Metrics Plugin</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="description"></a>Description<a class="hash-link" href="#description" title="Direct link to heading">#</a></h2><ul><li>Metrics plugin is used to monitor its own running status(JVM-related) by gateway, include request response delay, QPS, TPS, and other related metrics.</li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="technical-solutions"></a>Technical Solutions<a class="hash-link" href="#technical-solutions" title="Direct link to heading">#</a></h2><ul><li><p>Flow Diagram |
| <img src="/assets/images/shenyu-metrics-805b9a2539e9808d934caae9b3a1404f.png"></p></li><li><p>Make even tracking in ShenYu Gateway by asynchronous or synchronous mode.</p></li><li><p>The <code>prometheus</code> server pulls metrics' through http request, and then displays it by <code>Grafana</code>.</p></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="plugin-setting"></a>Plugin Setting<a class="hash-link" href="#plugin-setting" title="Direct link to heading">#</a></h2><ul><li>Introduce <code>metrics</code> dependency in the pom.xml file of the gateway.</li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI xml"><pre tabindex="0" class="prism-code language-xml codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"><!-- apache shenyu metrics plugin start--></span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">dependency</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">groupId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain">org.apache.shenyu</span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">groupId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">artifactId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain">shenyu-spring-boot-starter-plugin-metrics</span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">artifactId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">version</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain">${project.version}</span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">version</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">dependency</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"><!-- apache shenyu metrics plugin end--></span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><ul><li>modify this config in shenyu gateway yaml</li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI yml"><pre tabindex="0" class="prism-code language-yml codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#00a4db">shenyu</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">metrics</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">enabled</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">false</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">#false is close, true is open</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">name</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> prometheus </span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">host</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> 127.0.0.1</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">port</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">8090</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">jmxConfig</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">props</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">jvm_enabled</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">true</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">#enable jvm monitoring</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="metrics-detail"></a>Metrics Detail<a class="hash-link" href="#metrics-detail" title="Direct link to heading">#</a></h2><ul><li><p>All JVM，thread，memory，and other related information will be made event tracking，you can add a JVM module in the Grafana' panel, and it will be fully displayed, please refer to： <a href="https://github.com/prometheus/jmx_exporter" target="_blank" rel="noopener noreferrer">https://github.com/prometheus/jmx_exporter</a></p></li><li><p>There are also the following custom <code>metrics</code></p></li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyu-gateway-custom-metrics"></a>shenyu gateway custom metrics<a class="hash-link" href="#shenyu-gateway-custom-metrics" title="Direct link to heading">#</a></h3><table><thead><tr><th align="left">Name</th><th align="left">type</th><th align="left">labels</th><th align="left">description</th></tr></thead><tbody><tr><td align="left">shenyu_request_total</td><td align="left">Counter</td><td align="left">none</td><td align="left">collecting all requests of Apache ShenYu Gateway</td></tr><tr><td align="left">shenyu_request_throw_total</td><td align="left">Counter</td><td align="left">none</td><td align="left">collecting all exception requests of Apache ShenYu Gateway</td></tr><tr><td align="left">shenyu_request_type_total</td><td align="left">Counter</td><td align="left">path,type</td><td align="left">collecting all matched requests of monitor</td></tr><tr><td align="left">shenyu_execute_latency_millis</td><td align="left">histogram</td><td align="left">none</td><td align="left">ShenYu gateway execute time interval</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="jmx-metrics"></a>jmx metrics<a class="hash-link" href="#jmx-metrics" title="Direct link to heading">#</a></h3><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labals</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jmx_config_reload_success_total</td><td align="center">counter</td><td align="center"></td><td align="center">Number of times configuration have successfully been reloaded.</td></tr><tr><td align="center">jmx_config_reload_failure_total</td><td align="center">counter</td><td align="center"></td><td align="center">Number of times configuration have failed to be reloaded.</td></tr><tr><td align="center">jmx_scrape_duration_seconds</td><td align="center">gauge</td><td align="center"></td><td align="center">Time this JMX scrape took, in seconds.</td></tr><tr><td align="center">jmx_scrape_error</td><td align="center">gauge</td><td align="center"></td><td align="center">Non-zero if this scrape failed.</td></tr><tr><td align="center">jmx_scrape_cached_beans</td><td align="center">gauge</td><td align="center"></td><td align="center">Number of beans with their matching rule cached</td></tr><tr><td align="center">jmx_scrape_duration_seconds</td><td align="center">gauge</td><td align="center"></td><td align="center">Time this JMX scrape took, in seconds.</td></tr><tr><td align="center">jmx_scrape_error</td><td align="center">gauge</td><td align="center"></td><td align="center">Non-zero if this scrape failed.</td></tr><tr><td align="center">jmx_scrape_cached_beans</td><td align="center">gauge</td><td align="center"></td><td align="center">Number of beans with their matching rule cached</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="jvm-metrics"></a>jvm metrics<a class="hash-link" href="#jvm-metrics" title="Direct link to heading">#</a></h3><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="standardexports"></a>StandardExports<a class="hash-link" href="#standardexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">process_cpu_seconds_total</td><td align="center">counter</td><td align="center"></td><td align="center">Total user and system CPU time spent in seconds.</td></tr><tr><td align="center">process_start_time_seconds</td><td align="center">gauge</td><td align="center"></td><td align="center">Start time of the process since unix epoch in seconds.</td></tr><tr><td align="center">process_open_fds</td><td align="center">gauge</td><td align="center"></td><td align="center">Number of open file descriptors.</td></tr><tr><td align="center">process_max_fds</td><td align="center">gauge</td><td align="center"></td><td align="center">Maximum number of open file descriptors.</td></tr><tr><td align="center">process_virtual_memory_bytes</td><td align="center">gauge</td><td align="center"></td><td align="center">Virtual memory size in bytes.</td></tr><tr><td align="center">process_resident_memory_bytes</td><td align="center">gauge</td><td align="center"></td><td align="center">Resident memory size in bytes.</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="memorypoolsexports"></a>MemoryPoolsExports<a class="hash-link" href="#memorypoolsexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm_memory_objects_pending_finalization</td><td align="center">gauge</td><td align="center">{area="heap|nonheap"}</td><td align="center">The number of objects waiting in the finalizer queue.</td></tr><tr><td align="center">jvm_memory_bytes_used</td><td align="center">gauge</td><td align="center">{area="heap|nonheap"}</td><td align="center">Used bytes of a given JVM memory area.</td></tr><tr><td align="center">jvm_memory_bytes_committed</td><td align="center">gauge</td><td align="center">{area="heap|nonheap"}</td><td align="center">Committed (bytes) of a given JVM memory area.</td></tr><tr><td align="center">jvm_memory_bytes_max</td><td align="center">gauge</td><td align="center">{area="heap|nonheap"}</td><td align="center">Max (bytes) of a given JVM memory area.</td></tr><tr><td align="center">jvm_memory_bytes_init</td><td align="center">gauge</td><td align="center">{area="heap|nonheap"}</td><td align="center">Initial bytes of a given JVM memory area.</td></tr><tr><td align="center">jvm_memory_pool_bytes_used</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Used bytes of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_bytes_committed</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Committed bytes of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_bytes_max</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Max bytes of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_bytes_init</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Initial bytes of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_collection_used_bytes</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Used bytes after last collection of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_collection_committed_bytes</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Committed after last collection bytes of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_collection_max_bytes</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Max bytes after last collection of a given JVM memory pool.</td></tr><tr><td align="center">jvm_memory_pool_collection_init_bytes</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Initial after last collection bytes of a given JVM memory pool.</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="memoryallocationexports"></a>MemoryAllocationExports<a class="hash-link" href="#memoryallocationexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm_memory_pool_allocated_bytes_total</td><td align="center">counter</td><td align="center">{pool}</td><td align="center">Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously.</td></tr><tr><td align="center"></td><td align="center"></td><td align="center"></td><td align="center"></td></tr><tr><td align="center"></td><td align="center"></td><td align="center"></td><td align="center"></td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="bufferpoolsexports"></a>BufferPoolsExports<a class="hash-link" href="#bufferpoolsexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm_buffer_pool_used_bytes</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Used bytes of a given JVM buffer pool.</td></tr><tr><td align="center">jvm_buffer_pool_capacity_bytes</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Bytes capacity of a given JVM buffer pool.</td></tr><tr><td align="center">jvm_buffer_pool_used_buffers</td><td align="center">gauge</td><td align="center">{pool}</td><td align="center">Used buffers of a given JVM buffer pool.</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="garbagecollectorexports"></a>GarbageCollectorExports<a class="hash-link" href="#garbagecollectorexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm_gc_collection_seconds</td><td align="center">summary</td><td align="center">{gc}</td><td align="center">Time spent in a given JVM garbage collector in seconds.</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="threadexports"></a>ThreadExports<a class="hash-link" href="#threadexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm_threads_current</td><td align="center">gauge</td><td align="center"></td><td align="center">Current thread count of a JVM</td></tr><tr><td align="center">jvm_threads_daemon</td><td align="center">gauge</td><td align="center"></td><td align="center">Daemon thread count of a JVM</td></tr><tr><td align="center">jvm_threads_peak</td><td align="center">gauge</td><td align="center"></td><td align="center">Peak thread count of a JVM</td></tr><tr><td align="center">jvm_threads_started_total</td><td align="center">counter</td><td align="center"></td><td align="center">Started thread count of a JVM</td></tr><tr><td align="center">jvm_threads_deadlocked</td><td align="center">gauge</td><td align="center"></td><td align="center">Cycles of JVM-threads that are in deadlock waiting to acquire object monitors or ownable synchronizers</td></tr><tr><td align="center">jvm_threads_deadlocked_monitor</td><td align="center">gauge</td><td align="center"></td><td align="center">Cycles of JVM-threads that are in deadlock waiting to acquire object monitors</td></tr><tr><td align="center">jvm_threads_state</td><td align="center">gauge</td><td align="center">{state}</td><td align="center">Current count of threads by state</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="classloadingexports"></a>ClassLoadingExports<a class="hash-link" href="#classloadingexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm_classes_loaded</td><td align="center">gauge</td><td align="center"></td><td align="center">The number of classes that are currently loaded in the JVM</td></tr><tr><td align="center">jvm_classes_loaded_total</td><td align="center">counter</td><td align="center"></td><td align="center">The total number of classes that have been loaded since the JVM has started execution</td></tr><tr><td align="center">jvm_classes_unloaded_total</td><td align="center">counter</td><td align="center"></td><td align="center">The total number of classes that have been unloaded since the JVM has started execution</td></tr></tbody></table><h4><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="versioninfoexports"></a>VersionInfoExports<a class="hash-link" href="#versioninfoexports" title="Direct link to heading">#</a></h4><table><thead><tr><th align="center">name</th><th align="center">type</th><th align="center">labels</th><th align="center">help</th></tr></thead><tbody><tr><td align="center">jvm</td><td align="center">info</td><td align="center">{version(java.runtime.version),vendor(java.vm.vendor),runtime(java.runtime.name)}</td><td align="center">VM version info</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="collect-metrics"></a>Collect metrics<a class="hash-link" href="#collect-metrics" title="Direct link to heading">#</a></h2><p>Users need to install <code>Prometheus</code> service to collect</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="install-prometheus-in-windows"></a>Install Prometheus in windows<a class="hash-link" href="#install-prometheus-in-windows" title="Direct link to heading">#</a></h3><ul><li><p>Choose the corresponding environment <a href="https://prometheus.io/download/" target="_blank" rel="noopener noreferrer">download address</a> to install</p></li><li><p>Modify configuration file: <code>prometheus.yml</code></p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI yaml"><pre tabindex="0" class="prism-code language-yaml codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#00a4db">scrape_configs</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">job_name</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'Apache ShenYu'</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># metrics_path defaults to '/metrics'</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># scheme defaults to 'http'.</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">static_configs</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">targets</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">'localhost:8090'</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic"># metrics of apache shenyu are exposed on port 8090 by default</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div></li><li><p>After the configuration is completed, you can directly double-click <code>prometheus.exe</code> in the window to start. The default boot port is <code>9090</code>,check <code>status</code>-><code>Targets</code> . Success can be verified at http://localhost:9090/</p></li></ul><p><img src="/assets/images/request-metric-6-e6e3fea6e33e3799c8f4d2dfa98bc5ec.png"></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="install-prometheus-in-the-macos"></a>Install Prometheus in the macOS<a class="hash-link" href="#install-prometheus-in-the-macos" title="Direct link to heading">#</a></h3><ul><li>Install prometheus with brew，After installation <code>prometheus</code> is in the <code>Cellar</code> folder under <code>homebrew</code>。</li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">brew install prometheus</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><ul><li>Execute the following command in the location of the prometheus.yml file to start prometheus。</li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">prometheus --config.file=prometheus.yml &</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>Visit <code>http://localhost:9090/</code> to verify that it starts normally。</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="panel-display"></a>Panel Display<a class="hash-link" href="#panel-display" title="Direct link to heading">#</a></h2><p>It is recommended to use <code>Grafana</code>, Users can customize the query to personalize the display panel.</p><p>Here's how to install and deploy <code>Grafana</code></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="install-grafana-in-windows"></a>Install Grafana in windows<a class="hash-link" href="#install-grafana-in-windows" title="Direct link to heading">#</a></h3><ul><li>Install Grafana</li></ul><p><a href="https://dl.grafana.com/oss/release/grafana-7.4.2.windows-amd64.zip" target="_blank" rel="noopener noreferrer">download</a> Unzip it and enter the <code>bin</code> directory and <code>double-click</code> <code>grafana-server.exe</code> to run it. Go to http://localhost:3000/?orgId=1 <code>admin/admin</code> to verify the success</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="install-grafana-in-macos"></a>Install Grafana in macOS<a class="hash-link" href="#install-grafana-in-macos" title="Direct link to heading">#</a></h3><ul><li>Install grafana using brew.</li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">brew install grafana</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><ul><li>Start grafana as a service</li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">brew services start grafana</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>Visit <code>http://localhost:3000/</code> to verify that it starts normally.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="view-monitoring-data-with-grafana"></a>View monitoring data with Grafana<a class="hash-link" href="#view-monitoring-data-with-grafana" title="Direct link to heading">#</a></h3><ul><li>Configure the data source, select prometheus, note that the data source name is prometheus.</li></ul><p><img src="/assets/images/request-metric-7-355daf90afad71497091d1b1fdb477fb.png"></p><p><img src="/assets/images/request-metric-8-8425d041585a6db6b27412ac052c5e57.png"></p><ul><li>Config Custom Metric Dashboard <code>request_total</code>、<code>http_request_total</code></li></ul><p>Click <code>Create</code> - <code>Import</code> and enter the <a href="https://shenyu.apache.org/img/shenyu/monitor/request_metric_dashboard.json" target="_blank" rel="noopener noreferrer">panel config json</a></p><p>The final custom HTTP request monitoring panel looks like this:</p><p><img src="/assets/images/request-metric-1-92f09dff492b284cf5462a1b2149f804.png"></p><p><img src="/assets/images/request-metric-2-4ef0ea780f6d612bb1076decaa4c4549.png"></p><p><img src="/assets/images/request-metric-3-25e310a4c0c636d2ccd872bada66bfe9.png"></p><p><img src="/assets/images/request-metric-4-d95d82437f8344ab537170fc78ee980c.png"></p><p><img src="/assets/images/request-metric-5-5be0cded02230111957e9cbf0b74f653.png"></p></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/apache/shenyu-website/edit/main/versioned_docs/version-2.6.0/plugin-center/observability/metrics-plugin.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_wj+Z"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/2.6.0/plugin-center/observability/logging-tencent-cls"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Logging-Tencent cls日志插件</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/2.6.0/plugin-center/common/general-context-plugin"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">GeneralContext Plugin »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#description" class="table-of-contents__link">Description</a></li><li><a href="#technical-solutions" class="table-of-contents__link">Technical Solutions</a></li><li><a href="#plugin-setting" class="table-of-contents__link">Plugin Setting</a></li><li><a href="#metrics-detail" class="table-of-contents__link">Metrics Detail</a><ul><li><a href="#shenyu-gateway-custom-metrics" class="table-of-contents__link">shenyu gateway custom metrics</a></li><li><a href="#jmx-metrics" class="table-of-contents__link">jmx metrics</a></li><li><a href="#jvm-metrics" class="table-of-contents__link">jvm metrics</a></li></ul></li><li><a href="#collect-metrics" class="table-of-contents__link">Collect metrics</a><ul><li><a href="#install-prometheus-in-windows" class="table-of-contents__link">Install Prometheus in windows</a></li><li><a href="#install-prometheus-in-the-macos" class="table-of-contents__link">Install Prometheus in the macOS</a></li></ul></li><li><a href="#panel-display" class="table-of-contents__link">Panel Display</a><ul><li><a href="#install-grafana-in-windows" class="table-of-contents__link">Install Grafana in windows</a></li><li><a href="#install-grafana-in-macos" class="table-of-contents__link">Install Grafana in macOS</a></li><li><a href="#view-monitoring-data-with-grafana" class="table-of-contents__link">View monitoring data with Grafana</a></li></ul></li></ul></div></div></div></div></main></div></div></div> |
| <script src="/assets/js/runtime~main.19526316.js"></script> |
| <script src="/assets/js/main.0feaae07.js"></script> |
| </body> |
| </html> |
