Task Events

Table of Contents

1. Overview
- 1.1. The Event Document
- 1.2. Event Fields
2. Event Inventory
- 2.1. Standard Lifecycle Events
- 2.2. Error Events
  - 2.2.1. Skippable Errors
  - 2.2.2. Terminal Errors

1. Overview

Transfer tasks report their status by emitting events at various stages of the transfer lifecycle.

These events can be used to determine the progress and health of a transfer.

Note

The format and frequency of event messages is subject to change. Currently, events are primarily intended for human monitoring and troubleshooting.

1.1. The Event Document

Example Event Document

{
  "DATA_TYPE": "event",
  "code": "PERMISSION_DENIED",
  "description": "Permission denied",
  "details": "Error (transfer)\nServer: ballen#uc-laptop (Globus Connect)\nFile: /~/Downloads/plus-plan-exposure.png\nCommand: STOR ~/Downloads/plus-plan-exposure.png\nMessage: Fatal FTP response\n---\n500 Command failed. : Path not allowed.\n",
  "is_error": true,
  "time": "2014-07-08 18:50:18+00:00"
}

1.2. Event Fields

Field Name	JSON Type	Description
DATA_TYPE	string	Always has value "event" to indicate this document type.
code	string	A code indicating the type of the event.
is_error	boolean	true if event is an error event
description	string	A description of the event.
details	string	Type specific details about the event.
time	string	The date and time the event occurred, in ISO 8601 format (YYYY-MM-DD HH:MM:SS) and UTC.

2. Event Inventory

2.1. Standard Lifecycle Events

The following events are those most frequently encountered during a transfer’s lifecycle.

Event Code	Notes
SUCCEEDED	Task completed successfully
EXPIRED	Task failed to complete before deadline
CANCELED	Task canceled before completion
STARTED	Task started successfully
PROGRESS	Task is currently in progress
SKIPPED_ERRORS	Task encountered paths with skippable errors and skipped them
DELETE_DESTINATION_EXTRA_SKIPPED	Recursive delete on destination path skipped due to skippable source errors
PAUSED	Transfer paused
UNPAUSED	Transfer unpaused

2.2. Error Events

Errors that are encountered during a Transfer task can be divided into two categories:

Errors that may be skipped
Errors that terminate a transfer (fatal)

The task behavior for skippable errors is controlled by the skip_source_errors flag. For more information on how to configure a task’s error behavior, refer to the Task Document.

For more information about skippable and fatal errors, see Errors.

2.2.1. Skippable Errors

Event Code	Notes
PERMISSION_DENIED	Permission denied
FILE_NOT_FOUND	No file or directory found matching pattern
AMBIGUOUS_PATH	Found more than one object with matching names
CANNOT_EXPORT	Unable to export file

2.2.2. Terminal Errors

Name	Notes
AUTH	Login failed
TIMEOUT	Transfer operation timed out
ENDPOINT_ERROR	Transfer failed due to endpoint `*`
CONNECTION_RESET	Connection to server reset
CONNECTION_BROKEN	Connection to server broken
CONNECT_FAILED	Connection to server was unsuccessful
INTERNAL_ERROR	Internal transfer service error - please contact support@globus.org
QUOTA_EXCEEDED	Storage quota exceeded
NO_APPEND_FILESYSTEM	Filesystem does not allow append
IS_A_DIRECTORY	Requested file is a directory
NOT_A_DIRECTORY	Requested directory is a file
NO_SPACE_LEFT	Out of storage space
ENDPOINT_TOO_BUSY	Endpoint too busy
VERIFY_CHECKSUM	Checksum verification failed
GC_NOT_CONNECTED	Globus Connect is not connected
GC_PAUSED	Globus Connect is paused
MPU_NOT_FOUND	Multi-part upload not found
FILE_SIZE_CHANGED	File size changed during transfer
ACL_CHANGED	Guest collection permissions changed
INVALID_SERVICE_CREDENTIAL	Globus Auth credential is invalid
IS_A_FILE	Requested directory is a file
NOT_A_FILE	Requested file is a directory
INVALID_PATH_NAME	Invalid path name
LIMIT_EXCEEDED	A resource or processing limit was exceeded
EXTERNAL_CHECKSUM_MISMATCH	Source checksum does not match external checksum
INVALID_CHECKSUM	Invalid checksum data received
UNKNOWN	An unknown error occurred - please contact support@globus.org

* The ENDPOINT_ERROR status has a distinct meaning for different Transfer processes:

Transfer Task	Notes on `ENDPOINT_ERROR`
All tasks	Source did not provide a file timestamp
Recursive Transfer	Destination does not support dynamic file exports
Recursive Transfer	Bad entry in GridFTP directory listing response (`MLSC`)
Recursive Transfer	Bad path (contains `/`)
Transfer	No checksum algorithm supported by both endpoints