blob: 748712f95880008a0cf59eefcfeb9a76b4e23a4f [file] [log] [blame]
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../security/tls.html">
<link rel="next" href="microservice-invocation-chain.html">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
<title>应用性能监控 - Java Chassis 3 开发指南</title>
<link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#metrics" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../index.html" title="Java Chassis 3 开发指南" class="md-header__button md-logo" aria-label="Java Chassis 3 开发指南" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Java Chassis 3 开发指南
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
应用性能监控
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../index.html" title="Java Chassis 3 开发指南" class="md-nav__button md-logo" aria-label="Java Chassis 3 开发指南" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Java Chassis 3 开发指南
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../index.html" class="md-nav__link">
<span class="md-ellipsis">
概述
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../start/design.html" class="md-nav__link">
<span class="md-ellipsis">
Java Chassis设计参考
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../introduce3.x.x.html" class="md-nav__link">
<span class="md-ellipsis">
Java Chassis 3版本介绍
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
快速入门
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
快速入门
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../start/development-environment.html" class="md-nav__link">
<span class="md-ellipsis">
安装本地开发环境
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../start/first-sample.html" class="md-nav__link">
<span class="md-ellipsis">
开发第一个微服务应用
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/application-bmi.html" class="md-nav__link">
<span class="md-ellipsis">
BMI应用-使用服务治理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/application-porter.html" class="md-nav__link">
<span class="md-ellipsis">
PORTER应用-典型开发场景
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../build-provider/definition/service-definition.html" class="md-nav__link">
<span class="md-ellipsis">
微服务定义
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Spring Boot集成Java Chassis
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Spring Boot集成Java Chassis
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../spring-boot/introduction.html" class="md-nav__link">
<span class="md-ellipsis">
Spring Boot集成Java Chassis介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../spring-boot/diff-spring-mvc.html" class="md-nav__link">
<span class="md-ellipsis">
与Spring Web MVC开发习惯的差异
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
开发服务提供者
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
开发服务提供者
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../build-provider/basics.html" class="md-nav__link">
<span class="md-ellipsis">
基础概念
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/http-mapping.html" class="md-nav__link">
<span class="md-ellipsis">
HTTP参数映射参考
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/jaxrs.html" class="md-nav__link">
<span class="md-ellipsis">
用JAX-RS开发微服务
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/springmvc.html" class="md-nav__link">
<span class="md-ellipsis">
用SpringMVC开发微服务
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/transparent-rpc.html" class="md-nav__link">
<span class="md-ellipsis">
用透明RPC开发微服务
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/use-interface.html" class="md-nav__link">
<span class="md-ellipsis">
只发布interface的方法为服务接口
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/reactive.html" class="md-nav__link">
<span class="md-ellipsis">
异步处理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/context-param.html" class="md-nav__link">
<span class="md-ellipsis">
使用 Context 参数
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/multi-code.html" class="md-nav__link">
<span class="md-ellipsis">
多个返回值和错误码
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/swagger-annotation.html" class="md-nav__link">
<span class="md-ellipsis">
使用Swagger注解
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/interface-constraints.html" class="md-nav__link">
<span class="md-ellipsis">
接口定义和数据类型
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/listen-address-and-publish-address.html" class="md-nav__link">
<span class="md-ellipsis">
服务监听地址和发布地址
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/thread-pool.html" class="md-nav__link">
<span class="md-ellipsis">
线程池
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/event-listener.html" class="md-nav__link">
<span class="md-ellipsis">
服务启动事件
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/parameter-validator.html" class="md-nav__link">
<span class="md-ellipsis">
参数效验
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/bootup.html" class="md-nav__link">
<span class="md-ellipsis">
程序启动逻辑
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/ipv6-configuration.html" class="md-nav__link">
<span class="md-ellipsis">
IPV6配置和使用
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
开发服务消费者
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
开发服务消费者
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../build-consumer/basics.html" class="md-nav__link">
<span class="md-ellipsis">
基础概念
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-consumer/using-resttemplate.html" class="md-nav__link">
<span class="md-ellipsis">
Restful风格 - 使用 RestOperations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-consumer/develop-consumer-using-rpc.html" class="md-nav__link">
<span class="md-ellipsis">
RPC风格
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-consumer/invoker.html" class="md-nav__link">
<span class="md-ellipsis">
泛化调用
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
<label class="md-nav__link" for="__nav_9" id="__nav_9_label" tabindex="0">
<span class="md-ellipsis">
定制请求处理流程
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_9">
<span class="md-nav__icon md-icon"></span>
定制请求处理流程
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../references-handlers/intruduction.html" class="md-nav__link">
<span class="md-ellipsis">
处理链介绍
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
<span class="md-ellipsis">
通用功能开发
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
通用功能开发
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="local-develop-test.html" class="md-nav__link">
<span class="md-ellipsis">
本地开发和测试
</span>
</a>
</li>
<li class="md-nav__item">
<a href="upload-download.html" class="md-nav__link">
<span class="md-ellipsis">
文件上传下载
</span>
</a>
</li>
<li class="md-nav__item">
<a href="reactive.html" class="md-nav__link">
<span class="md-ellipsis">
Reactive
</span>
</a>
</li>
<li class="md-nav__item">
<a href="dnsconfig.html" class="md-nav__link">
<span class="md-ellipsis">
DNS自定义配置
</span>
</a>
</li>
<li class="md-nav__item">
<a href="proxy.html" class="md-nav__link">
<span class="md-ellipsis">
代理设置
</span>
</a>
</li>
<li class="md-nav__item">
<a href="report-framework-version.html" class="md-nav__link">
<span class="md-ellipsis">
框架上报版本号
</span>
</a>
</li>
<li class="md-nav__item">
<a href="cross-app-invocation.html" class="md-nav__link">
<span class="md-ellipsis">
跨应用调用
</span>
</a>
</li>
<li class="md-nav__item">
<a href="secret-field.html" class="md-nav__link">
<span class="md-ellipsis">
定制序列化和反序列化方法
</span>
</a>
</li>
<li class="md-nav__item">
<a href="context.html" class="md-nav__link">
<span class="md-ellipsis">
使用Context传递控制消息
</span>
</a>
</li>
<li class="md-nav__item">
<a href="produceprocess.html" class="md-nav__link">
<span class="md-ellipsis">
返回值序列化扩展
</span>
</a>
</li>
<li class="md-nav__item">
<a href="CORS.html" class="md-nav__link">
<span class="md-ellipsis">
跨域资源共享(CORS)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="AlarmEvent.html" class="md-nav__link">
<span class="md-ellipsis">
获取熔断与实例隔离告警事件信息
</span>
</a>
</li>
<li class="md-nav__item">
<a href="shutdown.html" class="md-nav__link">
<span class="md-ellipsis">
优雅停机
</span>
</a>
</li>
<li class="md-nav__item">
<a href="error-handling.html" class="md-nav__link">
<span class="md-ellipsis">
异常处理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="multienvironment.html" class="md-nav__link">
<span class="md-ellipsis">
微服务实例间多环境隔离
</span>
</a>
</li>
<li class="md-nav__item">
<a href="thread-model.html" class="md-nav__link">
<span class="md-ellipsis">
线程模型
</span>
</a>
</li>
<li class="md-nav__item">
<a href="config-logs.html" class="md-nav__link">
<span class="md-ellipsis">
配置日志
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
<label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="0">
<span class="md-ellipsis">
多样化的通信协议功能
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
多样化的通信协议功能
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../transports/introduction.html" class="md-nav__link">
<span class="md-ellipsis">
多协议介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/rest-over-vertx.html" class="md-nav__link">
<span class="md-ellipsis">
REST over HTTP(Vert.x)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/http2.html" class="md-nav__link">
<span class="md-ellipsis">
REST over HTTP2(Vert.x)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/rest-over-servlet-embedded.html" class="md-nav__link">
<span class="md-ellipsis">
REST over Servlet(Spring Boot Embedded)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/rest-over-servlet.html" class="md-nav__link">
<span class="md-ellipsis">
REST over Servlet(WAR)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transports/highway-rpc.html" class="md-nav__link">
<span class="md-ellipsis">
Highway
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
<label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="0">
<span class="md-ellipsis">
多样化的服务注册与发现功能
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_12">
<span class="md-nav__icon md-icon"></span>
多样化的服务注册与发现功能
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../registry/introduction.html" class="md-nav__link">
<span class="md-ellipsis">
注册发现介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/service-center.html" class="md-nav__link">
<span class="md-ellipsis">
使用Service Center
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/nacos.html" class="md-nav__link">
<span class="md-ellipsis">
使用Nacos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/zookeeper.html" class="md-nav__link">
<span class="md-ellipsis">
使用ZooKeeper
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/local-registry.html" class="md-nav__link">
<span class="md-ellipsis">
本地注册发现
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../registry/distributed.html" class="md-nav__link">
<span class="md-ellipsis">
去中心化注册发现
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" >
<label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="0">
<span class="md-ellipsis">
多样化的配置管理功能
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_13">
<span class="md-nav__icon md-icon"></span>
多样化的配置管理功能
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../config/general-config.html" class="md-nav__link">
<span class="md-ellipsis">
服务配置介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/read-config.html" class="md-nav__link">
<span class="md-ellipsis">
在程序中读取配置信息
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/kie.html" class="md-nav__link">
<span class="md-ellipsis">
使用Kie
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/nacos.html" class="md-nav__link">
<span class="md-ellipsis">
使用Nacos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/zookeeper.html" class="md-nav__link">
<span class="md-ellipsis">
使用Zookeeper
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/apollo.html" class="md-nav__link">
<span class="md-ellipsis">
使用Apollo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../config/cse1.html" class="md-nav__link">
<span class="md-ellipsis">
使用CSE1.0配置中心
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
<label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">
<span class="md-ellipsis">
服务治理功能参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_14">
<span class="md-nav__icon md-icon"></span>
服务治理功能参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../references-handlers/rule-governance.html" class="md-nav__link">
<span class="md-ellipsis">
流量特征治理
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/governance-best-practise.html" class="md-nav__link">
<span class="md-ellipsis">
流量特征治理最佳实践
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/loadbalance.html" class="md-nav__link">
<span class="md-ellipsis">
负载均衡
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/ratelimit.html" class="md-nav__link">
<span class="md-ellipsis">
限流
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/router.html" class="md-nav__link">
<span class="md-ellipsis">
灰度发布
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/fault-injection.html" class="md-nav__link">
<span class="md-ellipsis">
故障注入
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../references-handlers/fail-retry.html" class="md-nav__link">
<span class="md-ellipsis">
快速失败和重试
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_15" >
<label class="md-nav__link" for="__nav_15" id="__nav_15_label" tabindex="0">
<span class="md-ellipsis">
网关功能参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_15_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_15">
<span class="md-nav__icon md-icon"></span>
网关功能参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../edge/open-service.html" class="md-nav__link">
<span class="md-ellipsis">
介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../edge/by-servicecomb-sdk.html" class="md-nav__link">
<span class="md-ellipsis">
使用 Edge Service 做网关
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../edge/zuul.html" class="md-nav__link">
<span class="md-ellipsis">
使用 `zuul` 和 `spring cloud gateway` 做网关
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../edge/nginx.html" class="md-nav__link">
<span class="md-ellipsis">
nginx 网关简单介绍
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_16" >
<label class="md-nav__link" for="__nav_16" id="__nav_16_label" tabindex="0">
<span class="md-ellipsis">
安全特性参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_16_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_16">
<span class="md-nav__icon md-icon"></span>
安全特性参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../security/publickey.html" class="md-nav__link">
<span class="md-ellipsis">
微服务间认证
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../security/tls.html" class="md-nav__link">
<span class="md-ellipsis">
使用TLS通信
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_17" checked>
<label class="md-nav__link" for="__nav_17" id="__nav_17_label" tabindex="0">
<span class="md-ellipsis">
可观测功能参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_17_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_17">
<span class="md-nav__icon md-icon"></span>
可观测功能参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
应用性能监控
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="metrics.html" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
应用性能监控
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
使用方法
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#prometheus" class="md-nav__link">
<span class="md-ellipsis">
集成Prometheus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis">
配置说明
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_3" class="md-nav__link">
<span class="md-ellipsis">
统计指标含义说明
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_4" class="md-nav__link">
<span class="md-ellipsis">
开发者信息和高级课题
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="microservice-invocation-chain.html" class="md-nav__link">
<span class="md-ellipsis">
微服务调用链
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../build-provider/access-log-configuration.html" class="md-nav__link">
<span class="md-ellipsis">
Access Log配置
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_18" >
<label class="md-nav__link" for="__nav_18" id="__nav_18_label" tabindex="0">
<span class="md-ellipsis">
专题文章
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_18_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_18">
<span class="md-nav__icon md-icon"></span>
专题文章
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../featured-topics/features.html" class="md-nav__link">
<span class="md-ellipsis">
特性介绍
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/secrets.html" class="md-nav__link">
<span class="md-ellipsis">
技术解密
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/upgrading.html" class="md-nav__link">
<span class="md-ellipsis">
升级指导
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/compatibility.html" class="md-nav__link">
<span class="md-ellipsis">
兼容问题和兼容性策略
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../featured-topics/performance.html" class="md-nav__link">
<span class="md-ellipsis">
性能问题分析和调优
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_19" >
<label class="md-nav__link" for="__nav_19" id="__nav_19_label" tabindex="0">
<span class="md-ellipsis">
常用配置项参考
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_19_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_19">
<span class="md-nav__icon md-icon"></span>
常用配置项参考
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../config-reference/rest-transport-client.html" class="md-nav__link">
<span class="md-ellipsis">
REST Transport Client 配置项
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_20" >
<label class="md-nav__link" for="__nav_20" id="__nav_20_label" tabindex="0">
<span class="md-ellipsis">
常见问题
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_20_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_20">
<span class="md-nav__icon md-icon"></span>
常见问题
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../question-and-answer/faq.html" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../question-and-answer/question_answer.html" class="md-nav__link">
<span class="md-ellipsis">
Q & A
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../question-and-answer/interface-compatibility.html" class="md-nav__link">
<span class="md-ellipsis">
微服务接口兼容常见问题
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
使用方法
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#prometheus" class="md-nav__link">
<span class="md-ellipsis">
集成Prometheus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_2" class="md-nav__link">
<span class="md-ellipsis">
配置说明
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_3" class="md-nav__link">
<span class="md-ellipsis">
统计指标含义说明
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_4" class="md-nav__link">
<span class="md-ellipsis">
开发者信息和高级课题
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="metrics">应用性能监控(metrics)</h1>
<p>应用性能监控通过周期性的统计数据,帮助开发者分析业务性能瓶颈,在性能优化、故障定位的时候非常有帮助。应用性能监控的指标包括
请求各个环节的时延、线程池使用情况、连接池使用情况、CPU和网络使用情况等。</p>
<p>统计数据是一个周期性时效数据,只在统计周期内具有意义。可以选择通过 <code>REST</code> 接口查询实时的统计数据,也可以通过日志开关,将
统计数据输出到日志文件里面,帮助分析性能问题。</p>
<h2 id="_1">使用方法</h2>
<p>使用应用性能监控非常简单, 只需要在应用中包含相关的依赖包,通过配置项开启和关闭相关功能。 </p>
<ol>
<li>开启应用性能监控功能, 需要引入下面的依赖:<pre><code>```
&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;metrics-core&lt;/artifactId&gt;
&lt;/dependency&gt;
```
</code></pre>
</li>
</ol>
<p>通过在 <code>microservice.yaml</code> 中增加下面的配置项,就可以将性能统计数据输出到日志文件中。</p>
<pre><code> ```
servicecomb:
metrics:
window_time: 60000
invocation:
latencyDistribution: 0,1,10,100,1000
Consumer.invocation.slow:
enabled: true
msTime: 1000
Provider.invocation.slow:
enabled: true
msTime: 1000
publisher.defaultLog:
enabled: true
endpoints.client.detail.enabled: true
```
</code></pre>
<p>上述配置开启了慢调用检测,如果存在慢调用,则会立即输出相应日志:</p>
<pre><code> ```
2019-04-02 23:01:09,103\[WARN]\[pool-7-thread-74]\[5ca37935c00ff2c7-350076] - slow(40 ms) invocation, CONSUMER highway perf1.impl.syncQuery
http method: GET
url : /v1/syncQuery/{id}/
server : highway://192.168.0.152:7070?login=true
status code: 200
total : 50.760 ms
prepare : 0.0 ms
handlers request : 0.0 ms
client filters request : 0.0 ms
send request : 0.5 ms
get connection : 0.0 ms
write to buf : 0.5 ms
wait response : 50.727 ms
wake consumer : 0.23 ms
client filters response: 0.2 ms
handlers response : 0.0 ms (SlowInvocationLogger.java:121)
```
</code></pre>
<p>其中 5ca37935c00ff2c7-350076 是 <code>${traceId}-${invocationId}</code> 的结构,在log4j2 或 logback 的输出格式中通过 %marker 引用。</p>
<p>也可以通过 <code>REST</code> 接口查询性能统数据。使用浏览器访问http://ip:port/metrics 即可,将会得到类似下面格式的json数据:</p>
<pre><code> ```
{
"servicecomb.vertx.endpoints(address=192.168.0.124:7070,statistic=connectCount,type=client)": 0.0,
"servicecomb.vertx.endpoints(address=192.168.0.124:7070,statistic=disconnectCount,type=client)": 0.0,
"servicecomb.vertx.endpoints(address=192.168.0.124:7070,statistic=connections,type=client)": 1.0,
"servicecomb.vertx.endpoints(address=192.168.0.124:7070,statistic=bytesRead,type=client)": 508011.0,
"servicecomb.vertx.endpoints(address=192.168.0.124:7070,statistic=bytesWritten,type=client)": 542163.0,
"servicecomb.vertx.endpoints(address=192.168.0.124:7070,statistic=queueCount,type=client)": 0.0,
"servicecomb.vertx.endpoints(address=0.0.0.0:7070,statistic=connectCount,type=server)": 0.0,
"servicecomb.vertx.endpoints(address=0.0.0.0:7070,statistic=disconnectCount,type=server)": 0.0,
"servicecomb.vertx.endpoints(address=0.0.0.0:7070,statistic=connections,type=server)": 1.0,
"servicecomb.vertx.endpoints(address=0.0.0.0:7070,statistic=bytesRead,type=server)": 542163.0
... ...
}
```
</code></pre>
<h2 id="prometheus">集成Prometheus</h2>
<p><a href="https://prometheus.io/">Prometheus</a> (普罗米修斯)是一个名字非常酷的开源监控系统。</p>
<p>它支持多维度的指标数据模型,服务端通过HTTP协议定时拉取数据后,通过灵活的查询语言,实现监控的目的。</p>
<p>servicecomb的应用性能监控功能支持对接Prometheus,首先需要在您的业务项目中加入如下依赖:</p>
<pre><code> ```
&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;metrics-prometheus&lt;/artifactId&gt;
&lt;/dependency&gt;
```
</code></pre>
<p>然后在 microservice.yaml 中增加下面的配置项:</p>
<pre><code> ```
servicecomb:
metrics:
prometheus:
address: ${ip}:${port}
```
</code></pre>
<p>该配置项是设置普罗米修斯框架监听的端口,您只需使用浏览器访问对应的ip地址加该端口即http://ip:port/metrics 就可以获得如下格式的监控数据:</p>
<pre><code> ```
# HELP ServiceComb_Metrics ServiceComb Metrics
# TYPE ServiceComb_Metrics untyped
threadpool_rejectedCount{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} 0.0
threadpool_rejectedCount{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} 0.0
threadpool_taskCount{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} 0.0
threadpool_currentThreadsBusy{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} NaN
threadpool_taskCount{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} 0.0
threadpool_currentThreadsBusy{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} NaN
threadpool_poolSize{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} NaN
threadpool_poolSize{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} NaN
threadpool_completedTaskCount{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="connectCount",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="disconnectCount",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="connections",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="bytesRead",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="bytesWritten",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="requests",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="latency",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:7070",statistic="rejectByConnectionLimit",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="connectCount",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="disconnectCount",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="connections",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="bytesRead",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="bytesWritten",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="requests",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="latency",type="server",} 0.0
servicecomb_vertx_endpoints{appId="springmvctest",address="0.0.0.0:8080",statistic="rejectByConnectionLimit",type="server",} 0.0
threadpool_completedTaskCount{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} 0.0
threadpool_maxThreads{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} NaN
threadpool_maxThreads{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} NaN
threadpool_queueSize{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} NaN
threadpool_queueSize{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} NaN
threadpool_corePoolSize{appId="springmvctest",id="cse.executor.groupThreadPool-group0",} NaN
threadpool_corePoolSize{appId="springmvctest",id="cse.executor.groupThreadPool-group1",} NaN
```
</code></pre>
<p>注:默认端口是9696,您也可以根据实际业务要求进行修改。</p>
<h2 id="_2">配置说明</h2>
<div class="metrics-cfg"></div>
<table>
<thead>
<tr>
<th style="text-align: left;">配置项</th>
<th style="text-align: left;">默认值</th>
<th style="text-align: left;">含义</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">servicecomb.metrics.window_time</td>
<td style="text-align: left;">60000</td>
<td style="text-align: left;">统计周期,单位为毫秒<br>TPS、时延等等周期性的数据,每周期更新一次,在周期内获取到的值,实际是上一周期的值</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics<br>.invocation.latencyDistribution</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">时延分布时间段定义,单位为毫秒<br>例如:0,1,10,100,1000<br>表示定义了下列时延段[0, 1),[1, 10),[10, 100),[100, 1000),[1000, )</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics<br>.Consumer.invocation.slow.enabled</td>
<td style="text-align: left;">false</td>
<td style="text-align: left;">是否开启Consumer端的慢调用检测<br>通过增加后缀.${service}.${schema}.${operation},可以支持4级优先级定义</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics<br>.Consumer.invocation.slow.msTime</td>
<td style="text-align: left;">1000</td>
<td style="text-align: left;">时延超过配置值,则会立即输出日志,记录本次调用的stage耗时信息<br>通过增加后缀.${service}.${schema}.${operation},可以支持4级优先级定义</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics<br>.Provider.invocation.slow.enabled</td>
<td style="text-align: left;">false</td>
<td style="text-align: left;">是否开启Provide端的慢调用检测<br>通过增加后缀.${service}.${schema}.${operation},可以支持4级优先级定义</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics<br>.Provider.invocation.slow.msTime</td>
<td style="text-align: left;">1000</td>
<td style="text-align: left;">时延超过配置值,则会立即输出日志,记录本次调用的stage耗时信息<br>通过增加后缀.${service}.${schema}.${operation},可以支持4级优先级定义</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics<br>.prometheus.address</td>
<td style="text-align: left;">0.0.0.0:9696</td>
<td style="text-align: left;">prometheus监听地址</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics.publisher.defaultLog<br>.enabled</td>
<td style="text-align: left;">false</td>
<td style="text-align: left;">是否输出默认的统计日志</td>
</tr>
<tr>
<td style="text-align: left;">servicecomb.metrics.publisher.defaultLog<br>.endpoints.client.detail.enabled</td>
<td style="text-align: left;">false</td>
<td style="text-align: left;">是否输出每一条client endpoint统计日志,因为跟目标的ip:port数有关,可能会有很多数据,所以默认不输出</td>
</tr>
</tbody>
</table>
<h2 id="_3">统计指标含义说明</h2>
<ul>
<li>CPU 统计信息</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="2">os</td>
<td rowspan="2">type</td>
<td>cpu</td>
<td>当前周期内系统CPU使用率,Solaris模式</td>
</tr>
<tr>
<td>processCpu</td>
<td>当前周期内微服务进程CPU使用率,IRIX模式<br>
processCpu除以cpu近似等于系统CPU数</td>
</tr>
</table>
<ul>
<li>网络统计信息</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="6">os</td>
<td>type</td>
<td>net</td>
<td></td>
</tr>
<tr>
<td rowspan="4">statistic</td>
<td>send</td>
<td>当前周期内平均每秒发送的字节数(Bps)</td>
</tr>
<tr>
<td>receive</td>
<td>当前周期内平均每秒接收的字节数(Bps)</td>
</tr>
<tr>
<td>sendPackets</td>
<td>当前周期内平均每秒发送的包数(pps)</td>
</tr>
<tr>
<td>receivePackets</td>
<td>当前周期内平均每秒接收的包数(pps)</td>
</tr>
<tr>
<td>interface</td>
<td></td>
<td>网卡设备名</td>
</tr>
</table>
<ul>
<li>vertx client endpoints 统计信息 </li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="8">servicecomb<br>.vertx<br>.endpoints</td>
<td>type</td>
<td>client</td>
<td></td>
</tr>
<tr>
<td>address</td>
<td>${ip}:${port}</td>
<td>服务端的ip:port</td>
</tr>
<tr>
<td rowspan="6">statistic</td>
<td>connectCount</td>
<td>当前周期内共发起多少次连接</td>
</tr>
<tr>
<td>disconnectCount</td>
<td>当前周期内断连的次数</td>
</tr>
<tr>
<td>queueCount</td>
<td>http连接池中正在等待获取连接的请求数</td>
</tr>
<tr>
<td>connections</td>
<td>当前时刻的连接数</td>
</tr>
<tr>
<td>bytesRead</td>
<td>当前周期内平均每秒接收的字节数(Bps)<br>
业务层的统计,相对从网卡获取的数据,这里的数据不包括包头的大小<br>
对于http消息,不包括http header大小</td>
</tr>
<tr>
<td>bytesWritten</td>
<td>当前周期内平均每秒发送的字节数(Bps)<br>
业务层的统计,相对从网卡获取的数据,这里的数据不包括包头的大小<br>
对于http消息,不包括http header大小</td>
</tr>
</table>
<ul>
<li>vertx server endpoints 统计信息</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="8">servicecomb<br>.vertx<br>.endpoints</td>
<td>type</td>
<td>server</td>
<td></td>
</tr>
<tr>
<td>address</td>
<td>${ip}:${port}</td>
<td>监听的ip:port</td>
</tr>
<tr>
<td rowspan="6">statistic</td>
<td>connectCount</td>
<td>当前周期内共接入多少次连接</td>
</tr>
<tr>
<td>disconnectCount</td>
<td>当前周期内断连的次数</td>
</tr>
<tr>
<td>rejectByConnectionLimit</td>
<td>当前周期内因超出连接数限制而主动断连的次数</td>
</tr>
<tr>
<td>connections</td>
<td>当前时刻的连接数</td>
</tr>
<tr>
<td>bytesRead</td>
<td>当前周期内平均每秒发送的字节数(Bps)<br>
业务层的统计,相对从网卡获取的数据,这里的数据不包括包头的大小<br>
对于http消息,不包括http header大小</td>
</tr>
<tr>
<td>bytesWritten</td>
<td>当前周期内平均每秒接收的字节数(Bps)<br>
业务层的统计,相对从网卡获取的数据,这里的数据不包括包头的大小<br>
对于http消息,不包括http header大小</td>
</tr>
</table>
<ul>
<li>时延分布概览</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="11">servicecomb<br>.invocation</td>
<td>role</td>
<td>CONSUMER、PRODUCER、EDGE</td>
<td>是CONSUMER、PRODUCER还是EDGE端的统计</td>
</tr>
<tr>
<td>operation</td>
<td>${microserviceName}<br>.${schemaId}<br>.${operationName}</td>
<td>调用的方法名</td>
</tr>
<tr>
<td>transport</td>
<td>highway或rest</td>
<td>调用是在哪个传输通道上发生的</td>
</tr>
<tr>
<td>status</td>
<td>http status code</td>
<td></td>
</tr>
<tr>
<td>type</td>
<td>latencyDistribution</td>
<td>调用时延分布</td>
</tr>
<tr>
<td>scope</td>
<td>[${min}, ${max})</td>
<td>当前周期内调用时延大于等于min,小于max的次数<br>
[${min},)表示max为无限大</td>
</tr>
</table>
<ul>
<li>consumer 详细时延分布</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="19">servicecomb<br>.invocation</td>
<td>role</td>
<td>CONSUMER</td>
<td>CONSUMER端的统计</td>
</tr>
<tr>
<td>operation</td>
<td>${microserviceName}<br>.${schemaId}<br>.${operationName}</td>
<td>调用的方法名</td>
</tr>
<tr>
<td>transport</td>
<td>highway或rest</td>
<td>调用是在哪个传输通道上发生的</td>
</tr>
<tr>
<td>status</td>
<td>http status code</td>
<td></td>
</tr>
<tr>
<td>type</td>
<td>stage</td>
<td>stage时延</td>
</tr>
<tr>
<td rowspan="11">stage</td>
<td>total</td>
<td>全流程</td>
</tr>
<tr>
<td>prepare</td>
<td>初始化</td>
</tr>
<tr>
<td>handlers_request</td>
<td>handler链请求流程</td>
</tr>
<tr>
<td>client_filters_request</td>
<td>http client filter链请求流程<br>
只有走rest transport才有本阶段</td>
</tr>
<tr>
<td>consumer_send_request</td>
<td>发送请求阶段,包括consumer_get_connection和consumer_write_to_buf</td>
</tr>
<tr>
<td>consumer_get_connection</td>
<td>从连接池获取连接</td>
</tr>
<tr>
<td>consumer_write_to_buf</td>
<td>向网络缓冲区写数据</td>
</tr>
<tr>
<td>consumer_wait_response</td>
<td>等待服务端应答</td>
</tr>
<tr>
<td>consumer_wake_consumer</td>
<td>同步流程中,收到应答后,从唤醒等待线程,到等待线程开始处理应答的耗时</td>
</tr>
<tr>
<td>client_filters_response</td>
<td>http client filter链应答流程</td>
</tr>
<tr>
<td>handlers_response</td>
<td>handler链应答流程</td>
</tr>
<tr>
<td rowspan="3">statistic</td>
<td>count</td>
<td>平均每秒调用次数,即TPS<br>
count=统计周期内的调用次数/周期(秒)</td>
</tr>
<tr>
<td>totalTime</td>
<td>单位为秒<br>
totalTime=当前周期内的调用耗时总时长/周期(秒)<br>
totalTime除以count即可得到平均时延</td>
</tr>
<tr>
<td>max</td>
<td>单位为秒<br>
当前周期内最大耗时</td>
</tr>
</table>
<ul>
<li>provider 详细时延分布</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="17">servicecomb<br>.invocation</td>
<td>role</td>
<td>PRODUCER</td>
<td>PRODUCER端的统计</td>
</tr>
<tr>
<td>operation</td>
<td>${microserviceName}<br>.${schemaId}<br>.${operationName}</td>
<td>调用的方法名</td>
</tr>
<tr>
<td>transport</td>
<td>highway或rest</td>
<td>调用是在哪个传输通道上发生的</td>
</tr>
<tr>
<td>status</td>
<td>http status code</td>
<td></td>
</tr>
<tr>
<td>type</td>
<td>stage</td>
<td>stage时延</td>
</tr>
<tr>
<td rowspan="9">stage</td>
<td>total</td>
<td>全流程</td>
</tr>
<tr>
<td>prepare</td>
<td>初始化</td>
</tr>
<tr>
<td>queue</td>
<td>仅在使用线程池时有意义<br>
表示调用在线程池中排队的时长</td>
</tr>
<tr>
<td>server_filters_request</td>
<td>http server filter链请求流程<br>
只有走rest transport才有本阶段</td>
</tr>
<tr>
<td>handlers_request</td>
<td>handler链请求流程</td>
</tr>
<tr>
<td>execution</td>
<td>业务方法</td>
</tr>
<tr>
<td>handlers_response</td>
<td>handler链应答流程</td>
</tr>
<tr>
<td>server_filters_response</td>
<td>http server filter链应答流程</td>
</tr>
<tr>
<td>producer_send_response</td>
<td>发送应答</td>
</tr>
<tr>
<td rowspan="3">statistic</td>
<td>count</td>
<td>平均每秒调用次数,即TPS<br>
count=统计周期内的调用次数/周期(秒)</td>
</tr>
<tr>
<td>totalTime</td>
<td>单位为秒<br>
totalTime=当前周期内的调用耗时总时长/周期(秒)<br>
totalTime除以count即可得到平均时延</td>
</tr>
<tr>
<td>max</td>
<td>单位为秒<br>
当前周期内最大耗时</td>
</tr>
</table>
<ul>
<li>edge service 详细时延分布</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td rowspan="23">servicecomb<br>.invocation</td>
<td>role</td>
<td>EDGE</td>
<td>EDGE的统计</td>
</tr>
<tr>
<td>operation</td>
<td>${microserviceName}<br>.${schemaId}<br>.${operationName}</td>
<td>调用的方法名</td>
</tr>
<tr>
<td>transport</td>
<td>highway或rest</td>
<td>调用是在哪个传输通道上发生的</td>
</tr>
<tr>
<td>status</td>
<td>http status code</td>
<td></td>
</tr>
<tr>
<td>type</td>
<td>stage</td>
<td>stage时延</td>
</tr>
<tr>
<td rowspan="15">stage</td>
<td>total</td>
<td>全流程</td>
</tr>
<tr>
<td>prepare</td>
<td>初始化</td>
</tr>
<tr>
<td>queue</td>
<td>仅在使用线程池时有意义<br>
表示调用在线程池中排队的时长</td>
</tr>
<tr>
<td>server_filters_request</td>
<td>http server filter链请求流程</td>
</tr>
<tr>
<td>handlers_request</td>
<td>handler链请求流程</td>
</tr>
<tr>
<td>client_filters_request</td>
<td>http client filter链请求流程</td>
</tr>
<tr>
<td>consumer_send_request</td>
<td>发送请求阶段,包括consumer_get_connection和consumer_write_to_buf</td>
</tr>
<tr>
<td>consumer_get_connection</td>
<td>从连接池获取连接</td>
</tr>
<tr>
<td>consumer_write_to_buf</td>
<td>向网络缓冲区写数据</td>
</tr>
<tr>
<td>consumer_wait_response</td>
<td>等待服务端应答</td>
</tr>
<tr>
<td>consumer_wake_consumer</td>
<td>同步流程中,收到应答后,从唤醒等待线程,到等待线程开始处理应答的耗时</td>
</tr>
<tr>
<td>client_filters_response</td>
<td>http client filter链应答流程</td>
</tr>
<tr>
<td>handlers_response</td>
<td>handler链应答流程</td>
</tr>
<tr>
<td>server_filters_response</td>
<td>http server filter链应答流程</td>
</tr>
<tr>
<td>producer_send_response</td>
<td>发送应答</td>
</tr>
<tr>
<td rowspan="3">statistic</td>
<td>count</td>
<td>平均每秒调用次数,即TPS<br>
count=统计周期内的调用次数/周期(秒)</td>
</tr>
<tr>
<td>totalTime</td>
<td>单位为秒<br>
totalTime=当前周期内的调用耗时总时长/周期(秒)<br>
totalTime除以count即可得到平均时延</td>
</tr>
<tr>
<td>max</td>
<td>单位为秒<br>
当前周期内最大耗时</td>
</tr>
</table>
<ul>
<li>线程池信息</li>
</ul>
<table class="metrics-table">
<tr>
<th>Name</th>
<th>Tag keys</th>
<th>Tag values</th>
<th>含义</th>
</tr>
<tr>
<td>threadpool.corePoolSize </td>
<td rowspan="8">id</td>
<td rowspan="8">${threadPoolName}</td>
<td>最小线程数</td>
</tr>
<tr>
<td>threadpool.maxThreads </td>
<td>最大允许的线程数</td>
</tr>
<tr>
<td>threadpool.poolSize </td>
<td>当前实际线程数</td>
</tr>
<tr>
<td>threadpool.currentThreadsBusy </td>
<td>当前的活动线程数,即当前正在执行的任务数</td>
</tr>
<tr>
<td>threadpool.queueSize </td>
<td>当前正在排队的任务数</td>
</tr>
<tr>
<td>threadpool.rejectedCount </td>
<td>当前周期内平均每秒被拒绝的任务数</td>
</tr>
<tr>
<td>threadpool.taskCount</td>
<td>统计周期内平均每秒提交的任务数<br>taskCount=(completed + queue + active)/周期(秒)</td>
</tr>
<tr>
<td>threadpool.completedTaskCount </td>
<td>统计周期内平均每秒完成的任务数<br>completedTaskCount=completed/周期(秒)</td>
</tr>
</table>
<h2 id="_4">开发者信息和高级课题</h2>
<ul>
<li>实现原理</li>
</ul>
<p><img alt="" src="../assets/metrics/logicDiagram.png" /></p>
<pre><code>1. 基于[netflix spectator](https://github.com/Netflix/spectator)
2. Foundation-metrics通过SPI机制加载所有MetricsInitializer实现,实现者可以通过MetricsInitializer中的getOrder规划执行顺序,order数字越小,越先执行。
3. Metrics-core实现3类MetricsInitializer:
1. DefaultRegistryInitializer: 实例化并注册spectator-reg-servo,设置较小的order,保证比下面2类MetricsInitializer先执行
2. Meters Initializer: 实现TPS、时延、线程池、jvm资源等等数据的统计
3. Publisher: 输出统计结果,内置了日志输出,以及通过RESTful接口输出
4. Metrics-prometheus提供与prometheus对接的能力
</code></pre>
<ul>
<li>业务定制</li>
</ul>
<p>因为ServiceComb已经初始化了servo的registry,所以业务不必再创建registry。实现MetricsInitializer接口,定
义业务级的Meters,或实现定制的Publisher,再通过SPI机制声明自己的实现即可。</p>
<p>1.Meters</p>
<pre><code>创建Meters能力均由spectator提供,可查阅[netflix spectator](https://github.com/Netflix/spectator)文档
</code></pre>
<p>2.Publisher</p>
<pre><code>周期性输出的场景,比如日志场景,通过eventBus订阅org.apache.servicecomb.foundation.metrics.PolledEvent,PolledEvent.getMeters()即是本周期的统计结果
非周期性输出的场景,比如通过RESTful接口访问,通过globalRegistry.iterator()即可得到本周期的统计结果
</code></pre>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.081f42fc.min.js"></script>
</body>
</html>