Profile app with py-spy

Makefile

@@ -28,11 +28,11 @@ build:
 	docker-compose build
 
 up:
-	docker-compose up -d api db
+	docker-compose up -d
 	make migrate-up
 
 start:
-	docker-compose start api db
+	docker-compose start
 
 stop:
 	docker-compose stop
@@ -52,14 +52,17 @@ logs:
 shell: ## Shell into web container
 	docker-compose exec api bash
 
-shell-root:  # Shell into web container as root
-	docker-compose exec -u root api bash
+shell-db: ## Shell into postgres process inside db container
+	docker-compose exec db psql -w --username "sivdev_user" --dbname "sivdev"
 
 shell-ipython: ## Shell into ipython with falcon context
 	docker-compose exec api python /app/scripts/ipython_shell.py
 
-shell-db: ## Shell into postgres process inside db container
-	docker-compose exec db psql -w --username "sivdev_user" --dbname "sivdev"
+shell-profiler:
+	docker-compose exec profiler bash
+
+shell-root:  # Shell into web container as root
+	docker-compose exec -u root api bash
 
 migration: ## Create migrations using alembic
 	docker-compose exec api alembic revision --autogenerate -m "$(m)"

README.md

@@ -77,6 +77,17 @@ Movie.search("top gun", page=1, per_page=5)
   * Remove database from request before sending response
 * Migrations with [Alembic](http://alembic.zzzcomputing.com/en/latest/)
 
+### Profiler
+
+* Attach [py-spy](https://github.com/benfred/py-spy) to Python process to profile
+* Connect to Gunicorn process to profile web application
+  * [Gunicorn architecture](http://docs.gunicorn.org/en/stable/design.html)
+
+```console
+USAGE:
+    py-spy --duration <duration> --pid <pid> --rate <rate>
+```
+
 ### Testing
 
 * [pytest](https://docs.pytest.org/en/latest/)

docker-compose.yml

@@ -47,6 +47,7 @@ services:
   api:
     build:
       context: .
+      dockerfile: ./docker/Dockerfile
     command: ["gunicorn", "app:api", "-b", "0.0.0.0:7000", "--reload", "--timeout",  "100000"]
     environment:
       API_URL: http://api:7000
@@ -75,7 +76,7 @@ services:
   # task queue
   rq-dash:
     build:
-      context: ./scripts/rq-dashboard/
+      context: ./docker/rq-dashboard/
     environment:
       RQ_DASHBOARD_REDIS_URL: redis://redis:6379
     depends_on:
@@ -85,7 +86,7 @@ services:
     command: ["rq-dashboard"]
   rq-scheduler:
     build:
-      context: ./scripts/rq-scheduler/
+      context: ./docker/rq-scheduler/
     environment:
       RQ_REDIS_HOST: redis
       RQ_REDIS_PORT: 6379
@@ -95,6 +96,7 @@ services:
   worker:
     build:
       context: .
+      dockerfile: ./docker/Dockerfile
     environment:
       GMAIL_ADDRESS: $GMAIL_ADDRESS
       GMAIL_APPLICATION_PASSWORD: $GMAIL_APPLICATION_PASSWORD
@@ -112,3 +114,15 @@ services:
       - elasticsearch
     ports:
       - "5601:5601"
+
+  # dev tools
+  profiler:
+    build:
+      context: ./docker/py-spy/
+    pid: "service:api"
+    cap_add:
+      - SYS_PTRACE
+    volumes:
+      - ./docker/py-spy/flame-graphs:/flame-graphs
+    stdin_open: true
+    tty: true

docker/README.md

@@ -0,0 +1,3 @@
+# Docker Images
+
+Supporting materials required to make Docker images for webapp.

docker/py-spy/Dockerfile

@@ -0,0 +1,5 @@
+FROM python:3.7.0-stretch
+
+RUN pip install py-spy
+
+CMD ["python"]