pmg / queue-cloudwatch
Track your queue with CloudWatch metrics
Installs: 8 302
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 16
Forks: 0
Open Issues: 0
Requires
- php: ^8.0
- aws/aws-sdk-php: ^3.0
- pmg/queue: ^6.0
- psr/log: ^1.0 || ^2.0 || ^3.0
Requires (Dev)
- phpunit/phpunit: ^9.5
- pmg/queue: ^6.0@beta
- symfony/phpunit-bridge: ^5.4
This package is auto-updated.
Last update: 2024-11-05 17:39:03 UTC
README
A pmg/queue
driver decorator that dispatches cloudwatch metrics when messages
are sent through.
Example
use AWS\CloudWatch\CloudWatchClient; use PMG\Queue\Driver; use PMG\Queue\CloudWatch\MetricsDriver; /** @var Driver $driver */ $driver = createAnActualDriverSomehow(); // this is the default metric namespace, change if desired. $metricNamespace = 'PMG/Queue'; $finalDriver = new MetricsDriver($driver, CloudWatchClient::factory([ 'region' => 'us-east-1', 'version' => 'latest', ]), $metricNamespace); // now use $finalDriver in your consumers/producers
Metrics
All metrics have the dimensions...
QueueName
- The name of the queue to which the metrics belongMessageName
- The value returned fromMessage::getName
. When a message is not present for logging the metric, this dimension will be set to__none__
.
Driver Metrics
DriverError
- ACount
metric unit fired when the wrapped driver throws aDriverError
exception. This will have anErrorClass
dimension that contains the exception class name that was thrown.
Message Counts
There's a metric for each method on the driver, essentially. They all use
Count
as the metric unit.
MessageEnqueue
- Fired onDriver::enqueue
MessageDequeue
- Fired onDriver::dequeue
. This is only fired when a message is returned from the wrappedDriver::dequeue
.MessageSuccess
- Fired onDriver::ack
MessageFailure
- Fired onDriver::fail
MessageRetry
- Fired onDriver::retry
MessageRelease
- Fired onDriver::release
You might use these message counts to alert on a high volume of message failures or retries.
Message Timers
The metrics driver will time dequeued jobs until they are acked, failed, or
retried. These all use Milliseconds
as their metric unit.
MessageTime
- The amount of time a message took, tracked for every message regardless of how it finished.
The MessageTime
metric will have an additional dimension named MessageStatus
which is how the given message finished when the timer completed. This will be:
Success
when the message was passed toDriver::ack
Failure
when the message was passed toDriver::fail
Retry
When the message was passed toDriver::retry
Release
When the message was passed toDriver::release
Error Handling
First up, the wrapped driver is always called first. If an error occurs from the wrapped driver it's tracked and rethrown before any further metrics can be logged. The idea here is that driver errors invalidate any processes acting on a message anyway.
Errors from the cloudwatch client are caught and logged, however. You can pass a
fourth $logger
argument to MetricsDriver
if you wish to see these errors,
but a NullLogger
is used by default.
use AWS\CloudWatch\CloudWatchClient; use PMG\Queue\Driver; use PMG\Queue\CloudWatch\MetricsDriver; /** @var Driver $driver */ $driver = createAnActualDriverSomehow(); // this is the default metric namespace, change if desired. $metricNamespace = 'PMG/Queue'; $finalDriver = new MetricsDriver($driver, CloudWatchClient::factory([ 'region' => 'us-east-1', 'version' => 'latest', ]), $metricNamespace, $yourLoggerFromSomeplace); // now use $finalDriver in your consumers/producers
Testing
./vendor/bin/phpunit
The tests include a set of integration tests that actually talk to CloudWatch. Be sure to have set up credentials. in order to run those tests. Otherwise you may exclude them with...
./vendor/bin/phpunit --exclude-group integration