Log Fields
This section describes all the audit log fields with examples.
| Field Name | Description |
|---|---|
| Log ID | A unique ID is generated for tracking all the control-plane operations of resources from the consumer applications.
For example, what operations were taken on the resources in your subscription; who started the operation; when the operation occurred; the status of the operation. |
| Log Keys | An array of objects of custom properties (key-value pairs) that the application or component can populate for any other custom audit data related to an audit event. Depending on the technology stack, various properties can be helpful in these situations with a tightly coupled technology. |
| Message Headers | It contains a Base64 encoded string of the headers in the message wherever applicable. Consumer applications and their component should not supply headers with sensitive information like passwords, auth tokens, and other information. |
| Message Payload | It is a Base64 part of transmitted data of the actual intended message. Headers and metadata are sent only to enable payload delivery. Therefore, the consumer applications should not include the actual files irrespective of their size. Instead, they can be stored at the consumer application itself and send some unique reference ID/link to the Message Reference. |
| Message Protocol | The protocol is used to send or receive data between the application components.
For example, SFTP-SSH, HTTPS, and other data. |
| Message Reference | If the sent/received data is very large or unstructured or secured, then a reference address where that data is stored should get placed here.
For example, CSV file, etc. |
| Message Type | It specifies the format in which the Message Payload got transmitted.
For example, json, xml, csv, spreadsheet, and other formats. |
Below table describes all the attributes that are used in View log and associated with Log fields.
| Attribute Name | Type | Mandatory | Character Length |
|---|---|---|---|
| Application ID | String | Yes | 8 |
| Application Name | String | No | 32 |
| Client (Client ID) | String | No | 32 |
| Component ID | String | Yes | 16 |
| Component Name | String | Yes | 32 |
| Correlation ID | GUID | No | 36 |
| Description (Entry) | String | Yes | N/A |
| Event ID | GUID | No | 36 |
| Log ID | GUID | Yes | 36 |
| Log Keys | String | No | N/A |
| Message Headers | String | No | N/A |
| Message ID | GUID | No | 36 |
| Message Payload | String | No | N/A |
| Message Protocol | String | No | N/A |
| Message Reference | String | No | N/A |
| Message Type | Enum | No | 16 |
| Group | String | No | 32 |
| Reference ID | String | No | 64 |
| Study ID | String | No | 32 |
| Timestamp | Time | Yes | 16 |
| Transaction ID | GUID | Yes | 36 |
| Type | Enum | Yes | 16 |
| User ID | String | No | 64 |