solr-in-action-ch4-Configuring Solr

Solr主要的三个XML配置文件：

solr.xml: solr 日志、shard、solrcould等配置

solrconfig.xml: 某个solr core的配置

schema.xml：某个solr core的索引结构的配置，包括field 和field类型

这一章主要介绍solrconfig.xml, 某个solr core的配置。

1、Core的发现过程

扫描启动某个core的过程是这样的：Solr web服务器根据配置的java System Property(solr.solr.home),找到solr的home路径，然后solr会扫描这个home路径下面的包含有core.properties的子目录。core.properties定义了core的名称、以及其他一些配置信息（非必须，一般现在都在之类仅仅定义name=your_collection_name），其他一些参数如下左图。一旦solr发现了这个core之后就会到这个目录下面的conf目录下找到solrconfig.xml来开始初始化这个core。

Overview of solrconfig.xml

<!--solrconfig.xml中的配置项主要分以下几大块：
     1.依赖的lucene版本配置，这决定了你创建的Lucene索引结构，因为Lucene各版本之间的索引结构并不是完全兼容的，这个需要引起你的注意。
     2.索引创建相关的配置，如索引目录，IndexWriterConfig类中的相关配置(它决定了你的索引创建性能)
     3.solrconfig.xml中依赖的外部jar包加载路径配置
     4.JMX相关配置
     5.缓存相关配置，缓存包括过滤器缓存，查询结果集缓存，Document缓存，以及自定义缓存等等
     6.updateHandler配置即索引更新操作相关配置
     7.RequestHandler相关配置，即接收客户端HTTP请求的处理类配置
     8.查询组件配置如HightLight，SpellChecker等等
     9.ResponseWriter配置即响应数据转换器相关配置，决定了响应数据是以什么样格式返回给客户端的。
     10.自定义ValueSourceParser配置，用来干预Document的权重、评分，排序
-->
< config >
    <!--依赖的lucene 版本-->
    < luceneMatchVersion >4.7</ luceneMatchVersion >

    <!--Solr如何去加载solr plugins(Solr插件)依赖的jar包-->
    < lib  dir = "../../../contrib/extraction/lib"  regex = ".*\.jar" />

    <!--用来指定一个solr的索引数据目录，solr创建的索引会存放在data\index目录下，默认dataDir是相对于当前core目录(如果solr_home下存在core的话)，
    如果solr_home下不存在core的话，那dataDir默认就是相对于solr_home啦，不过一般dataDir都在core.properties下配置。-->
    < dataDir >${solr.data.dir:}</ dataDir >

    <!--solr 索引存储方案-->
    < directoryFactory  name = "DirectoryFactory” class=" ..."/>

    <!--索引相关配置-->
    < indexConfig >...</ indexConfig >

    <!--这个配置是用来在Solr中启用JMX-->
    < jmx />

    <!--指定索引更新操作处理类-->
    < updateHandler  class = "solr.DirectUpdateHandler2" >
        < updateLog >...</ updateLog >
        < autoCommit >...</ autoCommit >
    </ updateHandler >

    <!--索引查询相关的配置项-->
    < query >
        <!--缓存相关-->
        < filterCache  ... />
        < queryResultCache  ... />
        < documentCache  ... />
        <!-- QuerySenderListener用来监听查询发送过程，即你可以在Query请求发送之前做一些处理，比如追加一些请求参数-->
        < listener  event = "newSearcher"  class = "solr.QuerySenderListener" >
            < arr  name = "queries" >...</ arr >
        </ listener >
        < listener  event = "firstSearcher"  class = "solr.QuerySenderListener" >
            < arr  name = "queries" >...</ arr >
        </ listener >
    </ query >

    <!--request分发器-->
    < requestDispatcher  handleSelect = "false" >
        < requestParsers  ... />
        < httpCaching  never304 = "true" />
    </ requestDispatcher >

    <!--Request handler to process queries using a chain of search components (see section 4.2.4).-->
    < requestHandler  name = "/select"  class = "solr.SearchHandler" >
        < lst  name = "defaults" >...</ lst >
        < lst  name = "appends" >...</ lst >
        < lst  name = "invariants" >...</ lst >
        < arr  name = "components" >...</ arr >
        < arr  name = "last-components" >...</ arr >
    </ requestHandler >

    <!--Example search component for doing spell correction on queries.-->
    < searchComponent  name = "spellcheck"
                     class = "solr.SpellCheckComponent" >...
    </ searchComponent >

    <!--Extends indexing behavior using update-request processors, such as language detection.-->
    < updateRequestProcessorChain  name = "langid" >...
    </ updateRequestProcessorChain >

    <!--Formats the response as JSON.-->
    < queryResponseWriter  name = "json"
                         class = "solr.JSONResponseWriter" >...
    </ queryResponseWriter >

    <!--自定义ValueSourceParser配置，用来干预Document的权重、评分，排序-->
    < valueSourceParser  name = "myfunc"  ... />
    <!--transforms 转换器 ，对doc进行转换-->

    < transformer  name = "db"
                 class = "com.mycompany.LoadFromDatabaseTransformer" >
        ...
    </ transformer >
</ config >

solrconfig.xml中有大量类似<arr> <list> <str> <int>这样的自定义标签，下面做个统一的说明：

arr:即array的缩写，表示一个数组，name即表示这个数组参数的变量名

lst即list的缩写，但注意它里面存放的是key-value键值对

bool表示一个boolean类型的变量,name表示boolean变量名，

同理还有int,long,float,str等等

Str即string的缩写，唯一要注意的是arr下的str子元素是没有name属性的，而list下的str元素是有name属性的

 

2、Query request handling 

 

2.1、Request-handling overview 

Solr 查询请求的处理过程:

1、Client（浏览器或者solrj客户端）发送查询请求到solr服务器

2、Jetty（或者tomcat等其他的web服务器）会将/solr的请求路由到solr统一的request dispatcher，dispatcher会根据/collection1找到对应的core，并找到这个core的solrconfig.xml中定义的处理请求的 request handle

3、request handler  使用各个组件串行的处理这个请求

4、处理完成后，Reponse writer组件会将结果处理成某个格式（xml、json等等）并返回client，默认是返回xml格式。

 

2.2、search handler

request handler主要有两类search handler和update handler，search handler负责处理查询请求、update handler用来更新索引的请求，这里主要介绍一下search handler，update handler 下一章介绍。下图是solrconfig.xml中/select request handler的定义。

ps:solrconfig.xml文件中定义的solr.开头的class（如这里的solr.SearchHandler）,都会对应于solr core java package：

"analysis.", "schema.", "handler.", "search.", "update.", "core.", "request.", "update.processor.", "util.", "spelling.", "handler.component.", or"handler.dataimport." 。这里的SearchHandler对应于

org.apache.solr.handler.component.SearchHandler 。

一个Search handler可以定义一下几个处理阶段：

1.请求参数处理

添加请求中没有的默认查询参数

覆盖修改请求的参数值

添加额外的参数

2.search first-components（可选）

3.search process components

4.search last-components （可选）

2.3、search components 

2.3.1 QUERY COMPONENT 

query处理的核心，通过active searcher 解析和执行查询。查询解析是通过参数控制的defType（如edismax，dismax）。query 组件查询初匹配查询参数的doc，这些doc可以被后续的组件继续处理。query组件是默认开启的，后续其他的组件需要在查询参数里显示的指定。

2.3.2 FACET COMPONENT

solr将以导航为目的的查询结果称为facet. 它并不会修改查询结果信息, 只是在查询结果上根据分类添加了count信息, 然后用户根据count信息做进一步的查询, 比如淘宝的查询列表中, 上面会表示不同的类目相关查询结果的数量，，后续会详细介绍

2.3.3 MORE LIKE THIS COMPONENT

如果启用这个组件，会搜索出和查询结果相似的doc，后续会详细介绍

2.3.4 HIGHLIGHT COMPONENT

如果启用这个组件，会高亮显示匹配的文本，后续会详细介绍 

2.3.5 STATS COMPONENT 

统计组件，如果启用，可以统计指定数字field的统计信息，如最小值、最大值、总和、平均值...等等统计信息，具体可以看下面的实例。

2.3.6、DEBUG COMPONENT

开启debug组件，可以看到solr 打分的详情，有助于排查一些诸如排序错误的问题。开启debug组件只用在请求参数增加debugQuery=true就可以了。

2.3.7 ADDING SPELLCHECK AS A LAST-COMPONENT

后续再介绍

3、Managing searchers

solrconfig.xml中<query>标签包含了一些可以优化查询性能的参数，如缓存、field懒加载、新searcher预热等。

3.1 New searcher overview 

       searcher是solr处理query的组件，solr中只有一个active 的searher。这个active searcher 拥有所有lucene索引的只读快照，如果提交一个新的doc到solr，这个doc在当前这个searcher中是不可见的。那么如何才能使得新提交的doc可见呢？solr的解决方案是关闭当前的searcher，新开一个searcher，新的searcher拥有新提交的doc的索引的只读快照。这就是solr commit的需要做的一部分工作（每个commit都要new 一个searcher）。

       当进行一次commit之后，在旧的searcher上还有未执行完的查询，所以旧searcher的销毁是在其上面搜有查询执行完才执行的。销毁旧的searcher的时，其上面所有的缓存也都会被删除（因为原有的缓存都是基于旧的索引快照的，commit之后索引是有更新的，所以旧的缓存也应该是要失效的）。

       而生成新的searcher需要执行一些计算（如重新计算缓存），所以生成新的searcher是代价比较耗时的操作。为了不对用户的查询产生影响，solr采用的后台生成新的searcher的方式，当新的searcher就绪之前，旧的searcher一直是提供查询的，直到新的searcher 预热完毕。

3.2、Warming a new searcher 

预热新的searcher有两种方式：通过旧的cache自动预热新的cache、执行cache预热的查询。下一节会详细介绍自动预热。

这里先看一下执行cache预热的查询的配置。通过配置一个listener，当newSeacher事件发生时，会执行queries里面的查询用来预热缓存。配置成预热的query一般都是应用最频繁的查询，配置queries不能过多，过多会造成预热的时间太久，耗费太多服务器的资源。

 

这种预热方式方式一个很有用的场景是solr服务启动first searcher的预热，配置first searcher的预热，只需要将上面的event="firstSeacher"就行了。solr判断事件是firstSeacher是根据当前Seacher是否是null判断的，如果当前seacher是null则为firstSearcher。 

searcher预热还有两个重要的配置标签useColdSearcher和maxWarmingSearchers

<useColdSearcher>false</useColdSearcher>，当配置为true的时候，不等新的searcher预热完毕就直接使用，而配置为false的时候，就是等到新的searcher预热完才会使用

<maxWarmingSearchers>2</maxWarmingSearchers>， 配置同时预热的searcher数量，如果searcher预热的时间过长，commit又比较频繁的话，会导致同时有多个searcher在预热。如果同时预热的数量超过配置的参数，之后的commit就会报错，如果经常出现报错，就需要考虑是否这个值设置的不合理或者预热时间过长。solr默认配置的是2。

4、cache management

4.1、cache fundamentals

• cache 大小
• 命中率与缓存踢除
• 缓存失效
• cache预热

cache大小

solr cache在都在内存中，需要有大小限制

LRU、LFU

如果内存够大，cache也不宜设置过大，过大会造成fullgc 时间太长

命中率与缓存踢除

命中率越接近1越好，太小solr的cache益处不大

缓存踢除过多，说明缓存size设置太小

命中率和缓存是有关联关系的     

缓存失效

缓存失效导致查询结果错误的问题在solr中不存在，因为solr的缓存是和searcher实例绑定的，当searcher关闭的时候，所有缓存一起失效。searcher是一个对索引的一个只读快照。

缓存预热

solr commit之后创建一个新的searcher实例

创建新的searcher可以设置预热缓存

4.2、filter cache

针对fq参数，fq参数对查询结果进行过滤，不会影响打分

fq的查询结果缓存，key是fq的参数，value是docid的bitmap（所以如果maxdoc是100w个，那每个cache的最大的大小是100w bit=1Mb）

autowarm的时间不能超过commit的间隔

最好用LFU

size和autowarmCount 需要根据应用的fq的数量以及commit的间隔

4.3、Query result cache

queryResultCache是对查询结果的缓存（SolrIndexSearcher中的cache缓存的都是document id set），这个结果就是针对查询条件的完全有序的结果

<queryResultWindowSize> 每次查询返回的doc的数量，比如设置为30，一个查询每页是10个，但一次查询实际是返回30个docid的

<queryResultMaxDocsCached> 对于每个查询缓存的doc的最大数量，比如设置为90，这个查询最多能缓存的doc数量

queryResultCache 永远缓存第一个doc到查询的出的最后一个doc，而不是start 的docid 

参考： http://ronaldxq.blogspot.hk/2015/01/solr-queryresultcache.html

4.4、Document cache

documentCache用来保存<doc_id,document>对的。

如果使用documentCache，就尽可能开大些，至少要大过<max_results> * <max_concurrent_queries>，否则因为cache的淘汰，一次请求期间还需要重新获取document一次。也要注意document中存储的字段的多少，避免大量的内存消耗。

预热是否必要：要看情况而定，返回比较固定，就可以设置预热

4.5、Field value cache

lucene缓存，不是solr管理的，缓存了docId和stored field。 

5、Summary 

上面只是介绍了solrconfig.xml的一部分常用的配置，solrconfig.xml里面有大量的详细注释，可以通过查看solrconfig.xml  的配置文件的了解其他的一些配置，如配置返回格式、如何定义一个新的search handler、生产环境调优等。