Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Update doc related to use of fos:elastica:populate command with SQS #1949

Merged
merged 1 commit into from
Jun 13, 2024
Merged

[Docs] Update doc related to use of fos:elastica:populate command with SQS #1949

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 21 additions & 17 deletions doc/cookbook/speed-up-populate-command-sqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,30 @@ $ composer require enqueue/elastica-bundle
$ composer require enqueue/sqs
```

Define a handful of useful entries in `parameters.yml`
Add the useful variables to your parameters, usually defined in `services.yaml` :

```yaml
parameters:
aws_sqs_key: XXXXX
aws_sqs_secret_key: XXXXX
aws_sqs_region: XXXXX
aws_sqs_queue_name: XXXXX
aws_sqs_reply_queue_name: XXXXX
aws_sqs_key: '%env(AWS_SQS_KEY)%'
aws_sqs_secret_key: '%env(AWS_SQS_SECRET_KEY)%'
aws_sqs_region: '%env(AWS_SQS_REGION)%'
aws_sqs_queue_name: '%env(AWS_SQS_QUEUE_NAME)%'
aws_sqs_reply_queue_name: '%env(AWS_SQS_REPLY_QUEUE_NAME)%'
```

Your `vendor/enqueue.yml` config should look like, taking three of the parameters defined above.
You will need to define the corresponding environment variables for a later use.

Your `config/packages/enqueue.yml` config should look like, taking three of the parameters defined above.

```yaml
enqueue:
transport:
default: sqs
sqs:
key: "%aws_sqs_key%"
secret: "%aws_sqs_secret_key%"
region: "%aws_sqs_region%"
default:
transport:
dsn: 'sqs:?key=%aws_sqs_key%&secret=%aws_sqs_secret_key%&region=%aws_sqs_region%'
client: ~

enqueue_elastica:
transport: '%enqueue.default_transport%'
doctrine: ~
```

Expand All @@ -52,13 +53,13 @@ services:
$queueName: "%aws_sqs_queue_name%"
$replyQueueName: "%aws_sqs_reply_queue_name%"
tags:
- { name: kernel.event_listener, event: elastica.pager_persister.pre_persist, method: prePersist }
- { name: kernel.event_listener, method: prePersist }
```

Here is a simple implementation of `QueuePagerPersister` that is aware of AWS, again it takes the parameters you defined above.
Here is a simple implementation of `QueuePagerPersister` that is aware of AWS, and takes the parameters you defined above.

```php
namespace AppBundle\Listener;
namespace App\Listener;

use FOS\ElasticaBundle\Persister\Event\PrePersistEvent;

Expand Down Expand Up @@ -130,7 +131,7 @@ Go the AWS GUI console and you should see the messages added to the queue. If yo
The messages are now in the AWS SQS queue, ready to be consumed.

```bash
php bin/console enqueue:transport:consume enqueue_elastica.populate_processor --queue=acme_fos_elastica_populate -vv
php bin/console enqueue:transport:consume enqueue_elastica.populate_processor <queue_name> -vvv
[info] Start consuming
[info] Message received from the queue: acme_fos_elastica_populate
[info] Message processed: enqueue.ack
Expand All @@ -139,6 +140,9 @@ php bin/console enqueue:transport:consume enqueue_elastica.populate_processor --
...
```

| `<queue_name>` should be replaced with the name defined as `AWS_SQS_QUEUE_NAME` (not the reply queue)


You should now start seeing the progress increase with the fos:elastica:populate, when all the messages are consumed you should get a brand new and re-populated index.

```bash
Expand Down
Loading