Hewlett-Packard Company makes no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose. Hewlett-Packard shall not be liable for errors contained herein or for incidental or consequential
damages in connection with the furnishing, performance, or use of this material.
This document contains proprietary information, which is protected by copyright. No part of this document may be photocopied, reproduced, or
translated into another language without the prior written consent of Hewlett-Packard. The information is provided “as is” without warranty of any
kind and is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements
accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for
technical or editorial errors or omissions contained herein.
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
Microsoft, Windows, Windows NT, and Windows XP are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
HP Medical Archive Solution audit message reference
The Audit Management System (AMS) service stores audit messages of grid activity and events to a set of
text log files. To enable you to read and analyze the audit trail, this document provides information on the
structure and content of the text file log.
The objectives of this document are to:
• Describe how to access the current log file and archived logs
• Describe the text file format
• Provide a reference for common audit messages
Currency
The content is current with the AMS service software version 4.9.0 through 4.11, as included in the
HP Medical Archive system release 7. To find the version number of your AMS service software:
1. Using the NMS interface, select the AMS service, Overview page.
The version number is reported in the Node Information table.
2. To check the software release version, check the SSM service, Services page. The software release
version is reported in the Packages table as the storage-grid-release. The release should be 7.0 or later.
If you have an earlier version of the AMS service, contact HP Support.
Intended Audience
The content of this guide is intended for administrators responsible for producing reports of network activity
and usage that require analysis of the audit messages.
You are assumed to have a sound understanding of the nature of audited activities within the HP Medical
Archive system. To use the text log file, you are assumed to have access to the configured audit share on
the Admin Node server hosting the AMS service.
References
This document assumes familiarity with many terms related to computer operations and programming,
network communications, and operating system file operations. There is wide use of acronyms. To assist
you, there is a glossary at the back of this reference (page 59).
Conventions
This guide adheres to conventions for terminology to avoid confusion or misunderstanding. There are also
conventions for typography to enhance readability and usefulness of the text.
Terminology
There is some room for confusion between common computer network terminology for “server” and “node”
as they are used in HP Medical Archive products and documents.
A server is usually thought of as a piece of computing hardware that provides data services to requesting
network clients; a resource providing network, computational, and storage services. Within the context of
the HP Medical Archive, a server is an entity hosting one or more grid services.
Nodes in a network are usually defined as an independent entity with a unique network identity, running
on a resource. In this text, the use of the phrase “grid node” refers to an addressable entity on the grid that
provides and uses functional services within the grid to perform one or more tasks. Each grid node has a
unique “node ID”. These include: ADC, CMS and LDR. In the HP Medical Archive User Guide and other
user documents these are referred to as “services”.
Fonts
In contrast, the HP Medical Archive packages the grid service modules into “nodes”. For example, the
“Storage Node” usually incorporates the LDR and SSM services on one server.
To assist you in easily picking out the elements of importance, changes from the standard font are used:
HP Medical Archive Solution audit message reference7
• Items upon which you act are shown in bold. These include:
• Sequences of selections from the navigation tree, tabs, and page options, such as: LDR X
Replication X Configuration.
• Buttons or keys to click or press, such as Apply or <Tab>.
• Radio buttons or check buttons to enable or disable, such as Reset DICOM Counts.
• Field prompts, names of windows and dialogs, messages, and other literal text in the interface is shown
as standard text, such as the LDR State pull down menu, or the Sign In... window.
• Items within the narrative that require emphasis appear in italics.
• Coding samples or interactions with a command terminal are shown in the fixed space font:
version=1.0 ?>
Any italicized portion indicates variable data you provide to meet your needs.
Keyboard keys that use words or standard abbreviations are shown within angle brackets, such as <Ctrl>
for the control key, <Tab>, <space>, and <Enter>.
HP Technical Support
Telephone numbers for worldwide technical support are listed on the HP support Web site:
http://www.hp.com/support/
Collect the following information before calling:
• Technical support registration number (if applicable)
• Product serial numbers
• Product model names and numbers
• Applicable error messages
• Operating system type and revision level
• Detailed, specific questions
<?xml
.
For continuous quality improvement, calls may be recorded or monitored.
Product Warranties
For information about HP StorageWorks product warranties, see the warranty information Web site:
http://www.hp.com/go/storagewarranty
Subscription Service
HP strongly recommends that customers sign up online using the Subscriber's choice Web site:
http://www.hp.com/go/e-updates
• Subscribing to this service provides you with e-mail updates on the latest product enhancements, newest
versions of drivers, and firmware documentation updates as well as instant access to numerous other
product resources.
• After signing up, you can quickly locate your products by selecting Business support and then Storage
under Product Category.
HP Web Sites
For other product information, see the following HP web sites:
• http://www.hp.com
• http://www.hp.com/go/storage
• http://www.hp.com/support/
• http://www.docs.hp.com
.
Documentation Feedback
HP welcomes your feedback.
8
To make comments and suggestions about product documentation, please send a message to
storagedocsfeedback@hp.com. All submissions become the property of HP.
HP Medical Archive Solution audit message reference9
10
1Audit Message Overview
Overview of Auditing
As services in the grid perform various activities and process events, audit messages are generated to
retain a record of grid activity. These messages are processed by the Audit Management System (AMS)
service on the Admin Node server, and are stored in the form of text log files. This document provides
information on the structure and content of the text log files to enable you to read and analyze the audit
trail of grid activity.
Audit Message Flow
Audit messages are generated internally by each grid service. All system services generate audit messages
during normal system operation. These messages are sent to all connected AMS services for processing
and storage, so that each AMS maintains a complete record of grid activity.
Some grid services can be designated as audit message relay services. They act as collection points to
reduce the need for every service to send its audit messages to all connected AMS services. Notice in
Figure 1 that each relay service must send messages to all AMS destinations, whereas services can send
messages to just one relay service.
Figure 1 Audit Message Flow
Relay services are designated at the time the grid topology is configured. In an HP Medical Archive grid,
the ADC service is designated as the audit message relay.
Message Retention
Once an audit message is generated, it is stored on the local server of the originating service until it has
been committed to all connected AMS servers, or a designated audit relay service. The relays in turn store
the message until it is committed at all AMS services. This process includes a confirmation (positive
acknowledgment) to ensure no messages are lost.
HP Medical Archive Solution audit message reference11
Figure 2 Audit Message Retention
Messages arrive at the AMS and are stored in a queue pending confirmed write to the text log file
audit.log. Confirmation of the arrival of messages is sent to the originating service (or audit relay) to permit
the originator to delete its copy of the message.
Only after a message has been committed to storage at the AMS can it be removed from the queue. The
local message buffer at the audit relay service (ADC) and the AMS each have an alarm (AMQS)
associated with it, in the event the backlog becomes unusually large. At times of peak activity, the rate at
which audit messages are arriving may be faster than they can be relayed to the audit repository on the
AMS or committed to storage in the audit log file, causing a temporary backlog that will clear itself when
grid activity declines.
Once a day the active audit log audit.log is saved to a file named for the date the file is saved (in the
format YYYY-MM-DD.txt) and a new audit.log file is started. Audit logs are compressed when they are
seven days old and are renamed YYYY-MM-DD.txt.gz (where the original date is preserved).
Over very long periods of time, this can result in consumption of the 50 GB of storage available for audit
logs on the server hosting the AMS. Once the audit directory on the AMS is full, the oldest log files in the
directory are automatically deleted until the directory contains less than 50 GB. Depending upon the
regulatory or administrative requirements of your enterprise, you may want to archive the compressed audit
log files to some other media such as DVD-R, or into the grid itself.
Message Level Filtering
The AMS service filters incoming audit messages based on settings made in the CMN X Audit component.
OffNo audit messages from the category are logged.
ErrorOnly error messages are logged; those for which the result
12Audit Message Overview
code was not “successful” (SUCS).
Table 1 Audit Message Filter Levels
LevelDescription
NormalStandard transactional messages are logged; all messages
listed in this guide for the category.
DebugTrace messages are logged; for troubleshooting only.
The messages included for any particular level in this table includes those that would be logged at the
higher levels. Therefore, the Normal level includes all of the Error messages.
The “Introduction” section of Chapter 3 (page 19) includes tables that sort the audit messages into the
categories shown in the table (that is, System Messages, Object Storage Messages, Volume Management
Messages, DICOM Messages, HTTP Messages, and File System Gateway Messages). The Volume
Management category of audit messages is used only by Enterprise installations of the HP Medical
Archive. The External category of audit message is only used by external custom applications that submit
audit messages using the HPMA HTTP API.
NOTE: Debug level messages are not included in this reference guide.
Audit Log File Access
The audit file share configured on your Admin Node contains the active audit.log file and any compressed
audit log files. Depending upon the configuration at your site, you can access this file share with either an
NFS or CIFS client.
Access via Microsoft Windows
If using Windows to access network file shares, be aware that some versions of Windows do not support
using two different logins (user name and password combinations) to access the same device (IP address).
That means that if you have one login authentication to access the managed file system of a secondary
FSG service on a combined Admin/Gateway Node, and a different login to access the Audit Log on the
same combined Admin/Gateway Node, you may not be able to have both file shares connected at the
same time. You may be required to disconnect the secondary FSG share before you can connect to the
Audit Log, and vice versa.
Audit File Naming Convention
The active audit log file is named:
audit.log
Once a day, the active audit log is closed and saved to an archived log file named:
YYYY-MM-DD.txt
where date stamp in the file name indicates when the file was archived. If more than one audit log file is
manually created in a single day, subsequent files are named YYYY-MM-DD.txt.1, YYYY-MM-DD.txt.2, etc.
After seven days, these archived log files are compressed, and saved to a file named:
YYYY-MM-DD.txt.gz
where the original date that the file was created is preserved in the file name.
To access a compressed audit log file:
1. Make a local copy of the file to work with.
2. Decompress the file. This process requires a decompression utility. We suggest “7-Zip”, wh ich i s a free
download from:
http://www.7-zip.org/
The next chapter provides details of the file’s internal structure and the syntax of audit messages.
HP Medical Archive Solution audit message reference13
14Audit Message Overview
2File and Message Format
Audit Log File Format
The audit log file at the AMS contains a collection of individual audit messages. Each audit message
contains:
• the UTC time of the event that triggered the audit message (ATIM) in ISO 8601 format (that is,
YYYY-MM-DDTHH:MM:SS.UUUUUU where UUUUUU are microseconds), followed by a space.
• the audit message itself, enclosed within square brackets “[]” and beginning with “AUDT:”. The
message structure is discussed in more detail in the next section.
The following is part of a sample log file. Messages are wrapped within the boundaries shown, ending
after the ASES attribute and double closing brackets “]]”. The “\n” (line feed) characters at the end of each
message are not shown.
Audit messages exchanged within the grid include some standard information common to all messages,
and specific content describing the event or activity being reported.
The following is a sample audit message as it might appear in the audit.log file:
HP Medical Archive Solution audit message reference15
The number of attribute elements in the message depends on the event type of the message.
See “Interpreting a Sample Audit Message” on page 17 for a step-by-step description of how to interpret
an audit message.
Data Types
The data types encountered in the audit messages are:
Table 2 Data Types
TypeDescription
UI32Unsigned long integer (32 bits); it can store the numbers
UI64Unsigned double long integer (64 bits); it can store the numbers
FC32Four Character Constant; a 32-bit unsigned integer value
• ATTR is a four-character code for the attribute being reported. These attributes can either be related
to event-specific messages (as described in Chapter 3, starting on page 19), or may be attributes
common to all audit messages (as described later in this chapter, on page 17).
•
type is a four-character identifier of the programming data type of the value, such as: UI64, FC32,
and so on. See “Data Types” on page 16. The type is enclosed in brackets “( )”.
•
value is the content of the attribute, typically a numeric or text value. Values always follow a colon
“:”. Values of data type CSTR are surrounded by double quotes “ “.
0–4,294,967,295.
0– 18,446,744,073,709,551,615.
represented as four ASCII characters such as: “ABCD”.
IP32IP Address; a 32-bit IP address representation.
CSTRA string; a variable length array of UTF-8 characters. In brief, the
most relevant escaping rules state:
• characters may be replaced by their hexadecimal equivalents
• double quotes are represented as \"
• backslashes are represented as \\
Event-Specific Data
Following the opening “[AUDT:” container that identifies the message itself, the next set of attributes are
items related to the event or action described by the audit message. These attributes are identified in italics
in the sample message below:
The event that these attributes describe is identified using the ATYP element described in “Common
Elements” below. The attributes for each event are described in Chapter 3, “Message Reference” on
page 19.
(in the format \xHH, where HH is the hexadecimal value
representing the character)
16File and Message Format
Common Elements
After the event-specific information is a set of elements common to all audit messages:
Table 3 Common Elements of Audit Messages
CodeTypeDescription
AVERUI32Version—The version of the audit message. As the HP Medical Archive
ATYPFC32Event Type—A four-character identifier of the event being logged. This governs
ATIMUI64Timestamp—The time the event was generated that triggered the audit
software evolves, new versions of services may incorporate new features in
audit reporting. This field enables backward compatibility in the AMS to
process messages from older versions of services.
the “payload” content of the message—the attributes which are included.
message, measured in microseconds since the operating system epoch
(00:00:00 UTC on 1 January, 1970). Note that most available tools for
converting the timestamp to local date and time are based on milliseconds.
Rounding or truncation of the logged timestamp may be required.
The human-readable time that appears at the beginning of the audit message
in the audit.log file is the ATIM attribute in ISO 8601 format. (That is, the date
and time is represented as YYYY-MM-DDTHH:MM:SS.UUUUUU, where the T is
a literal string character indicating the beginning of the time segment of the
date. UUUUUU are microseconds).
ATIDUI64Trace ID—An identifier that is shared by the set of messages that were
triggered by a single event.
ANIDUI32Node ID—The grid node ID assigned to the service that generated the
message. Each service is allocated a unique identifier at the time the
HP Medical Archive is configured and installed. This ID cannot be changed.
AMIDFC32Module ID—A four-character identifier of the module ID that generated the
message. This indicates the code segment within which the audit message was
generated.
ASQNUI64Sequence Count—A counter that is incremented for each generated audit
message on the grid node (ANID). This counter is reset to zero at service
restart. It can be used for consistency checks to ensure that no audit messages
have been lost.
ASESUI64Audit Session Identifier—Indicates the time at which the audit system was
initialized after the service started up. This time value is measured in
microseconds since the operating system epoch (00:00:00 UTC on 1 January,
1970). It can be used to identify which messages were generated during a
given runtime session.
Interpreting a Sample Audit Message
The following is a sample audit message, as it might appear in the audit.log file:
The value of this attribute is FSWO. Consult Chapter 3 to discover that FSWO represents a File Swap Out
event, which logs the removal of a file from the FSG local cache. The table in “FSWO—File Swap Out” on
page 43 documents the attributes reported for FSWO. From this list you can discover, for example, that the
UUID attribute in the audit message records the unique identifier of the file that was swapped out of the
FSG cache:
To discover when the swap-out event occurred, look at the UTC time stamp at the beginning of the audit
message. This value is a human-readable version of the ATIM attribute of the audit message itself
(described in “Common Elements” on page 17):
ATIM records the time, in microseconds, since the beginning of the UNIX epoch. The value
1146620437775242 translates to Wed, 03 May 2006 01:40:37 UTC.
18File and Message Format
3Message Reference
A comprehensive listing of generated audit messages.
Introduction
This chapter provides detailed descriptions of event-specific audit messages, and the attributes reported for
these messages.
Each audit message is first listed in a table that groups related messages by the class of activity that the
message represents. These groupings are useful both for understanding the types of activities that are
audited, and for selecting the desired type of audit message filtering (as described on page 12).
The audit messages are also listed alphabetically by their four-character codes (starting on page 23). This
alphabetic listing facilitates finding information about a specific message of interest.
The four-character codes used throughout this chapter are the ATYP values found in the audit messages, as
shown in the sample message below: