diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 0a66c76efe..c2ccd6727a 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -12,6 +12,10 @@ Version 5.0 * Removed ``finance-workflows`` dependency on jackson library. The functions that used jackson (e.g. ``FinanceJSONSupport``) have been moved into IRS Demo. +* Information about checkpointed flows can be retrieved from the shell. Calling ``dumpCheckpoints`` will create a zip file inside the node's + ``log`` directory. This zip will contain a JSON representation of each checkpointed flow. This information can then be used to determine the + state of stuck flows or flows that experienced internal errors and were kept in the node for manual intervention. + .. _changelog_v4.2: Version 4.2 diff --git a/docs/source/upgrading-cordapps.rst b/docs/source/upgrading-cordapps.rst index d28baf34c1..60ea99bbbc 100644 --- a/docs/source/upgrading-cordapps.rst +++ b/docs/source/upgrading-cordapps.rst @@ -281,6 +281,11 @@ a drain is complete there should be no outstanding checkpoints or running flows. A node can be drained or undrained via RPC using the ``setFlowsDrainingModeEnabled`` method, and via the shell using the standard ``run`` command to invoke the RPC. See :doc:`shell` to learn more. +To assist in draining a node, the ``dumpCheckpoints`` shell command will output JSON representations of each checkpointed flow. +A zip containing the JSON files is created in the ``logs`` directory of the node. This information can then be used to determine the +state of stuck flows or flows that experienced internal errors and were kept in the node for manual intervention. To drain these flows, +the node will need to be restarted or the checkpoint record will need to be manually deleted from the checkpoint table. + .. _contract_upgrading_ref: Contract and state versioning