15.00 - syscheck - Teradata Database

Teradata Database Utilities

Product
Teradata Database
Release Number
15.00
Content Type
Configuration
Publication ID
B035-1102-015K
Language
English (United States)
Last Update
2018-09-25

syscheck

Purpose  

syscheck monitors the system for signs of congestion that might lead to system slowdowns or perceived hangs and notifies you when Warning or Alert thresholds are reached.

Syntax  

 

Syntax Element.

Description

-D

Displays threshold values for ‑nodeonly and ‑timercontrol tunables in syscheckrc format.

Use this option to redirect the output to quickly create a copy of the syscheckrc file you can customize. Then use the ‑r rscfile option to read from your customized syscheckrc file.

syscheck will not take into account the ‑timercontrol section of the custom syscheckrc file you indicate with the ‑r rscfile option. Because syscheck executes nodecheck locally and on each remote node, modifications to the default and custom syscheckrc files on the local node will be considered for that local spawn of nodecheck. That is, where syscheck is concerned, -timercontrol changes are local, and ‑nodeonly changes global. Where nodecheck is concerned, all changes take effect locally.

-h

Provides basic help on command line options.

-I

Lists threshold values for ‑nodeonly and ‑timercontrol tunables.

-L

Logs the output to a file in the /tpi‑data directory on each node where nodecheck is run.

The default log filename is nodecheck with an extension indicating the TPA cyclecount at the time of the run (for example, nodecheck.2).

You can specify a specific log filename or location using the ‑f log option. Additional tools are executed during logging mode, but their output is sent only to the resulting file. For more information, see “nodecheck” on page 874.

-n nl

Specifies the list of nodes on which nodecheck is invoked.

By default, nodecheck is invoked on all live TPA nodes.

Note: Separate the nodes in the list by commas.

-r rscfile

Specifies an additional resource file whose values will override those in the default syscheckrc file (and optional syscheckrc file, if one exists).

Note: syscheck will not take into account the ‑timercontrol section of the custom resource file you indicate with the ‑r rscfile option. Since syscheck executes nodecheck locally as well as on each remote node, modifications to the default and optional syscheckrc file on the local nodes will be considered for that local spawn of nodecheck. That is, where syscheck is concerned, ‑timercontrol changes are local, and nodeonly changes are global. Where nodecheck is concerned, all changes take effect locally.

-t n

Directs nodecheck to read node‑level resource data from a previously created log file (with a default name) on each node.

nodecheck reads the data from the /tpi‑data/nodecheck.n file, where n indicates the TPA cyclecount at the time of the run.

-v

Displays all the resource values for each node, evaluates the resource values, and notifies you of the status of all tunable resources, regardless of level.

Usage Notes  

syscheck does not automatically reset the system when any threshold is reached. The DBA or operator decides when to reset the system if the congestion persists.

syscheck is a system‑wide tool (as compared to nodecheck, which is node‑only tool) and does the following in this order:

 

IF you invoke syscheck...

THEN syscheck...

without any options

  • spawns an instance of nodecheck on all live TPA nodes.
  • compares the nodecheck results from each node against threshold values indicated in the local syscheckrc file, which are located on the machine where you run syscheck.
  • displays the current resource values on the local node.
  • evaluates the resource values.
  • notifies you of resources which have reached WARN or ALERT levels.
  • with the ‑v option

  • spawns an instance of nodecheck on all live TPA nodes.
  • compares the nodecheck results from each node against threshold values indicated in the local syscheckrc file, which are located on the machine where you run syscheck.
  • displays the current resource values on the local node.
  • evaluates the resource values.
  • notifies you of the status of all tunable resources, regardless of level.
  • syscheck also checks the Teradata PDE and Database states on the node on which you execute syscheck, informing you if either is not in a fully functional state.

    The defined node‑level resource names and threshold values for alerts and warnings are located in the ‑nodeonly section of the syscheckrc configuration file. For more information, see “syscheckrc File” on page 886.

    Example  

    The following is an example of running syscheck with no options.

    syscheck
    Processing resource values for WARN/ALERT status... please wait...
     
    NODE ID: localhost
    Resource                    Current   Current   Threshold   Vproc Number
    Description                 Level     Value     Value       Message Type
    FreeMemory(Pages)           WARN      992       <=1000

    Example  

    The following is an example of running syscheck with the ‑D option to display ‑nodeonly and ‑timercontrol tunables in syscheckrc format.

    syscheck -D
    -nodeonly
    AMPWT          WARN      -0       ALERT     -0
    BNSBLKQ        WARN      500      ALERT     100
    FREEMEM        WARN      -1000    ALERT     -500
    FREESWAP       WARN      -2000    ALERT     -1000
    MSGEVCOUNT     WARN      100      ALERT     300
    RXMSGFC        WARN      90       ALERT     100
    SEGTBLFULL     WARN      80       ALERT     100
    VPRPAGES       WARN      -2       ALERT     -0
    -timercontrol
    SARSAMPLE      1
    SARSLEEP       1
    TDNSTATSAMPLE  1
    TDNSTATSLEEP   1

    Example  

    The following is an example of running syscheck with the ‑I option to display ‑nodeonly and ‑timercontrol tunables.

    syscheck -I
    Tunable        WARN      ALERT
    AMPWT          <=0       <=0
    BNSBLKQ        >=500     >=100
    FREEMEM        <=1000    <=500
    FREESWAP       <=2000    <=1000
    MSGEVCOUNT     >=100     >=300
    RXMSGFC        >=90      >=100
    SEGTBLFULL     >=80      >=100
    VPRPAGES       <=2        <=0
    Tunable        Value
    SARSAMPLE      1
    SARSLEEP       1
    TDNSTATSAMPLE  1
    TDNSTATSLEEP   1

    Example  

    The following is an example of running syscheck with the ‑L option.

    syscheck -L
    Processing resource values for WARN/ALERT status... please wait...
     
    NODE ID: localhost
     
    No tunables show status of WARN or ALERT

    Example  

    syscheck -v
     
    Processing resource values for any status... please wait...
     
    NODE ID: localhost
     
    Resource                   Current   Current   Threshold   Vproc Number/
    Description                Level     Value     Value       Message Type
     
    FreeMemory(Pages)           OK       3158
    FreeSwap(Blocks)            OK       620128
    PDE Msg Daemon Queue Length OK       0
    BNS Block Queue Length      OK       0
    Available AMP Worker Tasks  OK       55                    0
    Available AMP Worker Tasks  OK       56                    1
    BNS Msg Reject%(FC)         OK       0                     RXGRPREC
    BNS Msg Reject%(FC)         OK       0                     RXGRPSEG
    BNS Msg Reject%(FC)         OK       0                     RXP2PREC
    BNS Msg Reject%(FC)         OK       0                     RXP2PSEG
    BNS Msg Reject%(SEGTBLFULL) OK       0                     RXGRPSEG
    BNS Msg Reject%(SEGTBLFULL) OK       0                     RXP2PSEG

    Example - Windows

    syscheck -t 22 -v
    Logfile to be processed: e:\PROGRA~1\Teradata\tdat\tdconfig\tmp\tpi-data\nodecheck.22
    Processing resource values for any status... please wait...
     
    NODE ID: localhost
     
    Resource                   Current   Current   Threshold   Vproc Number/
    Description                Level     Value     Value       Message Type
     
    FreeMemory(Pages)           OK       3207
    FreeSwap(Blocks)            OK       620128
    PDE Msg Daemon Queue Length OK       0
    BNS Block Queue Length      OK       0
    Available AMP Worker Tasks  OK       55                    0
    Available AMP Worker Tasks  OK       56                    1
    BNS Msg Reject%(FC)         OK       0                     RXGRPREC
    BNS Msg Reject%(FC)         OK       0                     RXGRPSEG
    BNS Msg Reject%(FC)         OK       0                     RXP2PREC
    BNS Msg Reject%(FC)         OK       0                     RXP2PSEG
    BNS Msg Reject%(SEGTBLFULL) OK       0                     RXGRPSEG
    BNS Msg Reject%(SEGTBLFULL) OK       0                     RXP2PSEG

    syscheckrc File

    syscheckrc is a text file that contains system, kernel, and Teradata Database-specific parameters. When these parameters are exceeded, your system resources may run low, resulting in poor performance.

    Although not mandatory, all copies of syscheckrc should be identical on all nodes. However, each copy of syscheckrc must correspond to the specific node on which syscheckrc resides.

    Caution:

    Do NOT modify the default syscheckrc file. To create a custom syscheckrc file, see “Creating a syscheckrc File” on page 888.

    The default syscheckrc file is read and processed at the following locations.

     

    On...

    The default syscheckrc file is located in the...

    Linux

    /usr/pde/etc directory.

    Windows

    Program Files\Teradata\TDAT\LPDE\etc directory.

    Default syscheckrc File Example

    syscheck reads and parses the resource files at startup. Resource files have a line-oriented syntax:

  • A line starting with a # is a comment.
  • A line containing only comments or white space (spaces or tabs) is ignored.
  • Each line can have a single resource entry that has name and value strings separated by white space.
  • The following is an example of the default syscheckrc file.

    #-testdriver:
    ## This section is provided as a tool for GSC to provide test input
    ## to syscheck and nodecheck. This section is not meant for
    ## modification by the customer. NOTE: Modification of this
    ## section can yield unexpected errors or results. To override a
    ## tool that is used in nodecheck or syscheck, uncomment the
    ## appropriate line and provide a different path or executable for
    ## the tool.
    #  SAR           %PDE_BIN\sar.exe
    #  PUMA          %PDE_BIN\puma.exe
    #  TDNSTAT       %PDE_BIN\tdnstat.exe
    #  BLMSTAT       blmstat.exe 
    #  VPROCMANAGER  %PDE_BIN\vprocmanager.exe
    #  PDESTATE      %PDE_BIN\pdestate.exe
    #  PCL           %PDE_BIN\pcl.exe
    #  MPPLIST       %PDE_CFG\mpplist
    #  NETECHO       %PDE_BIN\tdinfo.exe
    #  NODECHECK     %PDE_BIN\nodecheck.bat
    #  CONTROLGDO    %PDE_BIN\controlgdo.exe
    #  PDEGLOBAL     %PDE_BIN\pdeglobal.exe
    -nodeonly: This section defines node-only parameters
    AMPWT       WARN -0     ALERT -0
    BNSBLKQ     WARN  500   ALERT  100
    FREEMEM     WARN -1000  ALERT -500
    FREESWAP    WARN -2000  ALERT -1000
    MSGEVCOUNT  WARN  100   ALERT  300
    RXMSGFC     WARN  90    ALERT  100
    SEGTBLFULL  WARN  80    ALERT  100
    VPRPAGES    WARN -2     ALERT -0

    -timercontrol

    # used to override behavior of sar and tdnstat in nodecheck
    # i.e. sar.exe -r SARSLEEP SARSAMPLE
    # values need to be integers >= 1

    SARSLEEP       2
    SARSAMPLE      5
    TDNSTATSLEEP   5
    TDNSTATSAMPLE  2
  • The ‑testdriver section maps to the executables of each node and is different, depending on the platform.
  • Caution:

    Do NOT modify the ‑testdriver section. If you modify the ‑testdriver section, nodecheck and syscheck might fail.

  • The ‑nodeonly section allows you to define the WARN and ALERT threshold levels for each system resource.
  • If the threshold value is negative, then the condition (either WARN or ALERT) will be triggered when that system resource attribute falls below that value. Otherwise, the condition is triggered when the attribute rises above that value.

    The default syscheckrc file contains default values. You should never edit the default syscheckrc file itself. You can customize the warning and alert levels in a custom syscheckrc file. For more information on creating your own customized syscheckrc file, see “Creating a syscheckrc File” on page 888.

    The following table describes each system resource attribute.

     

    System Resource Attribute

    Description

    AMPWT

    Warning and alert threshold level for available (or running out) of AMP work tasks (AWTs).

    BNSBLKQ

    Warning and alert threshold level for BNS services in BNS block queue.

    FREEMEM

    Warning and alert threshold levels for freemem pages.

    FREESWAP

    Warning and alert threshold levels for freeswap blocks.

    MSGEVCOUNT

    Warning and alert threshold levels for message count in PDE message event queue.

    RXMSGFC

    Warning and alert threshold for percentage of message count being flow controlled at the receiver side.

    SEGTBLFULL

    Warning and alert threshold for percentage occupation of multi-segment table entries. 100% indicates that the multi-packet messages are naked or all the multi-packet segment table slots are currently occupied.

  • The ‑timercontrol section allows you to adjust the sample number and sleep time. Currently, only two tools use these parameters:
  • System Activity Reporter (SAR)
  • TDNSTAT utility
  • The value must be an integer greater than or equal to one.

    For the ‑timercontrol section to work on all nodes, you must provide a modified optional syscheckrc file on each node.

    Creating a syscheckrc File

    A custom (modified) syscheckrc file provides a permanent way to override the default syscheckrc resource file settings. Teradata recommends that you use a naming convention for resources, such as an uppercase name.

    You can create an optional syscheckrc file whose values will override those in the default syscheckrc file. The file must be placed in a specific location to be read by syscheck and nodecheck. If a syscheckrc file exists at the specified location, it will be read automatically by syscheck and nodecheck.

    The default and optional syscheckrc files are read from the following locations:

     

    On...

    syscheckrc is stored in the...

    Linux

  • /usr/pde/etc directory (default).
  • /pde directory (optional).
  • Windows

  • Program Files\Teradata\TDAT\LPDE\etc (default).
  • Program Files\Teradata\TDAT\tdConfig (optional).
  • To create an optional syscheckrc file:

    1 Copy the default syscheckrc file to the appropriate optional location noted above. (You can also use the -D option of nodecheck or syscheck and redirect the output to capture the default settings.)

    2 Use a text editor to modify your new file.

    Custom syscheckrc File Example

    The following is an example of a custom-modified syscheckrc file.

    nodecheck -D
    -nodeonly
    AMPWT          WARN      -3       ALERT     -0
    BNSBLKQ        WARN      300      ALERT     600
    FREEMEM        WARN      -500     ALERT     -250
    FREESWAP       WARN      -1000    ALERT     -500
    MSGEVCOUNT     WARN      200      ALERT     400
    RXMSGFC        WARN      75       ALERT     100
    SEGTBLFULL     WARN      75       ALERT     100
    -timercontrol
    SARSAMPLE      1
    SARSLEEP       1
    TDNSTATSAMPLE  1
    TDNSTATSLEEP   1

     

    You can also specify a customized resource configuration file for syscheck and nodecheck to use by specifying the -r option with the configuration file’s path and filename when you start syscheck or nodecheck. The values in this file will override the values in the default and optional syscheckrc files. You should follow the same basic copy-and-edit steps to create this file as noted above for creating an optional syscheckrc file.