Raising Alerts from the XenData Event Log on Windows Storage Server 2003   and Windows Powered NAS

XenData Technical Note 408

Updated: February 14, 2005

Copyright 2004 - 2005 XenData Limited. All rights reserved.

1.  About Windows Storage Server 2003 and Windows Powered NAS

Microsoft® Windows Storage Server 2003 and the Windows Powered NAS operating systems are based on Windows Server 2003 and Windows 2000 Server, respectively, and meet the special needs of network attached storage servers. Both NAS operating systems employ a web user interface, the Web UI, which is an HTML-based application used to configure and manage the server appliance from a remote client.

The Web UI framework supports three types of items: tasks, resources, and alerts:

  • Tasks are used to configure the settings for an item or to perform an action. Examples include setting the server appliance name, IP address configuration, or date and time.

  • Resources are items that have a dynamic status. Examples include printers, Internet connections, and disk drives.

  • Alerts are pieces of information that are displayed to the user. Examples include 'Date and time not set up', and 'Failed connection to the Internet'. Alerts are displayed under the Alerts heading of the main status page and can be sent as emails to designated recipients.

2. About XenData Archive Series Software

XenData Archive Series software manages a Windows file server and provides high performance archiving to a tape library and RAID. The software is ideal for managing large volumes of data generated by applications such as digital video, medical imaging, email archiving, document imaging, aerial photography, satellite imaging and other scientific applications.

The software virtualizes a magnetic disk logical drive (typically on RAID) and a tape library as a single server logical drive which contains a standard Windows file system. The system administrator defines policies that determine where and when files are physically stored. These policies support hierarchical storage management, automatic tape cartridge replication and the use of unalterable WORM tape.

3. XenData Event Log

XenData software generates a wide range of useful event log entries that are stored in a XenData Event Log within the Microsoft event log framework, as illustrated below.

 

4. Raising Alerts from Event Log Entries

The Microsoft NAS operating system allows mapping of event logs to Microsoft Alerts that are displayed on the Web UI status page and may also be sent to designated recipients by email. This is achieved by making appropriate registry updates in the Windows Event Filter. The Windows Event Filter receives notification whenever a new event is sent to the Event Logs and determines whether that event should raise a corresponding Microsoft Alert.

The Administrator can change the registry settings to make XenData Event Log entries generate Microsoft Alerts by editing the HKLM\Software\Microsoft\ServerAppliance\EventFilter\Events  registry key values.

The table below describes the key values that make up an event definition. The example shown creates a Microsoft Alert of type 'Information' whenever a XenData Event with ID 7013 is sent to the Event Logs. Note that Event ID 7013  is of type 'Warning' and it indicates that an off-line file has been requested. In this example the Alert is displayed on the Web UI Status page for 10 minutes and is then automatically cleared.

Value Type Description Example
AbsoluteEventId DWORD AbsoluteEventID is the 32-bit value which, along with the EventSource, uniquely identifies the event. Optional subject to the following conditions:. The registry key must contain values either in AbsoluteEventId, or in both EventID and EventType. If both AbsoluteEventID and EventID are specified, AbsoluteEventID is used. Not present
AddEventStrings DWORD When set to 1, strings from the specified event are obtained. 1
AlertID DWORD Required. Identifier of the Microsoft Alert object to be generated. 1
AlertLog String Required. Identifies the log of the alert. The Alert Log must be identified as an alert definition registry key in the WebElementDefinitions. EventLogDefault
AlertSource String Required with 2003. Always Microsoft_SA_Resource. Not Required with Windows Powered NAS. Microsoft_SA_Resource
AlertType String Optional. AlertType can have the following values: Information, Error, and Warning. If AlertType is not specified, the EventType is used as the AlertType. Information
EventID DWORD Optional, subject to the following conditions: The registry key must contain values either in AbsoluteEventId, or in EventID and EventType. EventID is the 16-bit identifier that appears in the Event Log viewer. 7013
EventSource String Required. Name of the process generating the event, which is used to uniquely identify the event. XenData Archive Series
EventType String Optional, subject to the following conditions: The registry key must contain values either in AbsoluteEventId, or in EventID and EventType. EventType specifies the type of the event and can be the following values: Information, Error, and Warning. Warning
TimeToLive DWORD Optional. The time, in milliseconds, that the alert will be displayed. The alert will not clear automatically if TimeToLive is not set. 600000

This example is further illustrated below.

The alert logs are defined in a registry key located as follows: \SOFTWARE\Microsoft\ServerAppliance\ElementManager\WebElementDefinitions\ . The alert definition should identify an appropriate DLL (such as sagenmsg.dll) that provides the resource to raise the Microsoft alert.

5. Setting Email Alerts

The server appliance can be configured to generate an automatic email notification when a Microsoft Alert is raised. The system can be configured to provide notification when any type of alert is raised or only for specific alert types, such as informational, warning, or critical alerts, as illustrated below.

You may have alert email sent to multiple addresses by typing the addresses into the To box, separated by a comma.

To send email to Microsoft Exchange Server or Lotus Notes, you need to provide the name of the specific SMTP gateway. You must put the SMTP gateway server name, or IP address, in the SMTP server field in the Web user interface (UI).