Bulk API 2.0 Event Type
BulkApi2 events contain details about Bulk API 2.0 requests.
This event type does not include Bulk API requests. For information about the BulkApi event type, see Bulk API Event Type.
You can monitor the following Bulk API 2.0 parameters:
- The type of data processed via Bulk API 2.0 operations, and how much of that data was processed.
- Bulk API 2.0 limits.
- For jobs, track how long it takes to complete, database, and CPU usage.
- Understand users and the operations they performed.
- Detailed errors and failures.
BulkApi2 events represent the steps in the Bulk API 2.0 workflow and changes in job state.
For a Bulk API 2.0 Ingest job, an event is emitted when a job is marked:
createdFor multipart requests, there is no
createdevent emitted, only anuploadCompleteevent.uploadCompleteinProgresswith a processing updatecompleteaborteddeleted
For a Bulk API 2.0 Query job, an event is emitted when a job is marked:
createduploadCompleteinProgresswith a processing updatecompleteaborteddeleted
For details about event monitoring, see the Trailhead Event Monitoring module or REST API Developer’s Guide.
- Type: String
- Description: The IP address of the client that’s using Salesforce services. A Salesforce internal IP (such as a login from AppExchange) is shown as “Salesforce.com IP”.
- Example:
96.43.144.26
- Type: Number
- Description: The CPU time in milliseconds used to complete the request. This field indicates the amount of activity taking place in the app server layer.
- Type: String
- Description: The type of entity that Bulk API 2.0 used.
- Examples:
Account,Contact
- Type: String
- Description: The type of event. The value is always
BulkApi2.
- Type: String
- Description: The 15-character ID of the Bulk API 2.0 job.
- Type: String
- Description: The job’s current status.
- Type: String
- Description: The string that ties together all events in a given user’s login session. It starts with a login event and ends with either a logout event or the user session expiring.
- Example:
GeJCsym5eyvtEK2I
- Type: String
- Description: The type of Bulk API 2.0 operation that was performed.
- Type: Id
- Description: The 15-character ID of the organization.
- Example:
00D000000000123
- Type: Number
- Description: The total number of records that failed.
- Example:
150
-
Type: Number
-
Description: Number of records processed for this event.
-
Example:
980The number of records processed is reported differently for ingest and query jobs.
For ingest jobs:
-
Events with a status of
InProgressreport (if applicable) the number of records processed.
For query jobs:
- Events with a status of
JobCompleteorInProgressreport (if applicable) the number of records processed.
-
-
Type: Number
-
Description: Number of megabytes returned in query. Empty for ingest jobs.
-
Example:
670RESULT_SIZE_MB currently does not emit events, but is shown here as a placeholder for future enhancement.
- Type: String
- Description: The unique ID of a single transaction. A transaction can contain one or more events. Each event in a given transaction has the same
REQUEST_ID. - Example:
3nWgxWbDKWWDIk0FKfF5DV
- Type: Number
- Description: The amount of time that the request took in milliseconds.
- Type: String
- Description: The user’s unique session ID. You can use this value to identify all user events within a session. When a user logs out and logs in again, a new session is started.
- Example:
d7DEq/ANa7nNZZVD
- Type: String
- Description: The access time of Salesforce services in GMT.
- Example:
20130715233322.670
- Type: DateTime
- Description: The access time of Salesforce services in ISO8601-compatible format (
YYYY-MM-DDTHH:MM:SS.sssZ). The timezone is GMT. - Example:
2015-07-27T11:32:59.555Z
- Type: String
- Description: The URI of the page that’s receiving the request.
- Example:
/home/home.jsp
- Type: ID
- Description: The 18-character case-safe ID of the URI of the page that’s receiving the request.
- Type: Id
- Description: The 15-character ID of the user who’s using Salesforce services through the UI or the API.
- Example:
00530000009M943
- Type: Id
- Description: The 18-character case-safe ID of the user who’s using Salesforce services through the UI or the API.
- Example:
00590000000I1SNIA0