How to debug corrupted workflow history using admin tooling

[longquanzheng]

In certain scenario, you might want to debug the corrupted workflow.

Step 1 use cadence admin workflow describe to get shardID, treeID and branchID and its internal state

Sample command: cadence --address <> admin workflow describe -w <workflowID> -r <runID>

Step 2, use cadence admin workflow show to get the history using shardID, treeID and branchID

This command bypasses the Cadence server and connected to database directly.

Sample command for MySQL:
cadence adm wf show --conn_attrs tx_isolation=READ-COMMITTED --db_type mysql --db_address <mysql db address> --db_name <db name> --db_port 3306 --username <db username> --password <db password> --tree_id <> --branch_id <> --shard_id <>

You may not need -conn_attrs tx_isolation=READ-COMMITTED depends on your MySQL version. It should be the same as your Cadence database config.

If you use other database like Cassandra or Postgres, change the db_type accordingly.
run cadence adm wf show --help for all options.