es的执行命令日志输出

1. 说明

最近项目对接es，使用的客户端为：

            <dependency>
                <groupId>co.elastic.clients</groupId>
                <artifactId>elasticsearch-java</artifactId>
				<version>8.11.4</version>
		    </dependency>
1
2
3
4
5

使用过程中希望能够在日志中打印具体执行的es命令，便于问题排查，但没有找到对应的功能，因此花了些时间实现了一版方案，在此记录下来。

2.日志输出

通过日志配置，将相关类的日志级别修改为debug，可以打印部分信息。

方法1：

在logback.xml中添加

<logger name="org.elasticsearch.client.RestClient" level="DEBUG"/>
1

此时执行命令，输出为：

DEBUG org.elasticsearch.client.RestClient [RequestLogger.java:58] -  request [POST http://127.0.0.1:37950/test_index/_search?typed_keys=true] returned [HTTP/1.1 200 OK]
1

此种方式能输出url信息和返回状态，但不包括请求的body信息。

方法2：

在logback.xml中添加

<logger name="org.apache.http.wire" level="DEBUG"/>
1

此处日志会更底层，打印实际Http请求的write方法，日志输出的示例为：

此种方式输出了完整的信息，可用于问题定位，但信息看起来有点费劲。

3. 通过切面输出日志

通过跟进实际的代码，发现在执行方法 co.elastic.clients.transport.ElasticsearchTransportBase#performRequest 时，第一次生成了明文的执行命令：

奈何没有很好的办法直接获取对应的请求信息，于是退而求其次，构造获取request的body的信息，最终选择 co.elastic.clients.elasticsearch.ElasticsearchClient#search

最终的实现如下：

@Slf4j
@Aspect
@Component
public class ElasticsearchClientLogAspect {

    @Around("execution(* co.elastic.clients.elasticsearch.ElasticsearchClient.search(..))")
    public Object logPerformRequest(ProceedingJoinPoint joinPoint) throws Throwable {
        for (Object arg : joinPoint.getArgs()) {
            if(arg instanceof SearchRequest){
                SearchRequest request = (SearchRequest) arg;
                logSearchRequest(request);
            }
        }

        Object result = joinPoint.proceed();
        return result;
    }

    private static void logSearchRequest(SearchRequest request) {
        try {
            JsonEndpoint<SearchRequest, SearchResponse, ErrorResponse> endpoint =
                    (JsonEndpoint<SearchRequest, SearchResponse, ErrorResponse>) SearchRequest._ENDPOINT;
            Object body = endpoint.body(request);
            log.info(body.toString());
        } catch (Exception e) {
            log.error("打印es请求日志异常" , e);
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29