File Transfer Monitoring
File Transfer is a crucial functionality in the ThingWorx Platform. Monitoring and alerting for file transfer is very important. ThingWorx supports the following metrics for file transfers:
• Queued File Transfer Jobs - This gauge-type metric represents the queued file transfers in the ThingWorx instance at that time. The file transfer job is created and queued in the offline queue as soon as the file transfer is triggered. The metric name is queuedTransferJobs under the GetPerformanceMetrics service of the File Transfer subsystem. For external consumption like Prometheus, this would be available as thingworx_FileTransferSubsystem_queuedTransferJobs under the /Thingworx/Metrics endpoint.
• Active File Transfer Jobs- This gauge-type metric represents the active file transfers in the ThingWorx instance at that time. When file transfer is activated, the transfer job is moved from an offline queue to an active queue. This metric represents the active file transfers. The metric name is activeTransferJobs under the GetPerformanceMetrics service of the File Transfer subsystem. For external consumption like Prometheus, this would be available as thingworx_FileTransferSubsystem_activeTransferJobs under the /Thingworx/Metrics endpoint.
• File Transfer Metrics - There are additional metrics available for file transfers. All of these metrics have a type of counter. The metrics are based on the type and state of the file transfer. File transfer types are upload, download, between repositories, and across edge devices. File transfer states are Started, Completed, Cancelled, and Failed. Different metrics are available for different combinations of file transfer types. For external consumption, like in Prometheus, the file transfer metrics would be available as thingworx_FileTransferSubsystem_{upload/download/acrossRepo/acrossEdge}{Started/Completed/Cancelled/failed}Transfers_total, under the /Thingworx/Metrics endpoint.
For transfers between edge devices, the count is shown under the acrossRepo metrics. For example, when the file transfer between edge devices is started, the acrossRepoStartedTransfers metric is updated. Similarly, if the edge file transfer is cancelled, the acrossRepoCancelledTransfers metric is updated. The other state metrics acrossRepoFailedTransfers and acrossRepoCompletedTransfers are updated when applicable.
 |
Use the GetPerformanceMetrics for single user and GetClusterPerformanceMetrics for High Availability user.
|