A monitor for celery queues that reports to AWS CloudWatch
Project description
Celery CloudWatch
Monitor your celery application from within AWS CloudWatch!
Metrics
The following events are tallied per task:
CeleryTaskEventWaiting
CeleryTaskEventRunning
CeleryTaskEventCompleted
CeleryTaskEventFailed
You can then see how many tasks/day, tasks/week etc are being completed.
Also, statistics on task duration are sent in the metrics:
CeleryTaskQueuedTime
CeleryTaskProcessingTime
These metrics are sent with all supported stats (No. Events, Sum, Max, Min), allowing you to gain insight into your task processing and match requests and capacity.
Finally, the following metrics are sent as overalls (for each queue):
CeleryQueueSize
CeleryRunningTasks
Getting Started
Set up an IAM Role for your instance.
It must include a policy to perform ‘PutMetricData’, eg:
{ "Version": "2000-01-01", "Statement": [ { "Effect": "Allow", "Action": [ "cloudwatch:PutMetricData" ], "Resource": [ "*" ] } ] }
(Note: Alternitavely, you can set up a User with the same policy and provide access details that way)
Install via python-pip (and upgrade pip & boto)
sudo apt-get install -y python-pip sudo pip install --upgrade pip boto # Install directly sudo pip install celery-cloudwatch # OR, install in a virtualenv sudo apt-get install -y python-virtualenv mkdir /var/python-envs virtualenv /var/python-envs/ccwatch source /var/python-envs/ccwatch/bin/activate pip install celery-cloudwatch
Create your own boto.cfg at /etc/boto.cfg
[Credentials] # if not using an IAM Role - provide aws key/secret aws_access_key_id = xxx aws_secret_access_key = yyy [Boto] cloudwatch_region_name = my-region cloudwatch_region_endpoint = monitoring.my-region.amazonaws.com
Create your own config file in /etc/ccwatch.cfg
[ccwatch] broker = amqp://guest@localhost:5672// [cloudwatch-camera] ; the "Custom Metrics" category to use namespace = celery ; provide a list of tasks tasks = myapp.mytasks.taskname myapp.mytasks.anothertask myapp.mytasks.thirdtask queues = celery [cloudwatch-camera-dimensions] ; additional dimensions to send through with each metric ; eg. ; app = myapp
Install upstart
Create a file /etc/init/celery-cloudwatch.conf
description "Celery CloudWatch" author "nathan muir <ndmuir@gmail.com>" setuid nobody setgid nogroup start on runlevel [234] stop on runlevel [0156] exec /var/python-envs/ccwatch/bin/ccwatch respawn
then
sudo initctl reload-configuration sudo service celery-cloudwatch start
Start Celery your celery workers with the -E (or CELERY_SEND_EVENTS=1) option, and, start celery clients with CELERY_SEND_TASK_SENT_EVENT=1
All done! head over to your CloudWatch monitoring page to see the results!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.