All Products
Search
Document Center

Dataphin:Runtime configuration

Last Updated:Jan 21, 2025

Dataphin offers tenant-level runtime configuration, enabling you to tailor the timeout period and rerun policy for runtime instances. This customization ensures efficient resource utilization and enhances the reliability of runtime instances. This topic outlines the steps for configuring runtime settings.

Scope of effect

Runtime configuration policies are applicable only to runtime instances that are set to system configuration.

Permission description

By default, only super administrators and system administrators have the authority to modify runtime configurations.

Procedure

  1. Navigate to the Dataphin home page and single click Development -> Task maintenance from the top menu bar.

  2. To access the Global Configuration page, follow the steps below.

    Single click Global Configuration -> Runtime Configuration.

    image

  3. Click Edit to modify the Timeout Configuration and Rerun Configuration in the global settings.

    • Timeout configuration

      Tasks exceeding their runtime threshold will be automatically stopped and marked as failed. The following task types allow for runtime threshold settings:

      Task type

      Description

      One-time Run

      This category includes ad hoc queries, trial runs of computing tasks, smoke testing of logical tables, and trial runs of integration tasks. The default threshold is 2.00 hours.

      Recurring Task

      Encompasses all tasks on a recurring schedule with a default duration of 48.00 hours.

      One-time Task

      Covers one-time instances such as computing tasks, integration, and synchronization, as well as tag test executions. Default duration is 48.00 hours.

      Note

      Configuration parameters can be set from 0.01 (up to 2 decimal places) to 168 hours.

    • Rerun configuration

      Rerun settings determine if tasks will automatically rerun upon failure. The following task types allow for rerun threshold settings:

      • Automatic rerun on failure

        • Rerun count: Specifies the number of automatic reruns after a failure, ranging from 1 to 10 times. The default is 1 time.

        • Rerun interval: Sets the time interval between automatic reruns, ranging from 1 to 60 minutes. The default is 5 minutes.

      • Automatic rerun on timeout failure

        When activated, tasks that exceed the runtime threshold and are terminated by the system will automatically rerun based on the automatic rerun on failure settings. The default setting is disabled.

  4. Once changes are made, click Confirm.

  5. In the confirmation dialog box that appears, click Confirm System Configuration Modification, then click Confirm.

    Important

    Please note that after modifications, tasks associated with instances set to system configuration (including new instances created post-modification and those not yet started) will adhere to the updated settings. The new configuration may take up to 5 minutes to take effect; your patience is appreciated.

Configuration suggestions

Consider the following recommendations when setting configurations to align with your business requirements:

  • One-time run: Set the threshold to the maximum average runtime of ad hoc queries, trial runs of computing tasks, smoke testing of logical tables, and trial runs of integration tasks for the current tenant, plus an additional hour.

  • Recurring Task: Set the threshold to the maximum runtime of all recurring schedule tasks for the current tenant, plus an additional hour.

  • One-time task: Set the threshold to the maximum runtime of all one-time instances (computing tasks, integration, sync), and tag test runs for the current tenant, plus an additional hour.

  • Rerun count: Set the count to the number of successful automatic reruns for all recurring instances, one-time instances, and data backfill instances for the current tenant, plus one additional rerun.

  • Rerun interval: Set the interval to the longest successful rerun interval for all recurring instances, one-time instances, and data backfill instances for the current tenant, plus three additional minutes.