metrics

Get chain workflow metrics.

Changed on
get/v1/metrics/chain/{chainID}/workflow

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/metrics/chain/{chainID}/workflow
  • Auth
    API key in header Authorization

Path parameters

chainIDstring string required

ChainID (Bech32)

Response

A list of all available metrics.

currentStateIndexinteger

Shows current state index of the consensus

flagBatchProposalSentboolean required

Shows if batch proposal is sent out in current consensus iteration

flagConsensusBatchKnownboolean required

Shows if consensus on batch is reached and known in current consensus iteration

flagInProgressboolean required

Shows if consensus algorithm is still not completed in current consensus iteration

flagStateReceivedboolean required

Shows if state output is received in current consensus iteration

flagTransactionFinalizedboolean required

Shows if consensus on transaction is reached in current consensus iteration

flagTransactionPostedboolean required

Shows if transaction is posted to L1 in current consensus iteration

flagTransactionSeenboolean required

Shows if L1 reported that it has seen the transaction of current consensus iteration

flagVMResultSignedboolean required

Shows if virtual machine has returned its results in current consensus iteration

flagVMStartedboolean required

Shows if virtual machine is started in current consensus iteration

timeBatchProposalSentstring date-time required

Shows when batch proposal was last sent out in current consensus iteration

timeCompletedstring date-time required

Shows when algorithm was last completed in current consensus iteration

timeConsensusBatchKnownstring date-time required

Shows when ACS results of consensus on batch was last received in current consensus iteration

timeTransactionFinalizedstring date-time required

Shows when algorithm last noted that all the data for consensus on transaction had been received in current consensus iteration

timeTransactionPostedstring date-time required

Shows when transaction was last posted to L1 in current consensus iteration

timeTransactionSeenstring date-time required

Shows when algorithm last noted that transaction had been seen by L1 in current consensus iteration

timeVMResultSignedstring date-time required

Shows when virtual machine results were last received and signed in current consensus iteration

timeVMStartedstring date-time required

Shows when virtual machine was last started in current consensus iteration

Example response

{
  "flagStateReceived": true,
  "flagTransactionPosted": true,
  "flagVMStarted": true,
  "timeTransactionSeen": "2000-01-23T04:56:07.000+00:00",
  "flagConsensusBatchKnown": true,
  "timeTransactionFinalized": "2000-01-23T04:56:07.000+00:00",
  "timeVMStarted": "2000-01-23T04:56:07.000+00:00",
  "flagVMResultSigned": true,
  "timeBatchProposalSent": "2000-01-23T04:56:07.000+00:00",
  "timeVMResultSigned": "2000-01-23T04:56:07.000+00:00",
  "timeCompleted": "2000-01-23T04:56:07.000+00:00",
  "timeTransactionPosted": "2000-01-23T04:56:07.000+00:00",
  "flagTransactionSeen": true,
  "timeConsensusBatchKnown": "2000-01-23T04:56:07.000+00:00",
  "currentStateIndex": 1,
  "flagInProgress": true,
  "flagBatchProposalSent": true,
  "flagTransactionFinalized": true
}

Changes