FEAT: add audit system

Audit mechanism is simple the globals holding the runtime date each time when elements are called

Author: Frisle

MDX2JSON/Utils.cls

@@ -60,6 +60,8 @@ ClassMethod WriteJSONfromMDX(MDX As %String, Timeout As %Integer = 0) As %Status
 	Set tSC = $$$OK
 	#dim RS As MDX2JSON.ResultSet
 
+	set start = $PIECE($NOW(),",",2)
+
 	set RS = ..GetResultSet(MDX, .tSC)
 	set cube = ##class(%DeepSee.Utils).%IsCubeCompound(RS.%Cube) // check if cube is compound type
 	return:$$$ISERR(tSC) tSC
@@ -87,6 +89,14 @@ ClassMethod WriteJSONfromMDX(MDX As %String, Timeout As %Integer = 0) As %Status
 		return:$$$ISERR(tSC) tSC
 		$$$DynObjToJSON(obj)
 	}
+
+	set stop = $PIECE($NOW(),",",2)
+
+	set executionTime = stop - start
+	set query = RS.%GetQuery()
+
+	set audit = ..WriteAudit(MDX, "query", executionTime)
+
 	return $$$OK
 }
 
@@ -108,7 +118,6 @@ ClassMethod WriteJSONfromQuery(CubeKey As %String, QueryKey As %String, Timeout
 	return $$$OK
 }
 
-
 /// Execute SQL query taken from KPI and extract column values by name of column
 /// Output array with list of values like so pValue(n) = $LB(sNameList(i)...)
 ClassMethod GetSQLValues(pSQL, Output pValues As %String, Output tResultSet As %SQL.Statement) As %Status
@@ -133,7 +142,6 @@ ClassMethod GetSQLValues(pSQL, Output pValues As %String, Output tResultSet As %
 	return st
 }
 
-
 /// This method provides listing execution for KPI. 
 /// <b>tKPI<b> as a name of KPI class. <b>pFilters<b> not yet implemented 
 /// as a <b>pSelection<b>. Thats for future use. 
@@ -309,7 +317,8 @@ ClassMethod GetDataSource(pDataSource As %String)
 
 	set st = $$$OK
 	try {
-		
+		set start = $PIECE($NOW(),",",2)
+
 		if ($FIND(pDataSource, ".pivot") = ($LENGTH(pDataSource) + 1) && pDataSource '="") {
 			set st = ..OpenPivotByName(pDataSource, .dataSource)
 			return:($$$ISERR(st)) st
@@ -320,8 +329,16 @@ ClassMethod GetDataSource(pDataSource As %String)
 				set dataSource.mdx = mdx
 			}
 			set st = ##class(%ZEN.Auxiliary.jsonProvider).%ObjectToJSON(dataSource, .out)
+
+			set stop = $PIECE($NOW(),",",2)
+
+			set executionTime = stop - start
+
+			set audit = ..WriteAudit(pDataSource, "pivot", executionTime)
+			
 
 		}
+
 
 	} catch ex {
 		set st = ex.AsStatus()
@@ -409,12 +426,22 @@ ClassMethod GetWidgetsList(pDashName As %String) As %Status
 ClassMethod GetDashboard(pDashName As %String) As %Status
 {
 	try {
+		set start = $PIECE($NOW(),",",2)
+
 		set st = ##class(MDX2JSON.DashboardFilters).OpenDashboardByName(pDashName, .dash)
 		return:($$$ISERR(st)) st
 
 		set st = ##class(MDX2JSON.DashboardFilters).WidgetsToProxyObject(dash, .widgetlist)
 		return:($$$ISERR(st)) st
 		w "" // weird hack required for 15.3
+		
+		set stop = $PIECE($NOW(),",",2)
+
+		set executionTime = stop - start
+
+		set audit = ..WriteAudit(pDashName, "dashboard", executionTime)
+		
+	
 		$$$DynObjToJSON(widgetlist)
 	} catch ex {
 		set st = ex.AsStatus()
@@ -557,6 +584,115 @@ ClassMethod CreateAddonClass(Class As %Dictionary.CacheClassname) As %Status
 	quit classObj.%Save()
 }
 
+ClassMethod WriteAudit(element, elementName, executionTime = 0) As %Status
+{
+	set st = $$$OK
+	
+	set ^CallAmount($INCREMENT(^CallAmount)) = 1
+
+
+	if ^AuditState = "on"
+	{
+		if elementName = "dashboard"
+		{
+			set ^MyBIAuditLogDash($INCREMENT(^MyBIAuditLogDash)) = $lb($ZDT($H,3), $USERNAME, element, executionTime)
+		}
+		elseif elementName = "pivot"
+		{
+			set ^MyBIAuditLogPivot($INCREMENT(^MyBIAuditLogPivot)) = $lb($ZDT($H,3), $USERNAME, element, executionTime)
+		}
+		elseif elementName = "query"
+		{
+			set ^MyBIAuditLogQuery($INCREMENT(^MyBIAuditLogQuery)) = $lb($ZDT($H,3), $USERNAME, element, executionTime)
+		}
+
+
+	}else{
+
+		quit st
+	}
+
+
+	return st
+}
+
+ClassMethod ReadAudit(metricName) As %Status
+{
+	set st = $$$OK
+	
+	if ^AuditState = "on"
+	{
+		if metricName = "query"
+		{
+
+			set len = $order(^MyBIAuditLogQuery(""),-1)
+			for n=1:1:len
+			{
+				set log = $Get(^MyBIAuditLogQuery(n))
+				write !
+				write "Element call time: ", $lg(log, 1), !
+				write "User: ", $lg(log, 2), !
+				write "Execution time in sec.: ", $lg(log, 4), !
+				write "Query: ", $lg(log, 3), !
+			}
+		}
+		elseif metricName = "pivot"
+		{
+	
+			set len = $order(^MyBIAuditLogPivot(""),-1)
+			for n=1:1:len
+			{
+				set log = $Get(^MyBIAuditLogPivot(n))
+				write !
+				write "Element call time: ", $lg(log, 1), !
+				write "User: ", $lg(log, 2), !
+				write "Execution time in sec.: ", $lg(log, 4), !
+				write "Pivot: ", $lg(log, 3), !
+			}
+		}
+		elseif metricName = "dashboard"
+		{
+			set len = $order(^MyBIAuditLogDash(""),-1)
+			for n=1:1:len
+			{
+				set log = $Get(^MyBIAuditLogDash(n))
+				write !
+				write "Element call time: ", $lg(log, 1), !
+				write "User: ", $lg(log, 2), !
+				write "Execution time in sec.: ", $lg(log, 4), !
+				write "Dashboard: ", $lg(log, 3), !
+			}
+		}
+	}
+
+	quit st
+}
+
+ClassMethod AuditStateSwitch(auditstate = 0) As %Status
+{
+	set st = $$$OK
+
+	if auditstate = 0
+	{
+		set ^AuditState = "off"
+
+	}else{
+		
+		set ^AuditState = "on"
+	}
+
+	write "Audit state: " _ ^AuditState
+}
+
+ClassMethod AuditKill() As %Status
+{
+	kill ^MyBIAuditLogDash
+	kill ^MyBIAuditLogPivot
+	kill ^MyBIAuditLogQuery
+
+	write "All globals are cleaned"
+}
+
 /// Add new widgets and edit existing ones directly from DeepSeeWeb
 /// it takes widget name(key) as unique identifier as string, dashboard name as string
 /// and object with parameters as zen.proxyObject
@@ -672,7 +808,6 @@ ClassMethod DeleteWidget(wName As %String, sDashboard As %String) As %Status
 	return st
 }
 
-
 /// the collection of necessary parameters for building widget 
 ClassMethod UpdateWidget(widgetToUpdate As %DeepSee.Dashboard.Widget, data As %ZEN.proxyObject) As %Status
 {