Track activities and events > Sentinel > Heartbeat Tracked Object

HeartBeat Tracked Object

Introduction

heartbeat.xml is a Sentinel Tracked Object that enables you to monitor Interchange and Secure Relay (DMZ) node status. This Tracked Object also sends information about causes of unexpected node and Secure Relay shutdowns.

Cluster monitoring

The HeartBeat Tracked Object is of particular value in monitoring Interchange cluster status. You can use heartbeat to:

Secure Relay monitoring

The Secure Relay (DMZ) reporting of heartbeat life cycles is independent from Interchange heartbeat node monitoring. The Secure Relay heartbeat has its own cycleId/timestamp.

Activate HeartBeat

To activate and use the HeartBeat Tracked Object in your Interchange implementation:

  1. Install Sentinel and Composer.
  2. Deploy heartbeat.xml to Sentinel.
  3. To do this, you import heartbeat.xml to Composer and then deploy the imported Tracked Object from Composer to Sentinel.
  4. In the Interchange UI, activate the function.
  5. To do this, go to the Integrate the trading engine with Sentinel page, and select the option Send heartbeats for the trading engine cluster. For descriptions of all Sentinel options on this page, see Integrate with Axway Sentinel.

Deactivate Heartbeat

To deactivate heartbeat notifications to Sentinel:

  1. Open a session in the Interchange user interface.
  2. Click Trading configuration on the toolbar to open the Communities page.
  3. Click Configure Sentinel integration to open the Integrate the trading engine with Sentinel page.
  4. On the Sentinel tab, clear the option Send heartbeats for the trading engine cluster.
  5. Click Save changes.

Heartbeat attributes

The following table lists the attributes that Heartbeat sends to Sentinel.

Attribute Description Value
CycleId

Based on the node startup time. This ID is used for the constant heartbeat when the singleton fails over to another node in the cluster.

Example value:

1406620945548
EventDate Current date on the running node.

Example value:

2014-06-14
EventId The unique event identification number generated by Interchange.

Example value:

1163521349929
EventTime Current time on the running node, in format hh:mm:ss. Example value: 14:26:51
GMTDiff

The number of minutes between local time and GMT.

Example value:

-420
IsAlert

Indicates whether the event is in an alert state.

0= no

1= yes
IsEnd Indicates whether the event is completed.

0 = event not end

1 = event completed
IsException

Indicates whether the event is in an exception state.

0= no

1= yes
ObjectId The type of Sentinel Tracked Object that generated the data. This is the same ID for all Sentinel heartbeat reporting. 899942214
ProductIPAddr Hostname of the machine on which the node where the cluster singleton that is reporting the heartbeats is running. Host of the node (Interchange or Secure Relay node) that is reporting the status
ProductName

Product name of Interchange.

 Interchange
ProductOS

Name of the operating system on the computer running Interchange.

Example value:

"Windows XP"
ReturnMessage Node name + reason for an alert or exception status. Example value: "TE(my_trading_engine) IE(my_integraton_engine(unknown))"
State Event state (Alert, Warn Active) reported to Sentinel by Interchange.
  • Alert – ISALERT=1, ISEXCEPTION=0
  • Warn – ISALERT=0, ISEXCEPTION=1
  • Active – ISALERT=0, ISEXCEPTION=0
  • RETURNMESSAGE – if anything is specified about the reason for isAlert or isException.
ProductId The name of the node where the cluster singleton that is reporting the heartbeats is running. ID of the node (Interchange or Secure Relay node) that is reporting the status.
Delay Time in seconds between heartbeat events.

Default = 60. This value can be modified in the Interchange user interface.

See Integrate with Axway Sentinel.