Logs

14 Mar 2024
4 Minutes to read

Print
Share
Dark
Light
PDF

Logs

Updated on 14 Mar 2024
4 Minutes to read

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

This article will describe how you can observe information about a Share and the data transferred.

Logs can be found at the bottom of each Share, next to the Transfers tab.

High-Level Overview:

Log Events

When system and user actions are executed concerning a Share, they're stored in the Share Log. The Share Log will display the following events and information:

Event	Description
transfer.created	Share Transfer Configuration Created
transfer.edited	Share Transfer Configuration Edited
transfer.deleted	Share Transfer Configuration Delete
transfer.transferring	Data transfer Started
transfer.transferred	Data transfer Completed
transfer.paused	Data transfer Paused
transfer.failed	Data transfer Failed
table.transferring	Data transfer from a Table Started
table.transferred	Data transfer from a Table Completed
table.failed	Data transfer from a Table Failed
file.transferring	Data transfer from a Cloud Storage FilePath Started
file.transferred	Data transfer from a Cloud Storage FilePath Completed
file.failed	Data transfer from a Cloud Storage FilePath Failed
source.deleted	The Source for this Share has been Deleted

Log Event Payload Examples

Transfer Created

Logged when a user or system creates a Transfer Configuration for a Share.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-05T13:59:05.246Z",
    "eventId": "transfer.created",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer created",
    "eventDescription": "A transfer was created",
    "authorEmail": "user@bobsled.co",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704463144932,
            "lastTransferStatus": "created",
            "transferType": "automated"
        }
    }
}

Transfer Edited

Logged when a user or system edits a Transfer Configuration for a Share.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-08T12:00:42.673Z",
    "eventId": "transfer.edited",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer edited",
    "eventDescription": "A transfer was edited",
    "authorEmail": "user@bobsled.co",
    "extraProperties": {
        "transferId": "2024-01-08_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704715111379,
            "lastTransferStatus": "created",
            "transferType": "automated"
        }
    }
}

Transfer Deleted

Logged when the system deletes the Transfer Configuration for a Share due to a Source being deleted.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-08T13:13:24.668Z",
    "eventId": "transfer.deleted",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer deleted",
    "eventDescription": "A transfer was deleted",
    "authorEmail": "laeg@bobsled.co",
    "extraProperties": {
        "transferId": "2024-01-08_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "sourceId": "00000000-0000-0000-0000-000000000000"
    }
}

Transfer In Progress

Logged when jobs to update data for a Destination have begun.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-05T13:59:05.537Z",
    "eventId": "transfer.transferring",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer started",
    "eventDescription": "A transfer was started",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000",
        "transferMetadata": {
            "createdAt": 1704463144947,
            "lastTransferStatus": "transferring",
            "transferType": "automated"
        }
    }
}

Transfer Complete

Logged when all data for a Share has been transferred to the Destination.

{
    "id": 00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-05T13:59:36.513Z",
    "eventId": "transfer.transferred",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer completed",
    "eventDescription": "A transfer was completed",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704463144947,
            "lastTransferStatus": "transferred",
            "transferType": "automated"
        }
    }
}

Transfer Paused

Logged when a user or system pauses automated data transfer for a Share.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-05T14:03:53.389Z",
    "eventId": "transfer.paused",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer paused",
    "eventDescription": "A transfer was paused",
    "authorEmail": "user@bobsled.co",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704463144947,
            "lastTransferStatus": "paused",
            "transferType": "automated"
        }
    }
}

Transfer Failed

Triggered when a Destination could not be updated due to a failed Transfer.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "ERROR",
    "timestamp": "2024-01-08T11:54:02.852Z",
    "eventId": "transfer.failed",
    "eventEntity": "TRANSFER",
    "eventName": "Transfer failed",
    "eventDescription": "A transfer failed",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-08_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704714660407,
            "errors": [
                {
                    "exception": "FileTransferFailed",
                    "message": "Error - The files failed to transfer to the destination."
                }
            ],
            "lastTransferStatus": "failed",
            "transferType": "automated"
        }
    }
}

Table Transfer Started

Logged when a data transfer from a Source Table has started.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-05T16:06:44.394Z",
    "eventId": "table.transferring",
    "eventEntity": "TRANSFER",
    "eventName": "Table transfer started",
    "eventDescription": "A table transfer was started",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704446489165,
            "destinationType": "table",
            "lastTransferStatus": "transferring",
            "table": {
                "tableName": "A_TABLE_NAME",
                "tableStatus": "started",
                "sourcePaths": ["s3:///s3-file-source/"]
            },
            "transferType": "automated"
        }
    }
}

Table Transfer Completed

Logged when a data transfer from a Source Table has been completed.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-08T12:04:19.172Z",
    "eventId": "table.transferred",
    "eventEntity": "TRANSFER",
    "eventName": "Table transfer completed",
    "eventDescription": "A table transfer was completed",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-08_0002",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704715122622,
            "destinationType": "table",
            "lastTransferStatus": "transferring",
            "table": {
                "tableName": "A_TABLE_NAME",
                "tableStatus": "complete",
                "sourcePaths": ["s3:///s3-file-source/"]
            },
            "transferType": "automated"
        }
    }
}

Table Transfer Failed

Logged when a data transfer from a Source Table has failed.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "ERROR",
    "timestamp": "2024-01-05T19:04:14.390Z",
    "eventId": "table.failed",
    "eventEntity": "TRANSFER",
    "eventName": "Table transfer failed",
    "eventDescription": "A table transfer failed",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704446489165,
            "destinationType": "table",
            "lastTransferStatus": "transferring",
            "table": {
                "tableName": "A_TABLE_NAME",
                "tableStatus": "error",
                "sourcePaths": ["s3:///s3-file-source/"]
            },
            "transferType": "automated"
        }
    }
}

File Transfer Started

Logged when a data transfer from a Source File Path has started.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-08T13:11:14.157Z",
    "eventId": "file.transferring",
    "eventEntity": "TRANSFER",
    "eventName": "File transfer started",
    "eventDescription": "A file transfer was started",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-08_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704719466942,
            "destinationType": "file",
            "file": {
                "filePath": "s3:///s3-file-source/",
                "fileStatus": "started"
            },
            "lastTransferStatus": "created",
            "transferType": "automated"
        }
    }
}

File Transfer Completed

Logged when a data transfer from a Source File Path has been completed.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-08T13:11:23.971Z",
    "eventId": "file.transferred",
    "eventEntity": "TRANSFER",
    "eventName": "File transfer completed",
    "eventDescription": "A file transfer was completed",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-08_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704719466942,
            "destinationType": "file",
            "file": {
                "filePath": "s3:///s3-file-source/",
                "fileStatus": "complete"
            },
            "lastTransferStatus": "created",
            "transferType": "automated"
        }
    }
}

File Transfer Failed

Logged when a data transfer from a Source File Path has failed.

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "ERROR",
    "timestamp": "2024-01-05T19:04:14.390Z",
    "eventId": "file.failed",
    "eventEntity": "TRANSFER",
    "eventName": "File transfer failed",
    "eventDescription": "A file transfer failed",
    "authorEmail": "System Event",
    "extraProperties": {
        "transferId": "2024-01-05_0001",
        "shareId": "00000000-0000-0000-0000-000000000000",
        "transferMetadata": {
            "createdAt": 1704446489165,
            "destinationType": "file",
            "lastTransferStatus": "transferring",
            "file": {
                "filePath": "s3:///s3-file-source/",
                "fileStatus": "error"
            },
            "transferType": "automated"
        }
    }
}

Source Deleted

Logged when the Share Source has been deleted. A Transfer Configuration Delete Log will follow this event

{
    "id": "00000000-0000-0000-0000-000000000000",
    "level": "SUCCESS",
    "timestamp": "2024-01-03T11:47:30.295Z",
    "eventId": "source.deleted",
    "eventEntity": "SOURCE",
    "eventName": "Source deleted",
    "eventDescription": "A source was deleted",
    "authorEmail": "laeg@bobsled.co",
    "extraProperties": {
        "sourceId": "00000000-0000-0000-0000-000000000000",
        "shareId": "00000000-0000-0000-0000-000000000000"
    }
}

Was this article helpful?

What's Next

Installing the AWS CLI

Table of contents

Log Events
Log Event Payload Examples