Message audits
  • 25 Mar 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Message audits

  • Dark
    Light
  • PDF

Article summary

Every EchoStream Internal Node, Managed Node or External Node (if implemented using the EchoStream echostream-node library or equivalent functionality) records an audit record for each message that is processed by that Node.

Each audit record is stored in frequent access storage for 30 days (and then deep archived for as long as the Tenant exists) and is emitted by the Audit Emitter Node in your Tenant.

The audit record deep archive is designed specifically to support legal discovery and compliance requirements that you may have or encounter. Retrieval of archived audit records is accomplished via an EchoStream service request and can take up to 48 hours to complete; if you require rapid access to all audit records generated by your Tenant you should create a Node to listen to your Tenant's Audit Emitter Node and store the records that you receive in a data store outside of EchoStream.

An audit record is composed of the following fields:

FieldFormatDescription
datetimeISO8601 date/time stringThe date and time that the message was audited.
message_typestringThe name of the Message Type of the audited message.
nodestringThe name of the auditing Node.
prev_tracking_idslist of stringsAll of the previous tracking ids for the audited message. Only present if the message has been split.
tenantstringThe name of the Tenant containing the auditing Node.
tracking_idstringThe unique tracking id of the audited message. See Message Tracking.
{message_type}_{attribute}variousAll of the additional attributes provided during the audit. These fields take the message_type and the attribute name, joins them with an _, and replaces all spaces and punctuation with _s to provide easy query compatibility. Fields are generally defined by the Message Type's auditor function; for External and Managed Nodes, implementations may provide extra attributes beyond those defined in the auditor. The format of the value for these fields is dependent upon the auditor.

What's Next