Categories

Versions

Get Log (AI Hub) (Admin Tools)

Synopsis

This operator gets the execution log of a job on an AI Hub.

Description

This operator gets the execution log of a job on an AI Hub. The job is identified by the job id parameter and can be obtained either from the AI Hub web interface or by using the Get Jobs (AI Hub) operator. The resulting ExampleSet contains the job id, the log, a flag indicating whether or not the log was truncated, and a totalLines count.

As with other operators in this extension, the input of this operator requires an AI Hub Connection IOObject with sufficient information and credentials (server_url, client_secret, and refresh_token) to access the AI Hub API. You can create an AI Hub connection IOObject in Studio by going to Create Connections selection in the Connections menu. The client_secret and refresh tokens can be obtained by logging to the AI Hub as an administrator in the web interface and then directly navigating to this URL: [server_url]/get-token. If all the information is entered correctly, a new AI Hub Connection IOObject will appear in the Connections folder of your repository. This Connection IOObject now can be connected to any Admin extension operator con input port when needed.

Note: The response time of this operator can vary depending on the size of the log and the current status of the job. If the log is not available for some reason, the operator will wait for a specified amount of time (defined by the sleep time expert parameter) and then try to get the log again. This try-wait loop repeats until it either gets the log or reaches a maximum retry count (defined by the maximum retries expert parameter). If the log is not available at all (e.g. due to cleanups, job agent not available, etc..), the operator will either return an empty ExampleSet or throw an error, depending on the value of the fail on error expert parameter.

Input

  • exa (Connection)

    An AI Hub Connection IOObject.

Output

  • con

    The AI Hub Connection IOObject from the input port, delivered as a passthru.

  • exa (Data table)

    An ExampleSet containing the job id, the log, a flag indicating whether or not the log was truncated, and a totalLines count.

A job id, expressed as a multipart hexadecimal e.g. 45d39d65-9ce0-460c-bc62-5f4ad1fbf5ac The maximum number of lines of the log that the operator can download. If the log exceeds this maximum value, the operator will only return this maximum number of lines (i.e. it will not download the remaining lines). The maximum number of tries (attempts) to get the log. The number of milliseconds between tries (attempts) to get the log. If set to true the operator fails on any error. If set to false the operator returns an empty ExampleSet. Information about the error is pushed to the internal RapidMiner Studio log (i.e. rapidminer-studio.log), viewable via the Log panel.