content/references/java-chassis/zh_CN/general-development/AlarmEvent.html

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <link rel="shortcut icon" href="../img/favicon.ico" /> <title>监听告警事件 - ServiceComb Java Chassis 开发指南</title> <link rel="stylesheet" href="../css/theme.css" /> <link rel="stylesheet" href="../css/theme_extra.css" /> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" /> <script> // Current page data var mkdocs_page_name = "\u76d1\u542c\u544a\u8b66\u4e8b\u4ef6"; var mkdocs_page_input_path = "general-development/AlarmEvent.md"; var mkdocs_page_url = null; </script> <script src="../js/jquery-3.6.0.min.js" defer></script>  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script> <script>hljs.initHighlightingOnLoad();</script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="../index.html" class="icon icon-home"> ServiceComb Java Chassis 开发指南 </a> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference internal" href="../toc.html">目录</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../index.html">概述</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../start/catalog.html">快速入门</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../start/design.html">设计选型参考</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../build-provider/definition/service-definition.html">微服务定义</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../build-provider/catalog.html">开发服务提供者</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../build-consumer/catalog.html">开发服务消费者</a> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="catalog.html">通用功能开发</a> </li> </ul> <p class="caption"><span class="caption-text">多样化的通信协议功能参考</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../transports/introduction.html">多协议介绍</a> </li> <li class="toctree-l1"><a class="reference internal" href="../transports/rest-over-servlet.html">REST over Servlet</a> </li> <li class="toctree-l1"><a class="reference internal" href="../transports/rest-over-vertx.html">REST over Vertx</a> </li> <li class="toctree-l1"><a class="reference internal" href="../transports/http2.html">REST over HTTP2</a> </li> <li class="toctree-l1"><a class="reference internal" href="../transports/highway-rpc.html">Highway</a> </li> </ul> <p class="caption"><span class="caption-text">多样化的服务注册与发现功能参考</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../registry/introduction.html">注册发现说明</a> </li> <li class="toctree-l1"><a class="reference internal" href="../registry/service-center.html">使用服务中心</a> </li> <li class="toctree-l1"><a class="reference internal" href="../registry/local-registry.html">本地注册发现</a> </li> <li class="toctree-l1"><a class="reference internal" href="../registry/distributed.html">去中心化注册发现</a> </li> </ul> <p class="caption"><span class="caption-text">管理服务配置</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../config/general-config.html">通用配置说明</a> </li> <li class="toctree-l1"><a class="reference internal" href="../config/read-config.html">在程序中读取配置信息</a> </li> </ul> <p class="caption"><span class="caption-text">服务治理功能参考</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/intruduction.html">处理链介绍</a> </li> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/loadbalance.html">负载均衡</a> </li> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/ratelimit.html">限流</a> </li> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/router.html">灰度发布</a> </li> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/fault-injection.html">故障注入</a> </li> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/governance.html">流量特征治理</a> </li> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/fail-retry.html">快速失败和重试</a> </li> </ul> <p class="caption"><span class="caption-text">网关功能参考</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../edge/open-service.html">介绍</a> </li> <li class="toctree-l1"><a class="reference internal" href="../edge/by-servicecomb-sdk.html">使用 Edge Service 做网关</a> </li> <li class="toctree-l1"><a class="reference internal" href="../edge/zuul.html">使用 `zuul` 和 `spring cloud gateway` 做网关</a> </li> <li class="toctree-l1"><a class="reference internal" href="../edge/nginx.html">nginx 网关简单介绍</a> </li> </ul> <p class="caption"><span class="caption-text">安全特性参考</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../references-handlers/publickey.html">公钥认证</a> </li> <li class="toctree-l1"><a class="reference internal" href="../security/tls.html">使用TLS通信</a> </li> <li class="toctree-l1"><a class="reference internal" href="../security/shi-yong-rsa-ren-zheng.html">使用RSA认证</a> </li> </ul> <p class="caption"><span class="caption-text">服务打包和运行</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../packaging/standalone.html">以standalone模式打包</a> </li> <li class="toctree-l1"><a class="reference internal" href="../packaging/web-container.html">以WEB容器模式打包</a> </li> </ul> <p class="caption"><span class="caption-text">专题文章</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot.html">在Spring Boot中使用java chassis</a> </li> <li class="toctree-l1"><a class="reference internal" href="../featured-topics/features.html">新功能介绍系列文章</a> </li> <li class="toctree-l1"><a class="reference internal" href="../featured-topics/compatibility.html">兼容问题和兼容性策略</a> </li> <li class="toctree-l1"><a class="reference internal" href="../featured-topics/upgrading.html">升级指导系列文章</a> </li> <li class="toctree-l1"><a class="reference internal" href="../featured-topics/performance.html">性能问题分析和调优</a> </li> </ul> <p class="caption"><span class="caption-text">常用配置项参考</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../config-reference/rest-transport-client.html">REST Transport Client 配置项</a> </li> <li class="toctree-l1"><a class="reference internal" href="../config-reference/config-center-client.html">Config Center Client 配置项</a> </li> <li class="toctree-l1"><a class="reference internal" href="../config-reference/service-center-client.html">Service Center Client 配置项</a> </li> <li class="toctree-l1"><a class="reference internal" href="../config-reference/kie-client.html">ServiceComb Kie Client 配置项</a> </li> </ul> <p class="caption"><span class="caption-text">常见问题</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="../question-and-answer/faq.html">FAQ</a> </li> <li class="toctree-l1"><a class="reference internal" href="../question-and-answer/question_answer.html">Q & A</a> </li> <li class="toctree-l1"><a class="reference internal" href="../question-and-answer/interface-compatibility.html">微服务接口兼容常见问题</a> </li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../index.html">ServiceComb Java Chassis 开发指南</a> </nav> <div class="wy-nav-content"> <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="../index.html" class="icon icon-home" alt="Docs"></a> »</li> <li>监听告警事件</li> <li class="wy-breadcrumbs-aside"> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div class="section" itemprop="articleBody"> <h1 id="_1">监听告警事件</h1> <h2 id="_2">场景描述</h2> <p>Java-Chassis 会在运行期间抛出一些与微服务治理相关的告警事件，当前涉及的场景包括：</p> <ul> <li>服务熔断</li> <li>实例隔离</li> </ul> <p>用户可以自行扩展告警事件监听器，获取相关事件。</p> <h2 id="_3">告警事件列表</h2> <table class="metrics-table"> <tr> <th>事件</th> <th>事件属性</th> <th>属性说明</th> </tr>  <tr> <td rowspan="11">CircutBreakerEvent<br/>服务熔断事件</td> <td>type</td> <td>事件类型，包含`OPEN`/`CLOSE`两个枚举值，分别表示事件发生和事件恢复</td> </tr> <tr> <td>role</td> <td>熔断事件发生时本服务实例的角色，有`CONSUMER`/`PRODUCER`两种取值</td> </tr> <tr> <td>microservice</td> <td>被熔断的服务名</td> </tr> <tr> <td>schema</td> <td>被熔断的服务的契约ID</td> </tr> <tr> <td>operation</td> <td>被熔断的服务的方法名</td> </tr> <tr> <td>currentTotalRequest</td> <td>当前总请求数</td> </tr> <tr> <td>currentErrorCount</td> <td>当前请求出错计数</td> </tr> <tr> <td>currentErrorPercentage</td> <td>当前请求出错百分比</td> </tr> <tr> <td>requestVolumeThreshold</td> <td>10s内请求数需要大于等于这个参数值，才开始计算错误率和判断是否进行熔断</td> </tr> <tr> <td>sleepWindowInMilliseconds</td> <td>熔断效果维持时间</td> </tr> <tr> <td>errorThresholdPercentage</td> <td>错误率阈值，达到此阈值则触发熔断</td> </tr>  <tr> <td rowspan="12">IsolationServerEvent<br/>实例隔离事件</td> <td>type</td> <td>事件类型，包含`OPEN`/`CLOSE`两个枚举值，分别表示事件发生和事件恢复</td> </tr> <tr> <td>microserviceName</td> <td>被隔离实例的微服务名</td> </tr> <tr> <td>endpoint</td> <td>被隔离实例的endpoint信息</td> </tr> <tr> <td>instance</td> <td>被隔离实例的实例信息，类型为<code>org.apache.servicecomb.serviceregistry.api.registry.MicroserviceInstance</code></td> </tr> <tr> <td>currentTotalRequest</td> <td>当前实例总请求数</td> </tr> <tr> <td>currentCountinuousFailureCount</td> <td>当前实例连续出错次数</td> </tr> <tr> <td>currentErrorPercentage</td> <td>当前实例出错百分比</td> </tr> <tr> <td>minIsolationTime</td> <td>实例隔离效果维持的最短事件，单位为毫秒</td> </tr> <tr> <td>enableRequestThreshold</td> <td>开启实例隔离状态统计的阈值，总请求次数超过此阈值时开始计算请求失败情况，判断是否隔离实例</td> </tr> <tr> <td>continuousFailureThreshold</td> <td>连续请求失败阈值，在连续请求失败次数触发隔离的模式下，如果一个实例连续调用失败次数超过此阈值则被隔离</td> </tr> <tr> <td>errorThresholdPercentage</td> <td>请求错误率阈值，在请求错误率触发隔离的模式下，如果一个实例的请求失败率超过此阈值则被隔离</td> </tr> <tr> <td>singleTestTime</td> <td>实例隔离效果维持时间</td> </tr> </table> <h2 id="_4">使用参考</h2> <ul> <li>定义告警事件监听器</li> </ul> <pre><code class="language-java">public class AlarmListener { @Subscribe public void onAllKindsOfEvent(AlarmEvent event) { // 监听告警事件的基类以获取所有种类的告警事件 } @Subscribe public void onCircutBreakerEvent(CircutBreakerEvent event) { // 仅监听服务熔断事件 } @Subscribe public void onIsolationServerEvent(IsolationServerEvent event) { // 仅监听实例隔离事件 } } </code></pre> <p>事件监听器示例如上所示，监听器里的三个方法分别用于监听全部告警事件、仅监听服务熔断事件、仅监听实例隔离事件。注意，监听器里的三个方法不是必需的，使用者可以根据自身需要，自行决定需要在监听器中定义的方法。</p> <ul> <li>在<code>EventBus</code>中注册事件监听器</li> </ul> <pre><code>EventManager.getEventBus().register(receiveEvent); </code></pre> </div> </div><footer> <hr/> <div role="contentinfo">  </div> Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <div class="rst-versions" role="note" aria-label="Versions"> <span class="rst-current-version" data-toggle="rst-current-version"> </span> </div> <script>var base_url = '..';</script> <script src="../js/theme_extra.js" defer></script> <script src="../js/theme.js" defer></script> <script src="../search/main.js" defer></script> <script defer> window.onload = function () { SphinxRtdTheme.Navigation.enable(true); }; </script> </body> </html>

content/references/java-chassis/zh_CN/general-development/AlarmEvent.html (352 lines of code) (raw):