spring-boot-admin
(以下简称SBA
)与Spring Boot、Spring cloud项目以starter得方式自动集成,包括Server端和Client端
SBA
监控包括应用的基本信息、logfile(在线实时浏览或者download)、JVM信息(线程信息、堆信息、非堆信息)、Web(API接口信息、最近100次API调用的信息)、应用中用户登录信息;监控指标很全面,但针对具体项目就要增加符合自己项目的内容了,比如如下两点:
自定义HttpTrace增加入参和出参
结果:
在spring-boot-admin
中HttpTrace显示的信息包括session、principal、request、response、timeTaken和timestamp,但session、principal对该项目完全无用,request是HttpTrace
的内部类显示信息包括:
private final String method;
private final URI uri;
//唯一可以扩展的地方
private final Map<String, List<String>> headers;
private final String remoteAddress;
response也是HttpTrace
的内部类:
private final int status;
//唯一可以扩展的地方
private final Map<String, List<String>> headers;
唯一缺少的就是请求的入参
和出参
,而Headers的信息是无用的。所以扩展HttpTrace显示请求中的入参
和出参
势在必行,大致的思路是:自定义Filter–>装饰模式转换成自定义的request和response对象,内部获取请求和相应内容–>HttpExchangeTracer创建HttpTrace对象–>InmemoryHttpTraceRepository保存100次请求的HttpTrace对象,供server端使用。由于Filter中使用的部分对象是先创建的所以我们先从需要的零部件开始
- 第一步:包装HttpServletRequest获取请求内容:
public class RequestWrapper extends HttpServletRequestWrapper {
//存放请求的消息体(先缓存一份)
private byte[] body;
//自定义输入流的包装类,将缓存数据再写入到流中
private ServletInputStreamWrapper wrapper;
private final Logger logger = LoggerFactory.getLogger(RequestWrapper.class);
public RequestWrapper(HttpServletRequest request) {
super(request);
try {
//使用Apache的commons-io工具从request中先读取数据
body = IOUtils.toByteArray(request.getInputStream());
} catch (IOException e) {
logger.error("从请求中获取请求参数出现异常:", e);
}
//将读取出来的内存再写入流中
wrapper = new ServletInputStreamWrapper(new ByteArrayInputStream(body));
}
//转换成String 供外部调用,并替换转义字符
public String body() {
return new String(body).replaceAll("[\n\t\r]","");
}
//将我们的自定义的流包装类返回,供系统调用 读取数据
@Override
public ServletInputStream getInputStream() throws IOException {
return this.wrapper;
}
//将我们的自定义的流包装类返回,供系统调用 读取数据
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(this.wrapper));
}
//从给定的输入流中读取数据
static final class ServletInputStreamWrapper extends ServletInputStream {
private InputStream inputStream;
public ServletInputStreamWrapper(InputStream inputStream) {
this.inputStream = inputStream;
}
@Override
public boolean isFinished() {
return true;
}
@Override
public boolean isReady() {
return false;
}
@Override
public void setReadListener(ReadListener listener) {
}
//读取缓存数据
@Override
public int read() throws IOException {
return this.inputStream.read();
}
public InputStream getInputStream() {
return inputStream;
}
public void