Using DIXY

Java Agent Setup

Attach the DIXY -javaagent to your own Java application and report deadlocks to the backend.

Build the agent

bash

$ ./gradlew agentJar

Start the DIXY backend in web mode first — the agent reports to it.

Attach it

Linux

$ java -javaagent:/path/to/DIXY/build/libs/virtual_deadlock_detection-0.0.1-SNAPSHOT-agent.jar=serverUrl=http://localhost:8081,apiKey=dixy-local-dev-key-123,appName=my-service \
    -jar your-application.jar

On PowerShell, wrap the whole -javaagent argument in quotes or it splits at the commas.

Options

Option	Meaning
`serverUrl`	Backend base URL. Always set it: the default is port 8080, but DIXY listens on 8081.
`apiKey`	Must equal the backend's key, or reports are rejected with 401.
`appName`	Label for this application (default unknown-app).

Verify it works

On startup the application prints Agent Started Successfully. Then list reports:

bash

$ curl -H "X-API-Key: dixy-local-dev-key-123" http://localhost:8081/api/deadlocks

Suggest an edit on GitHub