persistent class apptools.core.Log
extends %Persistent
• parameter Null = "Null";
Replacement for missing values
• property Arguments
as %String(MAXLEN="",TRUNCATE=1);
Arguments' values passed to method
• property ClassName
as %String(MAXLEN="");
Name of class, where event happened
• property ClientIPAddress
as %String(MAXLEN=32) [ InitialExpression = ..GetClientAddress() ];
User IP address
• property EventType
as %String(MAXLEN=10,VALUELIST=",NONE,FATAL,ERROR,WARN,INFO,STAT,DEBUG,RAW") [ InitialExpression = "INFO" ];
Type of event
• property Job
as %String [ InitialExpression = $job ];
Identifies the job from which this event was logged.
• property Message
as %String(MAXLEN="",TRUNCATE=1);
User message
• property MethodName
as %String(MAXLEN="");
Name of method, where event happened
• property Source
as %String(MAXLEN="");
Line of int code
• property TimeStamp
as %TimeStamp(XMLTIMEZONE="IGNORE") [ InitialExpression = $zdt($h, 3, 1) ];
Date and time
• property UserName
as %String(MAXLEN=128) [ InitialExpression = $username ];
Cache user
• classmethod AddRecord(ClassName As %String = "", MethodName As %String = "", Source As %String = "", EventType As %String = "", Arguments As %String = "", Message As %String = "")
Add new log event
Use via $$$LogEventTYPE().
Return ID log
write ##class(apptools.core.Log).AddRecord(ClassName, MethodName, Source, EventType, Arguments, Message)
Example do ##class(apptools.core.Log).AddRecord("I want", "log", "everything", "INFO", "actions", "users")
Kill - Do ##class(apptools.core.Log).%KillExtent()
• classmethod ArgumentsListToString(List As %List)
as %String
Convert list of method arguments to string
• classmethod ConvertOutHTML(text As %String)
as %String
[ SQLProc = ]
apptools_core.Log_ConvertOutHTML(txt)
• classmethod DeserializeObject(String, ClassName)
as %String
• classmethod GetArgumentValue(Name As %String, ClassName As %Dictionary.CacheClassname)
as %String
• classmethod GetClientAddress()
Determine user IP address
write ##class(apptools.core.Log).GetClientAddress()
• classmethod GetMethodArguments(ClassName As %String, MethodName As %String)
as %String
Entry point to get method arguments string
• classmethod GetMethodArgumentsList(ClassName As %String, MethodName As %String)
as %List
Get a list of method arguments
• classmethod Load(gn)
as %Status
Download the context of Protocol global
Example: d ##class(apptools.core.Log).Load("^logMSWstack(3)")
• classmethod LoadContext(Id)
as %Status
To load the context from the table Protocol
• classmethod SerializeObject(Object, gn="", mode="")
as %String
Serialize the object to json
obj - the object
gn - global link to save flow
mode - the storage mode of the object see: /csp/log/apptools.core.LogInfo.cls?WHAT=?
w ##class(apptools.core.Log).SerializeObject(obj,"^gn","sveta")
• classmethod WriteJSONFromObject(obj, format As %String = "tw", alt=1)
as %String
w ##class(apptools.core.Log).WriteJSONFromObject(b) ;format As %String = "aeos" ;aceloqtw
• classmethod WriteJSONFromSQL(sql As %String)
as %Status
w ##class(apptools.core.Log).WriteJSONFromSQL("select * FROM %Library.sys_SQLConnection WHERE Connection_Name='postgres'")
• query FindLog()
SQL Query
:
SELECT %ID,ClassName,ClientIPAddress,EventType,Message,MethodName,Source,TimeStamp,UserName FROM Log
•index (idxClassName on ClassName) [Type = bitmap];
•index (idxClientIPAddress on ClientIPAddress);
•index (idxEventType on EventType) [Type = bitmap];
•index (idxTimeStamp on TimeStamp) [Type = bitslice];
•index (idxUserName on UserName) [Type = bitmap];
