Adding or Copying a Canary Query

Teradata Viewpoint User Guide

brand
Analytical Ecosystem
prodname
Teradata Viewpoint
vrm_release
16.00
category
User Guide
featnum
B035-2206-106K
  1. From the Systems list, click the name of the Teradata Database system you want to update.
  2. From the Setup list, click Canary Queries.
  3. Do one of the following:
    Option Description
    Add Click to add a canary query.
    Copy Click in the row of the canary query you want to copy.
  4. Enter a name for the canary query.
  5. [Optional] Select the Enable query check box to enable the canary query.
  6. Under SQL, enter or modify the SQL for the query.
  7. Under Default Database, specify the default database.
  8. If Login appears, select the login you want to use to run the system task.
    1. [Optional] Select the Log in each time the query executes check box to force a new log in connection to the Teradata system each time that the query runs.
    2. [Optional] Enter a timeout value. The value indicates the number of seconds before abandoning the attempt to log in to the Teradata system. Enter a value only if you selected the Log in each time the query executes check box. You cannot add an alert action for a log in timeout for a System Heartbeat canary query.
  9. For Collect Data Every, specify the data collection frequency in minutes. The recommended sample rate is 2 minutes. The initial retention policy is 1 year.
  10. Under Execute, select one of the following options:
    Option Description
    24/7 Select 24/7 to execute the query 24 hours a day, 7 days a week.
    Custom
    1. Select Custom to execute the query during a time frame.
    2. Specify the start time and end time.
    3. Specify the start day and end day.
  11. Under Delete Data, select one of the following options:
    Option Description
    Date
    1. Select the After check box to set the calendar retention period.
    2. Enter a number and select a calendar value.
    Size
    1. Select the Over check box to set the file size retention period.
    2. Enter a number and select a file size restriction.
      The size of the data actually retained by the collector is always larger than the specified number because data clean up only drops table partitions that exceed this number. A 1024 byte kilobyte is used, so 1 GB is actually 1,073,741,824 bytes.
    Teradata Viewpoint uses a retention policy to keep collected data for a time period or up to a certain size. For more information, see Data Collector Sample Rates.
  12. Click Apply. If the operation is successful, appears. If the operation fails, appears. If you receive an error, verify that the settings are correct and try again.