| <!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 = "\u6545\u969c\u6ce8\u5165"; |
| var mkdocs_page_input_path = "references-handlers/fault-injection.md"; |
| var mkdocs_page_url = null; |
| </script> |
| |
| <script src="../js/jquery-3.6.0.min.js" defer></script> |
| <!--[if lt IE 9]> |
| <script src="../js/html5shiv.min.js"></script> |
| <![endif]--> |
| <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="../general-development/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 class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="intruduction.html">处理链介绍</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="loadbalance.html">负载均衡</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="ratelimit.html">限流</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="router.html">灰度发布</a> |
| </li> |
| <li class="toctree-l1 current"><a class="reference internal current" href="fault-injection.html">故障注入</a> |
| <ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="#_2">注意事项</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#_3">配置说明</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#_4">示例代码</a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="governance.html">流量特征治理</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="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="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>故障注入</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> |
| <p>用户在consumer端使用故障注入，可以设置发往指定微服务的请求的时延和错误及其触发概率。</p> |
| <h2 id="_2">注意事项</h2> |
| <p>延迟注入请求的延迟时间统一为毫秒。</p> |
| <h2 id="_3">配置说明</h2> |
| <p>故障注入配置在microservice.yaml文件中，相关配置项见下表。要开启服务消费者端的故障注入，还需要在处理链中配置消费端故障注入handler，配置示例如下：</p> |
| <pre><code class="language-yaml">servicecomb: |
| handler: |
| chain: |
| Consumer: |
| default: loadbalance,fault-injection-consumer |
| </code></pre> |
| <p>故障注入配置项说明</p> |
| <p>[scope]代表故障注入的生效范围，可配置值包括全局配置_global，或指定微服务的服务名[ServiceName]。</p> |
| <p>[protocol]代表使用的通信协议，可配置值包括rest或highway。</p> |
| <table> |
| <thead> |
| <tr> |
| <th align="left">配置项</th> |
| <th align="left">默认值</th> |
| <th align="left">取值范围</th> |
| <th align="left">是否必选</th> |
| <th align="left">含义</th> |
| <th align="left">注意</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[scope].policy.fault.protocols.[protocol].delay.fixedDelay</td> |
| <td align="left">无</td> |
| <td align="left">(0,9223372036854775807]，长整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送延迟注入请求的延迟时间</td> |
| <td align="left">目前时间单位是毫秒</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[scope].policy.fault.protocols.[protocol].delay.percent</td> |
| <td align="left">100</td> |
| <td align="left">(0,100]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送延迟注入请求的触发概率</td> |
| <td align="left"></td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].policy.fault.protocols.[protocol].delay.fixedDelay</td> |
| <td align="left">无</td> |
| <td align="left">(0,9223372036854775807]，长整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应schema的延迟注入请求的延迟时间</td> |
| <td align="left">支持schema级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].policy.fault.protocols.[protocol].delay.percent</td> |
| <td align="left">100</td> |
| <td align="left">(0,100]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应schema的延迟注入请求的触发概率</td> |
| <td align="left">支持schema级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].operations.[operation].policy.fault.protocols.[protocol].delay.fixedDelay</td> |
| <td align="left">无</td> |
| <td align="left">(0,9223372036854775807]，长整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应operation的延迟注入请求的延迟时间</td> |
| <td align="left">支持operation级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].operations.[operation].policy.fault.protocols.[protocol].delay.percent</td> |
| <td align="left">100</td> |
| <td align="left">(0,100]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应operation的延迟注入请求的触发概率</td> |
| <td align="left">支持operation级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[scope].policy.fault.protocols.[protocol].abort.httpStatus</td> |
| <td align="left">无</td> |
| <td align="left">(100,999]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送错误注入请求的http错误码</td> |
| <td align="left"></td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[scope].policy.fault.protocols.[protocol].abort.percent</td> |
| <td align="left">100</td> |
| <td align="left">(0,100]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送错误注入请求的触发概率</td> |
| <td align="left"></td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].policy.fault.protocols.[protocol].abort.httpStatus</td> |
| <td align="left">无</td> |
| <td align="left">(100,999]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应schema的错误注入请求的http错误码</td> |
| <td align="left">支持schema级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].policy.fault.protocols.[protocol].abort.percent</td> |
| <td align="left">100</td> |
| <td align="left">(0,100]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应schema的错误注入请求的触发概率</td> |
| <td align="left">支持schema级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].operations.[operation].policy.fault.protocols.[protocol].abort.httpStatus</td> |
| <td align="left">无</td> |
| <td align="left">(100,999]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应operation的错误注入请求的http错误码</td> |
| <td align="left">支持operation级别的配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.governance.Consumer.[ServiceName].schemas.[schema].operations.[operation].policy.fault.protocols.[protocol].abort.percent</td> |
| <td align="left">100</td> |
| <td align="left">(0,100]，整型</td> |
| <td align="left">否</td> |
| <td align="left">Consumer端发送到对应operation的错误注入请求的触发概率</td> |
| <td align="left">支持operation级别的配置</td> |
| </tr> |
| </tbody> |
| </table> |
| <h2 id="_4">示例代码</h2> |
| <pre><code>servicecomb: |
| governance: |
| Consumer: |
| _global: |
| policy: |
| fault: |
| protocols: |
| rest: |
| delay: |
| fixedDelay: 5000 |
| percent: 10 |
| </code></pre> |
| <pre><code>servicecomb: |
| governance: |
| Consumer: |
| ServerFaultTest: |
| schemas: |
| schema: |
| operations: |
| operation: |
| policy: |
| fault: |
| protocols: |
| rest: |
| abort: |
| httpStatus: 421 |
| percent: 100 |
| </code></pre> |
| |
| </div> |
| </div><footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> |
| <a href="router.html" class="btn btn-neutral float-left" title="灰度发布"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| <a href="governance.html" class="btn btn-neutral float-right" title="流量特征治理">Next <span class="icon icon-circle-arrow-right"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <!-- Copyright etc --> |
| </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><a href="router.html" style="color: #fcfcfc">« Previous</a></span> |
| |
| |
| <span><a href="governance.html" style="color: #fcfcfc">Next »</a></span> |
| |
| </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> |
