Merge pull request #902 from oleg-andreyev/populate-events-md

adding cookbook for populate events

Author: XWB

Resources/doc/cookbook/populate-events.md

@@ -0,0 +1,90 @@
+Populate Events
+===============
+
+Often when you need import large amount data and keep performance of your storage,
+you'll use [bulk insert](https://en.wikipedia.org/wiki/Bulk_insert) and Elasticsearch is not an exception.
+But in case of production Elasticsearch, you may suffer of high load on data-node,
+because Elasticsearch performs async refresh of shard(s).
+
+According to [official documentation about bulk indexing](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html#bulk)
+to squeeze out more performance out of bulk indexing, you must set `refresh_interval` to `-1` be executing:
+
+```bash
+curl -XPUT localhost:9200/test/_settings -d '{
+    "index" : {
+        "refresh_interval" : "-1"
+    } }'
+```
+
+Then, once bulk indexing is done, settings can be updated (back to default)
+ 
+```bash
+curl -XPUT localhost:9200/test/_settings -d '{
+    "index" : {
+        "refresh_interval" : "1s"
+    } }'
+```
+
+And _optimize should be called:
+
+```bash
+curl -XPOST 'http://localhost:9200/test/_optimize?max_num_segments=5'
+```
+
+Everything seems to be straightforward, but you'll how this can be achieved with FOSElasticaBundle? 
+For this purpose `PRE_INDEX_POPULATE`, `POST_INDEX_POPULATE`, `PRE_TYPE_POPULATE` and `POST_TYPE_POPULATE` were introduced, they allow you to monitor and hook into the process.
+ 
+Now let's implement `PopulateListener` by creating `AppBundle\EventListener\PopulateListener`:
+
+```php
+<?php
+namespace AppBundle\EventListener;
+
+use FOS\ElasticaBundle\Event\IndexPopulateEvent;
+use FOS\ElasticaBundle\Index\IndexManager;
+
+class PopulateListener
+{
+    /**
+     * @var IndexManager
+     */
+    private $indexManager;
+
+    /**
+     * @param IndexManager $indexManager
+     */
+    public function __construct(IndexManager $indexManager)
+    {
+        $this->indexManager    = $indexManager;
+    }
+    
+    public function preIndexPopulate(IndexPopulateEvent $event)
+    {
+        $index = $this->indexManager->getIndex($event->getIndex());
+        $settings = $index->getSettings();
+        $settings->setRefreshInterval(-1);
+    }
+    
+    public function postIndexPopulate(IndexPopulateEvent $event)
+    {
+        $index = $this->indexManager->getIndex($event->getIndex());
+        $settings = $index->getSettings();
+        $index->optimize(['max_num_segments' => 5]);
+        $settings->setRefreshInterval('1s');
+    }
+}
+```
+
+Declare your listener and register event(s):
+
+```xml
+<service id="app.event_listener.populate_listener" class="AppBundle\EventListener\PopulateListener">
+    <tag name="kernel.event_listener" event="elastica.index.index_pre_populate" method="preIndexPopulate"/>
+    <tag name="kernel.event_listener" event="elastica.index.index_post_populate" method="postIndexPopulate"/>
+    <argument type="service" id="fos_elastica.index_manager"/>
+</service>
+```
+
+and pretty much that's it!
+
+Other events that were indroduced: `PRE_INDEX_RESET`, `POST_INDEX_RESET`, `PRE_TYPE_RESET` and `POST_TYPE_RESET` are working in similar way