A selection of events that ZXTM can raise, along with some useful information about those events that can be used when working with actions.

If you are unfamiliar with the new Event Handling features of ZXTM 5.1, it is recommended that you read this article before continuing.

Note that this article refers to events in ZXTM 5.1. As of Zeus Traffic Manager version 6.0, event tags are listed alongside the event descriptions on the Event Types > Edit page.

Introduction

ZXTM can be configured to perform an action when a particular event, such as a node failing, occurs. When an action is performed it will use information about the event that triggered it to do something useful.

There are a variety of actions that you can create in ZXTM, ranging from writing a log file to executing a program that processes information about the event.

Format of Events

Information about the event is provided to the action that it triggered in the following format:

LEVEL (tab) [section] (tab) primary tag (tab) [tags (tab)]* text

For example, if you stop a virtual server called 'Server1' the following event will be raised:

INFO     vservers/Server1     vsstop     Virtual server stopped

The first two components indicate that the event is an informational message about the virtual server "Server1". The primary tag, vsstop, defines what has happened to that virtual server. There are no additional tags because this event does not affect any other aspects of the configuration. Finally there is a human-readable description of the event that occurred.

SOAP Callback/Control API

The SOAP API and SOAP callbacks (see the Control API manual) use a similar tagging format to identify events.

The 'Event' enumeration in Alerting.EventType and the 'Tag' enumeration in AlertCallback contain tags for the events generated by ZXTM. Each tag is in the format <section>_<primary tag>. The virtual server stopped event, for example, has the tag 'vservers_vsstop'. Using the section and primary tag information from the list below in this way enables you to identify which events have been passed in a SOAP callback.

You can also use this information to create event types with the control API. For example, to create an event type containing the virtual server stopped event you could use the following SOAP call in Perl:

$event_type_interface->addEventType( [ 'Virtual Server Stopped' ],
                                           [ { events => [ 'vservers_vsstop' ] } ] );

Events

The lists below provides an overview of the events that ZXTM can raise. They are divided by the section of the ZXTM configuration that they apply to and then sorted by primary tag. This information can be used when writing programs or parsing log files to process specific events in a certain way.

This knowledgehub article gives an example of how to process events in a program action.

andy knox [Zeus Dev Team] 21 December 2008