Skip to content

Files

Latest commit

 

History

History

teradata

README.md

Agent Check: Teradata

Overview

Teradata is an enterprise-level relational database management system within a multi-cloud data platform.

This check monitors Teradata through the Datadog Agent. Enable the Datadog-Teradata integration to view Teradata performance, disk usage, and resource consumption.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The Teradata check is included in the Datadog Agent package.

Prepare Teradata

  1. Download and install the Teradata SQL Driver for Python using the embedded agent pip command for your operating system:

Linux

sudo -Hu dd-agent /opt/datadog-agent/embedded/bin/pip install teradatasql

Windows

%PROGRAMFILES%\Datadog\"Datadog Agent"\embedded<PYTHON_MAJOR_VERSION>\python -m pip install teradatasql
  1. Create a read-only datadog user with proper access to your Teradata Database. Start a BTEQ session on your Teradata Database:
CREATE USER "datadog" AS PASSWORD="<PASSWORD>";

Optional, but strongly recommended: Grant a new or existing role to the datadog user designated for read-only monitoring purposes.

GRANT "<READ_ONLY_ROLE>" TO "datadog";

The Teradata system grants the SELECT privilege to PUBLIC on most Data Dictionary views by default. All Teradata Database users have PUBLIC privileges.

  1. To collect resource usage metrics, enable the SPMA Resource Usage Table. This is done with the ctl Teradata Utility:
# Start ctl session
ctl

# View RSS screen
screen rss

# Enable SPMA resource usage table
SPMA=yes

# Save the configuration setting
write

Note: The SPMA Resource Table logs statistics every 10 minutes by default. The logging interval can be configured in the rss screen using ctl. Resource Usage logging may impact database performance. To reduce the frequency of Resource Usage logging, increase the logging interval of the Node Logging Rate setting. See the Teradata documentation for more information on Resource Usage Logging.

  1. The Teradata integration collects disk space metrics from the DBC.DiskSpaceV system view by default. To collect additional disk space metrics on your database tables, enable the collect_table_disk_metrics option.
collect_table_disk_metrics: true

To filter the monitored tables, configure the tables option:

Specify tables to monitor with a list:

tables:
    - <TABLE_1>
    - <TABLE_2>

Customize your monitored tables by specifying a map with the include and exclude options:

tables:
    include:
        - <TABLE_1>
        - <TABLE_2>
    exclude:
        - <TABLE_3>

Configuration

  1. Edit the teradata.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your teradata performance data. See the sample teradata.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent's status subcommand and look for teradata under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Events

The Teradata integration does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.