Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [Util] >  [Log]
Private  Storage   

persistent class Ens.Util.Log extends %Persistent, Ens.Util.LogBase, %XML.Adaptor

This class defines the primary Event log.
Applications can execute queries against this data if they wish but should not invoke these methods directly. Instead, use the macros defined in Ensemble.inc (e.g., $$$LOGINFO et al).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 12 4


Summary

Properties
%Concurrency ConfigName Job MessageId SessionId
SourceClass SourceMethod Stack Text TimeLogged
TraceCat Type

Methods
%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %BuildIndicesSegment %BuildObjectGraph
%CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion %ClassName
%Close %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DowngradeConcurrency %ExecuteAfterTriggers %ExecuteBeforeTriggers
%Exists %ExistsId %Extends %FileIndices
%FileIndicesBuffered %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IncrementCount
%InsertBatch %IsA %IsModified %IsNull
%JournalObject %KillExtent %KillExtentData %LoadFromMemory
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PhysicalAddress %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %SQLAcquireLock
%SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers %SQLBuildIndices
%SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique %SQLCheckUniqueIndices
%SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol %SQLCreateInsDelTables
%SQLDefineiDjVars %SQLDelete %SQLDeleteChildren %SQLDeleteTempStreams
%SQLEExit %SQLExists %SQLFKeyDelLock %SQLFastInsert
%SQLFieldValidate %SQLGetLock %SQLGetOld %SQLGetOldAll
%SQLGetOldIndex %SQLInsert %SQLInsertComputes %SQLInsertStreams
%SQLInvalid %SQLInvalid2 %SQLMVDelete %SQLMVIndexDelete
%SQLMVIndexInsert %SQLMVIndexUpdate %SQLMVInsert %SQLMVUpdate
%SQLMissing %SQLNormalizeCompFields %SQLNormalizeFields %SQLPurgeIndices
%SQLQuickBulkInsert %SQLQuickBulkLoad %SQLQuickBulkSave %SQLQuickBulkUpdate
%SQLQuickDelete %SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey
%SQLQuickInsert %SQLQuickLoad %SQLQuickLoadChildren %SQLQuickLogicalToOdbc
%SQLQuickOdbcToLogical %SQLQuickUpdate %SQLReleaseLock %SQLReleaseTableLock
%SQLStorageValidation %SQLTrigDelTab %SQLTrigInsTab %SQLUnlock
%SQLUnlock2 %SQLUnlockError %SQLUnlockRef %SQLUpdate
%SQLUpdateComputes %SQLUpdateStreams %SQLValidateCompFields %SQLValidateFields
%SQLicompView %SQLnBuild %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %UpgradeConcurrency %ValidateIndices %ValidateObject
%XMLGenerate Log LogAlert LogAssert
LogError LogInfo LogNoTrace LogStatus
LogTrace LogWarning Purge PurgeBitmaps
SendToMonitor XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
trail


Parameters

• parameter XMLTYPE = "LogEvent";
This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Methods

• classmethod Log(pLogType As Ens.DataType.LogType, pSourceClass As %String, pSourceMethod As %String, pMsgText As %String, pFramesToHide As %Integer = -1)
• classmethod LogAlert(pSourceClass As %String, pSourceMethod As %String, pMsgText As %String = "")
• classmethod LogAssert(pSourceClass As %String, pSourceMethod As %String, pMsgText As %String = "")
• classmethod LogError(pSourceClass As %String, pSourceMethod As %String, pMsgText As %String = "")
• classmethod LogInfo(pSourceClass As %String, pSourceMethod As %String, pMsgText As %String = "")
• classmethod LogNoTrace(pLogType As Ens.DataType.LogType, pSourceClass As %String, pSourceMethod As %String, pMsgText As %String, pFramesToHide As %Integer = -1, pTraceCategory As %String = "")
• classmethod LogStatus(pSourceClass As %String, pSourceMethod As %String, pStatus As %Status, pFramesToHide=-1)
• classmethod LogTrace(pSourceClass As %String, pSourceMethod As %String, pMsgText As %String = "", pTraceCategory As %String)
• classmethod LogWarning(pSourceClass As %String, pSourceMethod As %String, pMsgText As %String = "")
• classmethod Purge(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7, pDummy As %Boolean, pBitmapChunkLimit As %Integer = 500) as %Status
• classmethod SendToMonitor(EventID As %Integer)
Signal the Event Log entry to an external Monitor system
• classmethod trail(string, width)

Indices

•index (ConfigName on ConfigName) [Type = bitmap];
•index (Extent on ) [Extent,Type = bitmap];
•index (TimeLogged on TimeLogged);
•index (Type on Type) [Type = bitmap];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.