novaway/elasticsearch-bundle

A bundle to integrate add debug information to elasticsearch/elasticsearch in your Symfony Applications

Usage

The bundle provides a Elasticsearch\Client override, throwing events during search, and displaying it in the symfony toolbar.

The Client is provided by the Novaway\ElasticsearchBundle\Factory\ClientFactory:createClient() method

Installation

composer require novaway/elasticsearch-bundle

Service configuration

You probably want to register the Client as a service. To do so, use the ClientFactory

# config/services.yaml
services:
...
    Novaway\ElasticsearchBundle\Elasticsearch\Client:
        factory: Novaway\ElasticsearchBundle\Factory\ClientFactory:createClient
        arguments:
            - ['%elasticsearch_host%']

And voila, when you use this client for search, the queries and requests will be collected, and added to the SymfonyToolbar

Configuration

# config/package/novaway_elasticsearch.yaml
novaway_elasticsearch:
    logging:
        enabled: false # if true, log every search request with a LoggerInterface service
        logger: 'logger' # the logger service id

Integration with the novaway/elasticsearch-client

You can of course use this bundle with the novaway/elasticsearch-client, you only need to pass the Client to the Indexes

License

This bundle is under the MIT license. See the complete license in the bundle