OA39485: HEARTBEAT FACILITY

Subscribe

You can track all active APARs for this component.

APAR status

  • Closed as new function.

Error description

  • In many system management environments heartbeat solutions are
    utilised to determine the availability of distributed servers,
    applications or application instances. Such solutions rely on
    the distributed resources sending regular heartbeat pulses to
    the central systems management infrastructure with alerts being
    generated for missed heartbeats, i.e. where the heartbeat pulse
    is not received within the expected time frame.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED: All Tivoli Event Pump for z/OS users.        *
    ****************************************************************
    * PROBLEM DESCRIPTION: Request a Heartbeat function be added   *
    *                      to the Tivoli Event Pump for z/OS       *
    *                      product.                                *
    ****************************************************************
    * RECOMMENDATION: Apply the PTF.                               *
    ****************************************************************
    Heartbeat is the new function that allows users to monitor the
    health of running instances of Tivoli Event Pump for z/OS
    application. Heartbeat sends informational events to the Tivoli
    Netcool/OMNIbus servers at each occurrence of a previously
    specified time interval. These informational events are
    generated in the source collector address space and passed
    throughout the event flow chain, i.e. source collector - data
    space - event distributor - probe for Tivoli EIF - Tivoli
    Netcool/OMNIbus. This approach will allow for the monitoring of
    all Event Pump components and communication links. Tivoli
    Netcool/OMNIbus displays a red, down, alert in cases where the
    Heartbeat event is not received for specified period of time.
    The down alert is resolved on the distributed side by any
    incoming Heartbeat message.
    
    The user should add the HEARTBEAT=ON parameter into the master
    address space startup parameters member, (GPZPARMS) to enable
    Heartbeat function.  The HEARTBEAT parameter has the following
    format:
    
    HEARTBEAT= ON | OFF
    
    where OFF is the default value. If the value of the HEARTBEAT
    parameter is different from ON or OFF, the default value is
    used.
    
    The sampling period for Heartbeat events is set by the
    HEARTBEAT_INTERVAL parameter.
    
    HEARTBEAT_INTERVAL=value
    
    The value specified for this parameter is the number of minutes
    that will elapse between heartbeat samples.  The value specified
    must be within the acceptable range of  1, 1440  minutes. This
    is an optional parameter. The default value is 10 minutes.
    
    Both of these parameters effect the Heartbeat only during the
    startup phase of Tivoli Event Pump for z/OS. There are
    additional commands that allow the user to manage the Heartbeat
    function during Event Pump life cycle.
    
      F identifier,HEARTBEAT START - Start Heartbeat for current
                                     instance of Tivoli Event Pump
                                     for z/OS
      F identifier,HEARTBEAT STOP  - Stop Heartbeat for current
                                     instance of Tivoli Event Pump
                                     for z/OS
      F identifier,HEARTBEAT INTERVAL value - Set Heartbeat sampling
                                     period to VALUE minutes
      F identifier,HEARTBEAT PING  - Send a single Heartbeat PING
                                     event
    
    There is an associated distributed platform update for OMNIbus
    probe rules. This update is in MDV 4.2.2.8-TIV-EP-FP0008, and
    can be located on the IBM Tivoli Event Pump support site under
    Downloads.
    

Problem conclusion

Temporary fix

Comments

  • The following information should be added into Chapter 2. Master
    address space parameters (GPZPARMS) of Configuration Reference
    for IBM Tivoli Event Pump for z/OS Version 4.2.2 documentation:
    
    HEARTBEAT
    
    Purpose
    
    Enable Heartbeat function during startup phase of Tivoli Event
    Pump for z/OS.
    
    Syntax
                        +--OFF--+
                        |       |
    >>--- HEARTBEAT= ---+-------+---><
                        |       |
                        +--ON---+
    
    Operand Descriptions
    
    ON  Enable Heartbeat function during startup phase of Tivoli
        Event Pump for z/OS.
    OFF Disable Heartbeat function during startup phase of Tivoli
        Event Pump for z/OS. This is a default value.
    
    Usage Notes
    
    If the value specified for the HEARTBEAT parameter is not ON or
    OFF, the default value is used.
    
    This statement is also valid for the source collector (GTMPUMP)
    startup procedure in a 3-address-space environment.
    
    HEARTBEAT_INTERVAL
    
    Purpose
    
    Set sampling period in minutes for Tivoli Event Pump for z/OS
    Heartbeat events.
    
    Syntax
                                 +----10-----+
                                 |           |
    >>--- HEARTBEAT_INTERVAL= ---+-----------+---><
                                 |           |
                                 +--minutes--+
    
    Operand Descriptions
    
    minutes    Specifies sampling period in minutes for Tivoli Event
               Pump for z/OS Heartbeat events.  1, 1440  is allowed
               limits for heartbeat interval. This is an optional
               parameter, default value is 10 minutes.
    
    Usage Notes
    
    This statement is also valid for the source collector (GTMPUMP)
    startup procedure in a 3-address-space environment.
    
    The following information should be added into Chapter 2. Source
    collector component modify commands of the Command Reference for
    IBM Tivoli Event Pump for z/OS Version 4.2.2 documentation:
    
    HEARTBEAT
    
    Purpose
    
    The HEARTBEAT command manages Heartbeat function during the
    Event Pump life cycle. It allows the user to start and stop
    Heartbeat function, change the Heartbeat messages sampling
    period and issue a single PING event.
    
    Syntax
                                    +--START------------+
                                    |                   |
    >>--- F identifier,HEARTBEAT ---+--STOP-------------+---><
                                    |                   |
                                    +--PING-------------+
                                    |                   |
                                    +--INTERVAL value --+
    Parameters
    
    identifier  The source collector or the master address space.
    value       Heartbeat events sampling period in minutes.
                 1, 1440  is allowed limits for heartbeat interval.
    
    Usage
    
    F identifier,HEARTBEAT START
    
        Start Heartbeat for current instance of Tivoli Event Pump
        for z/OS.
    
    F identifier,HEARTBEAT STOP
    
        Stop Heartbeat for current instance of Tivoli Event Pump
        for z/OS.
    
    F identifier,HEARTBEAT INTERVAL value
    
        Set the Heartbeat sampling period to value minutes. Used to
        change the Heartbeat sampling period on the fly while the
        Event Pump is currently active.
    
    F identifier,HEARTBEAT PING
    
        Send a single Heartbeat PING event. Used to check for
        connectivity issues between Tivoli Event Pump for z/OS and
        Tivoli Netcool/OMNIbus servers.
    
    The master address space (GPZPUMP) or the source collector
    address space (GTMPUMP) is the target of the command.
    
    Examples
    
    GTM7517I  CMD=HEARTBEAT START
    GTM5601I  PUBLISHING HB       QUEUE COMPLETED
    GPZ5900I HEARTBEAT STARTED
    
    GTM7517I  CMD=HEARTBEAT INTERVAL 100
    GPZ5907I HEARTBEAT SAMPLING PERIOD SET TO 100 MINUTE(S)
    
    GTM7517I  CMD=HEARTBEAT PING
    GPZ5909I HEARTBEAT PING COMMAND COMPLETE
    
    GTM7517I  CMD=HEARTBEAT STOP
    GPZ5901I HEARTBEAT STOPPED
    
    The following information should be added into Chapter 2. GPZ
    prefix messages of the Message Reference for IBM Tivoli Event
    Pump for z/OS Version 4.2.2 documentation:
    
    GPZ5900I HEARTBEAT STARTED
    
    Explanation:  Heartbeat facility started. Connection failures
                  or Event Pump abends will be monitored on OMNIbus
                  side and alerted.
    
    Message variables:  None
    
    System action:  Processing continues.
    
    Administrator response:  None
    
    GPZ5901I HEARTBEAT STOPPED
    
    Explanation: Heartbeat facility stopped. Connection failures or
                 Event Pump abends will not be monitored on OMNIbus
                 side and alerted.
    
    Message variables: None
    
    System action: Processing continues.
    
    Administrator response: None
    
    
    GPZ5902W HEARTBEAT ALREADY STARTED
    
    Explanation: User requested Event Pump to start Heartbeat
                 facility but it is already started.
    
    Message variables: None
    
    System action: Processing continues.
    
    Administrator response: None
    
    
    GPZ5903W HEARTBEAT ALREADY STOPPED
    
    Explanation: User requested Event Pump to stop Heartbeat
                 facility but it is already stopped during previous
                 request.
    
    Message variables: None
    
    System action: Processing continues.
    
    Administrator response: None
    
    
    GPZ5904W HEARTBEAT INTERVAL CONTAINS INVALID DATA, USE DEFAULT
    VALUE
    
    Explanation: User specified invalid value for sampling period
                 of Heartbeat facility. This value might contain
                 nonnumeric or unreadable data.
    
    Message variables: None
    
    System action: Default value is used for Heartbeat sampling
                   period, processing continues.
    
    Administrator response: Correct the Heartbeat sampling period
                            value.
    
    
    GPZ5905W HEARTBEAT INTERVAL EXCEEDS TIME LIMITS OF  min, max
    MINUTES, USE DEFAULT VALUE.
    
    Explanation: User specified a sampling period for Heartbeat that
                 exceeds allowed limits.
    
    Message variables:
    
    min - minimum level for Heartbeat sampling period
    max - maximum level for Heartbeat sampling period
    
    System action: Default value is used for Heartbeat sampling
                   period, processing continues.
    
    Administrator response: Correct the Heartbeat sampling period
                            value.
    
    
    GPZ5906W HEARTBEAT STOPPED, CAN NOT PERFORM SPECIFIED ACTION
    
    Explanation: User requested Heartbeat to perform a command but
                 the Heartbeat facility was not started or already
                 stopped. Specified command was not executed.
    
    Message variables: None
    
    System action: Processing continues.
    
    Administrator response: Start the Heartbeat and repeat action if
                            needed.
    
    
    GPZ5907I HEARTBEAT SAMPLING PERIOD SET TO value MINUTE(S)
    
    Explanation: Heartbeat sampling period is set to value
                 minute(s)
    
    Message variables:
    
    value - sampling period in minutes
    
    System action: Processing continues.
    
    Administrator response: None
    
    
    GPZ5908E AN UNEXPECTED ERROR OCCURED IN THE HEARTBEAT AT RUN
    TIME
    
    Explanation: An unexpected error occurred in the Heartbeat
                 address space at run time
    
    Message variables: None
    
    System action: Heartbeat stops, processing continues.
    
    Administrator response: Contact IBM support.
    
    
    GPZ5909I command COMMAND COMPLETE
    
    Explanation: Specified command completed.
    
    Message variables:
    
    command - requested command to be executed.
    
    System action: Processing continues.
    
    Administrator response: None
    

APAR Information

  • APAR number

    OA39485

  • Reported component name

    EVENT PUMP FOR

  • Reported component ID

    5698B3400

  • Reported release

    422

  • Status

    CLOSED UR1

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    YesSpecatt / New Function

  • Submitted date

    2012-05-05

  • Closed date

    2013-10-21

  • Last modified date

    2013-11-04

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

    UA71139

Modules/Macros

  • GPZHBMGR GPZMSGTB GTMPARMP GTMRX004 GTMRX999
    

Publications Referenced
SC27404000 SC27404100      

Fix information

  • Fixed component name

    EVENT PUMP FOR

  • Fixed component ID

    5698B3400

Applicable component levels

  • R422 PSY UA71139

       UP13/10/23 P F310

Fix is available

  • Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.



Rate this page:

(0 users)Average rating

Document information


More support for:

Tivoli Event Pump for z/OS

Software version:

422

Reference #:

OA39485

Modified date:

2013-11-04

Translate my page

Machine Translation

Content navigation