Edit

Plugin execution logging

Plugin execution logging helps to record the execution time of specific plugins, thus enabling you to gather Bot Task processing analytics. Currently, the following plugin data is recorded:

• robotics-flow
• ocr
• automation-extract (deprecated)
• automation-get-eval-result (deprecated)
• automation-start-eval (deprecated)

warning

Instead of the deprecated plugins, use the following recommended equivalents:

• automation-extract to be replaced with an OOTB AutoML Bridge step
• automation-get-eval-result to be replaced with automl-train-status
• automation-start-eval to be replaced with automl-train-start

General recording rules

A separate record is created for each plugin and each processed HitSubmissionDataItem. This record contains the following items:

• Plugin name
• ID of HitSubmissionDataItem
• Total number of plugin executions in a single Bot Config
• Total time of plugin execution for a single data item
• Number of retry attempts

Table structure

All data is stored in the PluginExecutionLog table:

Column name	Filed description
id	Sequential number
plugin_name	Plugin name as it appears in a Bot Config (for example, robotics-flow).
data_item_id	ID of HitSubmissionDataItem processed by the plugin.
execution_time	Total time of plugin execution in a Bot Config per HitSubmissionDataItem. A Bot Config can include more than one plugin appearance.
execution_count	Total number of plugin executions in a Bot Config per HitSubmissionDataItem. A Bot Config can include more than one plugin appearance.
retry_attempt	Taken from AwsHit table, the processesAttemptCount column.
is_successul	Flag that indicates an exception during the plugin execution. False if an exception was thrown during execution, otherwise true.

Each record can be connected with a tracker (used for transaction tracking) via the hit_id column from the DataItemTrackerHitLink table.

Technical details

• To save a record to the database, an internal REST service is used. Its path is /v1/internal/analytics/bot-execution-log.

• The PluginExecutionLog table is also added to the Data Purge procedure as the table size is equivalent to the size of HitSubmissionDataItem.