novaway/elasticsearch-bundle

Symfony bundle to add debug information to elasticsearch/elasticsearch and ruflin/elastica

2.5.1 2023-10-31 10:31 UTC

Requires

• php: ^7.1 || ^8.0
• ext-curl: *
• elasticsearch/elasticsearch: ^5.2 || ^6.0 || ^7.0
• ruflin/elastica: ^6.0 || ^7.0
• symfony/config: ^4.2 || ^5.0 || ^6.0
• symfony/dependency-injection: ^4.2 || ^5.0 || ^6.0
• symfony/http-kernel: ^4.3 || >=5.1.5
• symfony/serializer: ^4.2 || ^5.0 || ^6.0
• symfony/web-profiler-bundle: ^4.2 || ^5.0 || ^6.0
• webmozart/assert: ^1.0

Requires (Dev)

• phpstan/phpstan: ^0.11.2
• symfony/var-dumper: ^4.1

MIT

• elasticsearch

README

A bundle to add debug information to elasticsearch/elasticsearch and ruflin/elastica in your Symfony Applications

Usage

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

Installation

composer require novaway/elasticsearch-bundle

Service configuration

You probably want to register the Novaway\ElasticsearchBundle\Elastica\Client as a service, and set Elastica\Client as its alias

# config/services.yaml
services:
...
    Novaway\ElasticsearchBundle\Elastica\Client:
        arguments:
            $config:
                url: '%elasticsearch_host%'

    Elastica\Client: '@Novaway\ElasticsearchBundle\Elastica\Client'

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

License

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