ALF/CommonServices/Logging

From Eclipsepedia

Jump to: navigation, search

ALF Wiki Home

NOTE: THIS INTERFACE DEFINITION IS PRELIMINARY

Contents

Introduction

The purpose of this service is to provide a way to explicitly log progress in an ALF Service Flow such that it can be correlated with other log entries made by the ALF Event Manager and other Service Flows. All Log explicit log entries are related to the ALF application they occur in. The logging service uses the content to the ALFEvent message as sent to the ALF service flow to classify the log entry. The body of the log entry can either be sent as single string or can be defined by a named template and an array of name-value pairs. In this case the logging service will build the body of the log entry by substituting the values into the template using the name as a locator.

Logging Operations

Note: The following operation signatures are expressed in a Java like psuedo code format but are not intended to provide a specific language binding. The formal interface for this service will be expressed using schema and WSDL.

Log String

void Log(ALFEventType alfEventContent, string logMessage)

This operation takes an ALF event message and a string provided by the calling application. It is intended for use within an ALF service flow. The operation adds a log entry to the ALF logging facility using data from the ALF event message to classify the log entry. The application specific message will be associated with that log entry.

Log using Template

void Log(ALFEventType alfEventContent, string logTemplateName, nameValue[] content)

This operation takes an ALF event message, a template name and array of named values. It is intended for use within an ALF service flow. The operation adds a log entry to the ALF logging facility using data from the ALF event message to classify the log entry. The application specific message is constructed by the ALF logging facility from a pre-registered template identified by the given template name. The given values are substituted into the template using the name to identify the position of the substitution.

Logging Admin Service Operations

The Logging Admin service is a separate service from the Logging service. Its intent is to allow remote management of the Logging facility providing a way to add, delete, retrieve and list the various Logging templates

Add Template

AddTemplate(string name, string template)

The template is registered with the ALF logging facility using the given name as an identifier. If the name already exists the error ALFError.DuplicateName is raised

Get Template

String GetTemplate(string name)

The logging message template associated with the given name is returned. If the name does not exist the error ALFError.UnknownName is raised

Delete Template

DeleteTemplate(string name)

The logging message template associated with the given name is deleted. If the name does not exist then no action is taken.

List Templates

templateDesc[] ListTemplates()

An array of template descriptors in returned.