Tivoli Storage Manager for MVS and OS/390 Administrator's Guide


Logging Tivoli Storage Manager Events to Receivers

The server and client messages provide a record of TSM activity that you, as an administrator, may use to monitor the server. You can log server messages and most client messages as events to one or more repositories called receivers. You can log the events to any combination of the following receivers:

TSM server console and activity log
See Logging Events to the Tivoli Storage Manager Server Console and Activity Log.

File and user exits
See Logging Events to a File Exit and a User Exit.

NetView monitor
See Logging Events to NetView for MVS.

Tivoli event console
See Logging Events to the Tivoli/Enterprise Console.

Event server receiver (Enterprise Event Logging)
Routes the events to an event server. See Enterprise Event Logging: Logging Events to Another Server.

In addition, you can filter the types of events to be enabled for logging. For example, you might enable only severe messages to the event server receiver and one or more specific messages, by number, to another receiver. Figure 65 shows a possible configuration in which both server and client messages are filtered by the event rules and logged to a set of specified receivers:

Figure 65. Event Logging Overview

Event Logging Overview

Controlling Event Logging

To control event logging do the following:

You can issue the BEGIN EVENTLOGGING and END EVENTLOGGING commands to begin and end logging for one or more receivers.

Note:At server start-up event logging begins automatically to the server console and activity log and for any receivers that are started based on entries in the server options file. See the appropriate receiver sections for details.

You can enable or disable specific events or groups of events by receiver by issuing the ENABLE EVENTS and DISABLE EVENTS commands. When you enable or disable events, you can specify the following:

For example, to enable event logging to a user exit for server messages with a severity of WARNING, enter:

enable events userexit warning 

Notes:

  1. Certain events, such as messages that are issued during server start-up and shutdown, automatically go to the console, but cannot be enabled for any other receivers.

  2. Messages in the SEVERE category and message ANR9999 can provide valuable diagnostic information if there is a serious problem. For this reason, you should not disable these messages.

Logging Events to the Tivoli Storage Manager Server Console and Activity Log

Logging events to the server console and activity log begins automatically at server startup. To enable all error and severe client events to the console and activity log, issue the following command:

enable events console,actlog error,severe nodename=*
Note:Enabling client events to the activity log will increase the database utilization. You can set a retention period for the log records by using the SET ACTLOGRETENTION command (see Setting the Activity Log Retention Period). At server installation, this value is set to one day. If you increase the retention period, utilization is further increased. For more information about the activity log, see Using the Tivoli Storage Manager Activity Log.

You can disable server and client events to the server console and client events to the activity log. However, you cannot disable server events to the activity log. Also, certain messages, such as those issued during server startup and shutdown and responses to administrative commands, will still be displayed at the console even if disabled.

Logging Events to a File Exit and a User Exit

You can log events to a file exit and a user exit:

Both file and user exits receive event data in the same data block structure. Setting up logging for these receivers is also similar. Here are the steps involved:

  1. Both types of exits must be specified in the server options file. Here are a few examples:

    File Exits:
    You can specify a file to which event logging begins at server start up and to which new data is appended to any existing data.
    • To specify a binary version of the file named events.fexit, enter:
      fileexit yes events.fexit append
      
    • To specify a readable text version of the file named events.ftexit, enter:
      filetextexit yes events.ftexit append
      

      For a description of the file format, see Readable Text File Exit (FILETEXTEXIT) Format.

    Notes:

    1. When a dataset name is specified without the single quotation marks ('), the system prefixes the user ID associated with the JOB that is running the server. For example, if the FILEEXIT option specifies a name of FILEEXIT.RECEIVER and the user ID is ADMIN, the dataset name will be ADMIN.FILEEXIT.RECEIVER.

    2. For information about allocating the files, see Allocating Datasets for File Exits.

    User Exit:
    Enter the following option to specify a user-written program named EVNTSUXT to which event logging begins at server startup and new data appends to any existing data:
    userexit yes evntsuxt 
    

    For details about these server options, see Administrator's Reference.

  2. If YES was not specified in the server option, you must begin event logging from the administrative client. For example, to begin event logging for a user-defined exit, issue the following command:
    begin eventlogging userexit
    
  3. Enable events for the receiver. Here are two examples of enabling events:

Allocating Datasets for File Exits

When you allocate the dataset for the FILEEXIT receiver, specify the following attributes:

When you allocate the dataset for the FILETEXTEXIT receiver, specify the following attributes:

Logging Events to NetView for MVS

When TSM forwards an event to the NetView receiver, a message is formatted for display with the MVS Write To Operator (WTO) multi-line support. This ensures that a multi-line message is forwarded as one entity to NetView.

Setting up logging for the NetView receiver requires the following steps:

  1. To forward messages to NetView, specify the message IDs in a SYS1.PARMLIB member MPFLSTxx indicating that the message is eligible for processing (AUTO(YES)). For example, to forward message ANE4001E and all messages beginning with ANR55, specify:
    ANE4001E  AUTO(YES)
    ANR55*    AUTO(YES)     
    

    For details about the MPFLSTxx member, see MVS Initialization and Tuning.

  2. Begin event logging by entering this command:
    begin eventlogging netview
    
  3. Enable events. For example, to enable all events enter this command:
    enable events netview all
    

Logging Events to the Tivoli/Enterprise Console

TSM includes the Tivoli receiver, a Tivoli/Enterprise Console (T/EC) adapter for sending events to the T/EC. An event name is a four-digit message number preceded by the appropriate prefix:


Tivoli Data Protection Application Client Prefix Range
TDP for Exchange ACN 3500-3649
TDP for Domino ACD 5200-5299
TDP for Oracle ANS 500-599
TDP for Informix ANS 600-699
TDP for SQL ACO 3000-3999

Notes:

  1. The application client must have enhanced T/EC support enabled in order to route the above messages to the T/EC.

  2. Because of the number of messages, you should not enable all messages from a node to be logged to the T/EC.

Enhanced T/EC support provides unique event classes for messages logged to the T/EC from a Tivoli Storage Manager server. The following examples show the message formats:

where:

For example:

TSM_SERVER_ANR2017 
TSM_SERVER_ANR7805_AIX 
TSM_CLIENT_ANE4027 
TSM_APPL_ANE4990 
TSM_TDP_EXCHANGE_ACN3520

This section describes what you must do to set up Tivoli as a receiver for event logging.

  1. The sample file ANRBAROC, which is distributed with the server, defines the TSM event classes to the T/EC.
    Note:If you have migrated from ADSM Version 3 and have an existing ibmadsm.baroc file, do one of the following:
    • Remove the file.
    • Create a new rule base.
    • Copy the file.
    Before the events are displayed on a T/EC, you must import ANRBAROC into an existing rule base or create a new rule base and activate it by using the following file:
  2. Define an event source and an event group:
    1. From the TME desktop, select Source from the EventServer pop-up menu. From the resulting dialog, define a new source whose name is TSM.
    2. From the TME desktop, select Event Groups from the EventServer pop-up menu. From the resulting dialog, define a new event group for TSM and a filter that includes event classes IBMTSMSERVER_EVENT and IBMTSMCLIENT_EVENT.
    3. From the event console icon, select the Assign Event Group pop-up menu item and assign the new event group to the event console.
    4. Double-click on the event console icon to start the configured event console.
  3. Enable events for logging to the Tivoli receiver. For example, to enable all severe and error server events, enter:
    enable events tivoli severe,error
    
  4. In the server options file, specify the location of the host on which the Tivoli server is running. For example, to specify a Tivoli server at the IP address 9.114.22.345:1555, enter the following:
    techostname 9.114.22.345
    tecport 1555
    
  5. Begin event logging for the Tivoli receiver. You do this in one of two ways:

For details about the server options shown, see Administrator's Reference.

Enterprise Event Logging: Logging Events to Another Server

One or more servers can send server events and events from their own clients to another server for logging. Tivoli Storage Manager provides a receiver at the sending server that receives the enabled events and routes them to a designated event server. At the event server, an administrator can enable one or more receivers for the events being routed from other servers. Figure 66 shows the relationship of a sending TSM server and a TSM event server.

Figure 66. Server to Server Event Logging

Event Logging Overview

The following scenario is a simple example of how enterprise event logging can work.

One or more servers can send events to an event server. An administrator at the event server enables the logging of specific events from specific servers. In the previous example, SERVER_A routes severe, error, and warning messages to SERVER_B. SERVER_B, however, logs only the severe and error messages. If a third server sends events to SERVER_B, logging is enabled only if an ENABLE EVENTS command includes the third server. Furthermore, the SERVER_B determines the receiver to which the events are logged.

Attention: It is important that you do not set up server-to-server event logging in a loop. In such a situation, an event would continue logging indefinitely, tying up network and memory resources. TSM will detect such a situation and issue a message. Here are a few configurations to avoid:

Querying Event Logging

The QUERY ENABLED command displays a list of server or client events that are enabled or disabled by a specified receiver. Because the lists of enabled and disabled events could be very long, TSM displays the shorter of the two lists. For example, assume that 1000 events for client node HSTANFORD were enabled for logging to the user exit and that later two events were disabled. To query the enabled events for HSTANFORD, enter:

query enabled userexit nodename=hstanford

The output would specify the number of enabled events and the message names of disabled events:

998 events are enabled for node HSTANFORD for the USEREXIT receiver.
The following events are DISABLED for the node HSTANFORD for the USEREXIT
receiver:
 ANE4000, ANE49999

The QUERY EVENTRULES command displays the history of events that are enabled or disabled by a specific receiver for the server or for a client node.

query enabled userexit nodename=hstanford


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]