Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Events captured by the Bridge as part of the snapshot's history (CURRENT)

EventData*

Who/What initiates it?Initiated By

Snapshot Complete

alternateIds: ['id1', 'id2', 'id3',...]

TODO: add snapshot-action: SNAPSHOT_COMPLETE method

NodeIntake Service
Request Restore Snapshot

initiating-user: <user email>

restore-action: RESTORE_REQUESTED

Bridge User
Restore Initiated

restore-id: <restore-id>

restore-action: RESTORE_INITIATED

user-email: <request initiating user email>

Bridge Admin
Restore Completed

restore-id: <restore-id>

restore-action: RESTORE_COMPLETED

expiration-date: yyyy-MM-dd


Bridge System
Restore Expired

restore-id: <restore-id>

restore-action: RESTORE_EXPIRED

Bridge System

*All events have a date stamp associated with them.

Additionally, nodes can append node specific events to the snapshot history at any time  via the /snapshot/{snapshot-id}/history  REST call.

Events captured by the Bridge Intake Service (CURRENT)

The failure of a DPN transfer isn't captured, but could be. Also, the event name is hidden from the user so these look quite cryptic in the displayed history.

Event
Data
Initiated By
Bagging Completed
  • name: UUID of the bag
  • receipt: sha256sum of the bag's tagmanifest
Intake
Transfer to DPN Node
  • name: UUID of the bag
  • node: the name of the replicating node
Intake

Actions we should be capturing in snapshot history (TO DO)

EventData*

Who/What initiates it?Initiated By

Snapshot Initiated
  • snapshot-action: SNAPSHOT_INITIATED
  • user-email: (or user-id:)
  • snapshot-id: <snapshot-id>
Bridge
Snapshot Transfer to Chronopolis Complete
  • snapshot-action: SNAPSHOT_STAGED
  • snapshot-id: <snapshot-id>
Bridge
Bagging Completed
  • snapshot-action: SNAPSHOT_BAGGED
  • bag-ids: <list of bag IDs>
  • manifest-checksum: <sha256sum of tag manifest>
  • snapshot-id: <snapshot-id>
Intake Service
Snapshot Replication to DPN Nodes
  • snapshot-action: SNAPSHOT_REPLICATED
  • bag-ids: <list of bag IDs>
  • node: <node name or ID>
  • snapshot-id: <snapshot-id>
Intake Service
Snapshot Complete
  • snapshot-action: SNAPSHOT_COMPLETE
  • alternate-ids: <list of bag IDs>
  • snapshot-id: <snapshot-id>

Call to complete snapshot made by Intake Service

Event captured by Bridge

Snapshot Bit Integrity Check Complete
  • snapshot-action: BIT_INTEGRITY_CHECK
  • result: <SUCCESS or FAILURE>
  • snapshot-id: <snapshot-id>
ACE webhook?

...