The Tetra File-Log Agent generates the following event types.

📘

NOTE

To set up event subscriptions for any of the following events, see Event Subscriptions.

Tetra File-Log Agent Event Types

agents.filelog.scanStarted.v1

A scan of a given path starts. This particular scan operation has a unique identifier associated with it, which is included in the event as scanId.

Event-Specific Data Example for agents.filelog.scanStarted.v1 Events

{
  "scanId": "a3c3af8c-a28d-4bbb-8323-797c39a45b69",
  "path": "C:\tmp\test3\",
  "startDate": "2023-01-11T00:00:00",
  "interval": 30,
  "fileWatchMode": "File",
  "sourceType": "unknown",
  "patterns": [
    "*/.*"
  ],
  "labels": [
    {
      "name": "instrument",
      "value": "akta"
    },
    {
      "name": "instrument_id",
      "value": "123"
    }
  ],
  "metadata": {
    "metadata1": "value1",
    "metadata2": "value2"
  },
  "tags": [
    "tag1",
    "tag2"
  ]
}

agents.filelog.scanCompleted.v1

A scan operation (identified by scanId) has completed. fileCount indicates the number of files found.

Event-Specific Data Example for agents.filelog.scanCompleted.v1 Events

{
  "scanId": "a3c3af8c-a28d-4bbb-8323-797c39a45b69",
  "path": "C:\tmp\test3\",
  "fileWatchMode": "File",
  "fileCount": 15,
  "duration": "00:00:00.0362367"
}

agents.filelog.pathValidationFailed.v1

A file's path validation fails (is inaccessible) before scan operation starts.

Event-Specific Data Example for agents.filelog.pathValidationFailed.v1 Events

{
  "path": "C:\invalid\",
  "fileWatchMode": "File",
  "error": "Path 'C:\invalid\' does not exist or the Agent Group User does not have read permission\r\n"
}

agents.filelog.fileScanned.v1

A file has been scanned and identified for upload. This event is raised after the file has been persisted to the local SQLite database.

Event-Specific Data Example for agents.filelog.fileScanned.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "osFolderPath": null,
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "changeDetectedBy": "Event",
  "scanId": "",
  "changeDescription": "New file detected.",
  "lastModifiedDate": "2023-02-16T16:25:17.8938926+00:00",
  "createDate": "2022-08-15T14:19:48.9528332+00:00",
  "reprocessAsOfDate": "2023-02-16T01:07:16.3240697+00:00",
  "isNew": true
}

agents.filelog.scanError.v1

An error occurs during a scan. For example, an IO exception occurs when trying to access a directory in a path.

Event-Specific Data Example for agents.filelog.scanError.v1 Events

{
  "path": "c:\tmp\InvalidDirectory",
  "error": "An IO exception has occurred attempting to access directory.",
  "scanId": "a3c3af8c-a28d-4bbb-8323-797c39a45b69"
}

agents.filelog.fileUploadStarted.v1

A file upload begins.

Event-Specific Data Example for agents.filelog.fileUploadStarted.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "osFolderPath": null,
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "fileSize": 10
}

agents.filelog.fileUploadCompleted.v1

A file upload has completed successfully.

Event-Specific Data Example for agents.filelog.fileUploadCompleted.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "osFolderPath": null,
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "fileLastModifiedDate": "2023-02-16T16:25:17.8938926+00:00",
  "fileCreateDate": "2022-08-15T14:19:48.9528332+00:00",
  "fileScanDate": "2023-02-16T16:25:24.955+00:00",
  "reprocessAsOfDate": "2023-02-16T01:07:16.3240697+00:00",
  "copyFileStartTime": "2023-02-16T16:25:48.6362834+00:00",
  "copyFileCompleteTime": "2023-02-16T16:25:48.6362834+00:00",
  "uploadFileStartTime": "2023-02-16T16:25:48.6525983+00:00",
  "fileSize": 10,
  "checksumAlgorithm": "MD5",
  "checksum": "0B01LUbONRqDtMWXNMY9mQ=="
}

agents.filelog.fileUploadFailed.v1

An error occurs before or during the upload of a file.

Event-Specific Data Example for agents.filelog.fileUploadFailed.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test.txt",
  "osFilePath": "c:\tmp\test3\test.txt",
  "osFolderPath": null,
  "fileId": "4165a50a-5efd-4e05-9453-9fb2cc959b1d",
  "traceId": "4165a50a-5efd-4e05-9453-9fb2cc959b1d",
  "fileSize": 10,
  "error": "upload failed reason"
}

agents.filelog.fileArchiveStarted.v1

File archiving begins for a file.

Event-Specific Data Example for agents.filelog.fileArchiveStarted.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "fileSize": 10,
  "archivePath": "c:\archive\55953bf0-acb6-4a45-beb6-cb30b33d4941\c\tmp\test3\test5.txt",
  "checksumAlgorithm": "MD5",
  "checksum": "0B01LUbONRqDtMWXNMY9mQ=="
}

agents.filelog.fileArchiveCompleted.v1

A file is successfully archived.

Event-Specific Data Example for agents.filelog.fileArchiveCompleted.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "fileSize": 10,
  "archivePath": "c:\archive\55953bf0-acb6-4a45-beb6-cb30b33d4941\c\tmp\test3\test5.txt",
  "deleteAfter": "2023-02-16T16:32:03.9793437+00:00",
  "checksumAlgorithm": "MD5",
  "checksum": "0B01LUbONRqDtMWXNMY9mQ=="
}

agents.filelog.fileArchiveFailed.v1

An error occurs during file archival.

Event-Specific Data Example for agents.filelog.fileArchiveFailed.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test4.txt",
  "osFilePath": "c:\tmp\test3\test4.txt",
  "fileId": "aa79b19f-6c99-49cf-bdff-68c8f927b6b6",
  "traceId": "aa79b19f-6c99-49cf-bdff-68c8f927b6b6",
  "error": "Source file has been removed but could not locate the archive file 'c:\archive\55953bf0-acb6-4a45-beb6-cb30b33d4941\c\tmp\test3\test4.txt'."
}

agents.filelog.fileArchiveSkipped.v1

File archiving for a file is skipped because of a missing checksum for the source file. This occurs when the file was originally uploaded by a previous version of the File-Log Agent, which didn't calculate and store the checksum at upload time.

Event-Specific Data Example for agents.filelog.fileArchiveSkipped.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test4.txt",
  "osFilePath": "c:\tmp\test3\test4.txt",
  "fileId": "aa79b19f-6c99-49cf-bdff-68c8f927b6b6",
  "traceId": "aa79b19f-6c99-49cf-bdff-68c8f927b6b6",
  "reason": "Uploaded file does not have a checksum calculated."
}

agents.filelog.archiveFileDeleteCompleted.v1

A file is successfully deleted from the archive location.

Event-Specific Data Example for agents.filelog.archiveFileDeleteCompleted.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "archiveFilePath": "c:\archive\55953bf0-acb6-4a45-beb6-cb30b33d4941\c\tmp\test3\test5.txt",
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "fileSize": 10
}

agents.filelog.archiveFileDeleteFailed.v1

An error occurs during archive file deletion.

Event-Specific Data Example for agents.filelog.archiveFileDeleteFailed.v1 Events

{
  "filePath": "/R90W9HZ4/c/tmp/test3/test5.txt",
  "osFilePath": "c:\tmp\test3\test5.txt",
  "archiveFilePath": "c:\archive\55953bf0-acb6-4a45-beb6-cb30b33d4941\c\tmp\test3\test5.txt",
  "fileId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "traceId": "31a2c6f0-c181-43aa-a9a3-cdf168cdb522",
  "error": "failure reason"
}

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘

NOTE

Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.