ElasticSearch QueryCache漫谈

前言

这些天在做ES调优，因为之前更多的是考虑ES的架构和可运维性，并没有过多关注query调优这块。今天一查Query Cache相关的内容，发现是少之又少。于是自己深入Dig了下，总算是有所了解。

Query Cache是什么

首先 ES Query Cache是实例级别的，作用域是Node实例。其次，ES Query Cache 本质是缓存Query里面的子Query的查询结果。他是按照子Query来确定是否被Cache。 Cache的结果是DocIdSet,可以简单理解为布隆过滤器。

如何判定一个子Query是否会被Cache住

ES已经比较智能，你可以写一个非常复杂的Query,但是他会自动挑选里面某一部分进行Cache.那么我们如何知道一个子Query是否会被Cache住呢？遗憾的是现在没有文档做罗列，不过我们根据LRUQueryCache实现类，观察到如下逻辑：

1. 检查这个Query自身提供的isCacheable方法，如果可以的话继续做下一步判定
2. 判定对应的Segment是否支持Cache,如果ok,执行缓存动作,进一步判定
3. 执行QueryCachePolicy相应的策略方法。该方法做了一些枚举，比如TermQuery,MatchAllDocsQuery等是不缓存的，然后会根据使用频次来确定是否加入到缓存。

所以，我们可以简单的找到对应的Query实现，查看相应的isCacheable方法。 比如BinaryDocValuesRangeQuery，也就是Range查询（Int,Double等），对应的isCache方法如下：

public boolean isCacheable(LeafReaderContext ctx) {
                return DocValues.isCacheable(ctx, fieldName);
            }

  /**
   * Returns {@code true} if the specified docvalues fields have not been updated
   */
  public static boolean isCacheable(LeafReaderContext ctx, String... fields) {
    for (String field : fields) {
      FieldInfo fi = ctx.reader().getFieldInfos().fieldInfo(field);
      if (fi != null && fi.getDocValuesGen() > -1)
        return false;
    }
    return true;
  }

从上面代码可以知道，通常简单的DocValues字段，做Range查询都是支持Cache的。那么TermRangeQuery呢？其实也是可以cache的。对应的代码就更简单了：

public boolean isCacheable(LeafReaderContext ctx) {
        return true;
      }

我们继续看，termQuery呢？打开TermQuery你会发现他的isCacheable也是返回true，但是因为在第三步的的QueryCache策略里的shouldNeverCache方法中被判定为不能缓存，所以不会进行缓存。

一般而言QueryCache只会缓存细粒度的结果，比如BoolQuery之类肯定是不会缓存的。

常见的一些配置

首先，是缓存肯定会做缓存条数和内存的限制。内存限制通过参数：

indices.queries.cache.size = 10%

控制。 条数则是通过参数：

indices.queries.cache.count=1000

这里的cache count指是query的条数。但是在node stats APi 你并不能看到这个值的情况，你会看到的两个让人迷惑的指标：

        cache_count
        cache_size

前面我们提及，虽然我们cache一个子query,但其实因为这个query对应的segment是很多的，所以系统需要缓存多个segment查询后对应的bitset结果。于是我们有了公式:

cacheSize = 当前符合cache条件的segment * 符合cache条件的子query数量

也就是一个子query会缓存多份数据，每份数据来源于相应的segment。 cacheCount 则是历史所有发生的cache行为。

一个符合条件的子query作用于某个segment时，这个segment如果满足以下任一条件，则会被cache住:

1. 记录数> 10000
2. 记录数占所在索引总文档数比例 > 3%

通常我们认为MultiTermQuery，MultiTermQueryConstantScoreWrapper，TermInSetQuery，PointQuery创建过程是比较重的，所以在缓存策略里，他们访问的较少也会被缓存。

Query Cache索引结构

有一个ES Node级别的Cache,该Cache你可以理解为一个Map，该Map又会针对每个Segment有一个LeafCache,LeaCache的key是query,value则是DocIdSet。这样是不是清晰了很多。添加cache的时候，会注册一个回调，如果Segment被合并或者删除，那么就会被移除缓存。

过期策略

每次新添加一个cache都会检测下是否需要过期一些query。如果Segment被合并或者删除，那么也会清理掉对应的缓存。

UsageTrackingQueryCachingPolicy

在ES里，QueryCacheingPolicy的默认实现是UsageTrackingQueryCachingPolicy。该Policy的基本思路是根据使用频率决定是否缓存。对于构建成本较高的索引，比如MultiTermQuery，MultiTermQueryConstantScoreWrapper，TermInSetQuery，PointQuery 最近使用超过2次(维护了一个256大小的环状使用历史记录)则会被索引。而且其他的一些query则需要5次。 同时，UsageTrackingQueryCachingPolicy 还维护了一个不使用cache的Query列表，比如TermQuery，MatchAllDocsQuery，MatchNoDocsQuery，以及子query为空的BooleanQuery，DisjunctionMaxQuery。