OsaLog(TCL_ADM)

OsaLog: OsaLogOpen, OsaLogClose, OsaLog -- interface for logging events to the SCOadmin event log

Syntax

OsaLogOpen object eventType
OsaLogCloselogHandle
OsaLog logHandle instance message

Description

OsaLog provides an interface for logging events into the SCOadmin event log. Basic events are logged automatically by the SCOadmin framework depending on which event types are selected by the SCOadmin Event Log Manager. Callers can provide additional log information as necessary. This interface is typically used by object service agents (OSA).

OsaLogOpen: opens an I/O stream to the SCOadmin event file for a particular object class and a particular valid registered event type.
OsaLogClose: closes the I/O stream and flushes the event data.
OsaLog: logs a message for a specific object instance and event type.

Arguments

object: type of object for which log entries apply, e.g. the class name. There is no strict format imposed on this string, but it should reflect the full vendor/class name pair as used in Object(TCL_ADM) operations to be maximally useful. No error checking is applied to the object name.
eventType: a valid registered event type to log:

notice
warning
error
objectCreation
objectDeletion
attributeValueChange
logHandle: returned by OsaLogOpen, this must be passed as the first argument to OsaLog and OsaClose. This may not be used as a generic Tcl file handle for I/O.
instance: instance of the object for which this log entry applies, the naming attribute.
message: text to be logged for this event.

Notes

The SCOadmin Event Log Manager actually controls which event types are logged and which are ignored.

Files