https://github.com/gilbitron/sqsd
A replica of the AWS Elastic Beanstalk worker SQS daemon (sqsd) in PHP
https://github.com/gilbitron/sqsd
aws daemon elasticbeanstalk php sqs sqsd
Last synced: 28 days ago
JSON representation
A replica of the AWS Elastic Beanstalk worker SQS daemon (sqsd) in PHP
- Host: GitHub
- URL: https://github.com/gilbitron/sqsd
- Owner: gilbitron
- License: mit
- Created: 2017-04-27T09:02:12.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-03T15:42:59.000Z (about 8 years ago)
- Last Synced: 2025-04-13T01:12:42.664Z (28 days ago)
- Topics: aws, daemon, elasticbeanstalk, php, sqs, sqsd
- Language: PHP
- Homepage: https://packagist.org/packages/gilbitron/sqsd
- Size: 919 KB
- Stars: 34
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQSD
While testing a [Laravel](https://laravel.com) app running on [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/) I came across the situation where I wanted to be able to test how my app would handle interacting with the worker tier SQS daemon (`sqsd`) on my local machine. As `sqsd` is not open source there is currently no official way of doing this.
This project ([inspired by others](https://github.com/proofme/sqsd)) is an attempt to replicate the functionality of `sqsd` in PHP for local testing purposes. Note that his library has **no dependency on Laravel** and can be used to test any kind of app.
## Description
The Laravel queue worker operates by polling a queue for jobs and then runs them inline (as the queue worker is part of the application). As `sqsd` is completely separate from any application it works in a different way so that any application can be designed to work with it.
Sqsd works by polling a SQS queue for jobs and then `POST`'s them to an endpoint specified in your [Elastic Beanstalk worker environment settings](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#using-features-managing-env-tiers-worker-settings) (default is `http://localhost/`). If a job fails for any reason, then the job is sent to what is called a [Dead Letter Queue](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#worker-deadletter) for manual processing.
Another aspect of `sqsd` is that it can read a `cron.yaml` file in the root of your application which specifies [periodic tasks](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#worker-periodictasks) that can be run on a schedule. Sqsd will send a job to the queue every time the schedule is triggered. These jobs will then be processed by `sqsd` like normal, but will be `POST`ed to the path specified in the `cron.yaml` with some extra headers.
## Requirements
* PHP >= 5.5.0
* Composer
## Install & Usage
1. Clone this repo
1. Copy `.env.example` to `.env` and fill in the details (see below)
1. Run `composer install`
1. Run `php ./bin/sqsd.phar work`
To install as a composer dependency:
1. Run `composer require gilbitron/sqsd`
1. Run `php ./vendor/bin/sqsd.phar work`
Note: If your're running `sqsd` as a composer dependency you will need to set your environment variables via the command line (see below for more info).
## Configuration
Configuration is done by either setting environment variables before running `sqsd` (e.g. `export SQS_QUEUE_URL=https://sqs.us-east-1.amazonaws.com/123456789`) or specifying them in `.env`.
| Env Variable | Description |
| --- | --- |
| `AWS_ACCESS_KEY_ID` * | AWS access key ID with SQS permissions |
| `AWS_SECRET_ACCESS_KEY` * | AWS secret access key |
| `SQS_QUEUE_URL` * | The URL of the SQS queue (e.g. `https://sqs.us-east-1.amazonaws.com/123456789`) |
| `SQS_QUEUE_NAME` * | The name of the SQS queue |
| `SQS_QUEUE_REGION` * | The region of the SQS queue (e.g. `us-east-1`) |
| `SQS_MAX_MESSAGES` | The maximum number of messages that will be received from the SQS queue at a time (default and max is `10`) |
| `SQS_WAIT_TIME` | The length of time in seconds that `sqsd` will wait while polling the SQS queue for messages |
| `SQSD_WORKER_URL` | The URL the worker will `POST` to (default is `http://localhost`) |
| `SQSD_WORKER_PATH` | The path that will be appended to the worker URL (default is `/`). This is the same as the **HTTP Path** setting in the [Elastic Beanstalk worker environment settings](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features-managing-env-tiers.html#using-features-managing-env-tiers-worker-settings) |
| `SQSD_CRON_PATH` | Absolute path to a `cron.yaml` which specifies periodic tasks |
| `SQSD_SLEEP_SECONDS` | The time in seconds `sqsd` should sleep between checks (default is `1`) |
| `SQSD_STORAGE_PATH` | Path to a writable storage dir (default is `/tmp/sqsd`) |
Environment variables marked with a * are required for `sqsd` to work.
## Building the Phar
To build Phar file first you need to [install Box](https://github.com/box-project/box2) then run:
```
box build -v
```
## Laravel Tips
If you're looking for a package that will make Laravel work with `sqsd` I recommend [dusterio/laravel-aws-worker](https://github.com/dusterio/laravel-aws-worker).
If you are using this to test a Laravel app, instead of [configuring Supervisor](https://laravel.com/docs/5.4/queues#supervisor-configuration) to run the `aritsan queue:work` command, configure Supervisor to run the `sqsd work` command.
## Contribute
So you want to help out? That's awesome. Here is how you can do it:
* [Report a bug](https://github.com/gilbitron/sqsd/issues)
* [Ask for a feature](https://github.com/gilbitron/sqsd/issues)
* [Submit a pull request](https://github.com/gilbitron/sqsd/pulls)
If you are submitting a pull request please adhere to the existing coding standards used throughout the code
and only submit **1 feature/fix per pull request**. Pull requests containing multiple changes will be rejected.
## Credits
Sqsd was created by [Gilbert Pellegrom](http://gilbert.pellegrom.me) from
[Dev7studios](http://dev7studios.co). Released under the MIT license.