Skip to content

Using DIXY

REST API

Run DIXY in web mode and query deadlocks, threads, locks and status over HTTP.

Start web mode

bash
java -Duser.timezone=UTC -Dspring.profiles.active=web \
-jar build/libs/virtual_deadlock_detection-0.0.1-SNAPSHOT.jar
curl http://localhost:8081/actuator/health

API key

Every endpoint except /actuator/health needs an X-API-Key header. The local default is dixy-local-dev-key-123; change it with -Dsecurity.api-key=YOUR_KEY.

The default key and database password are for local development only.

Endpoints

MethodPathDescription
GET/api/deadlocksList detected deadlock reports
GET/api/deadlocks/{id}Get one report
POST/api/graph/detectRun detection on the current graph
GET/api/threadsList threads
GET/api/locksList locks
GET/api/v1/statusHEALTHY / WARNING / CRITICAL with metrics
DELETE/api/v1/status/clearRemove stored threads, locks and wait edges
POST/api/telemetrySend telemetry to DIXY
POST/api/internal/deadlocksUsed by the agent to push cycles
GET/actuator/prometheusPrometheus metrics