Merge pull request #138 from mountaindude/master

5.0 RC1
ptarmiganlabs · Feb 24, 2021 · 6b313ed · 6b313ed
2 parents c9fe08e + 0a5631a
commit 6b313ed
Show file tree

Hide file tree

Showing 20 changed files with 466 additions and 259 deletions.
diff --git a/changelog.md b/changelog.md
@@ -19,6 +19,8 @@
 9. Slack task fail/abort messages can now - optionally - use same templating concept that was previously available for emails. Better looking Slack alert messages thus! ([#120](https://github.com/ptarmiganlabs/butler/issues/120)).
 10. Added rate limiting option for task fail/aborts sent to Slack and MS Teams. ([#119](https://github.com/ptarmiganlabs/butler/issues/119)).
 11. Add MQTT message containing all available info about failed/aborted tasks. Format is stringified JSON. ([#128](https://github.com/ptarmiganlabs/butler/issues/128)).
+12. Add exclude list to user activity events sent to Slack and MS Teams. Using this feature it's possible to prevent session start/stop etc notifications for specific users to be sent to Teams and Slack. Useful for example if a system account is used to do API calls - that probably should not be reported as user activity. ([#132](https://github.com/ptarmiganlabs/butler/issues/132)).
+13. Improvements around handling of inbound MQTT messages. The root MQTT topic that Butler subscribes to is now configurable ([#137](https://github.com/ptarmiganlabs/butler/issues/137)). The topic through which Sense tasks can be started is now also configurable ([#136](https://github.com/ptarmiganlabs/butler/issues/136)) rather than hard coded.
 
 ### Fixes and patches
 
@@ -37,7 +39,7 @@
 
 3. **BREAKING**: Similar to 1 above, all MS Teams configuration has been moved from `Butler.teamsConfig.*` into the larger/more generic `Butler.teamsNotification.*` section of the config file.
 
-4. UDP message format for user session start/stop log appender has changed to follow same principles as other log appender UDP messages sent to Butler. ([#126](https://github.com/ptarmiganlabs/butler/issues/126)).
+4. UDP message format for user session start/stop log appender has changed to follow same principles as other log appender UDP messages sent to Butler. ([#126](https://github.com/ptarmiganlabs/butler/issues/126), [#134](https://github.com/ptarmiganlabs/butler/issues/134)).
 
 ## 4.3.0
 

diff --git a/docs/log4net_task-failed/scheduler/LocalLogConfig.xml b/docs/log4net_task-failed/scheduler/LocalLogConfig.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <configuration>
-	<!-- Appender for detecting reload task failures. Only the last of potentially several retries is reported -->
+    <!-- Appender for detecting reload task failures. Only the last of potentially several retries is reported -->
     <appender name="TaskFailureLogger" type="log4net.Appender.UdpAppender">
         <filter type="log4net.Filter.StringMatchFilter">
             <param name="stringToMatch" value="Max retries reached" />
@@ -13,7 +13,7 @@
             <converter>
                 <param name="name" value="hostname" />
                 <param name="type" value="Qlik.Sense.Logging.log4net.Layout.Pattern.HostNamePatternConverter" />
-             </converter>
+            </converter>
             <param name="conversionpattern" value="/scheduler-reload-failed/;%hostname;%property{TaskName};%property{AppName};%property{User};%property{TaskId};%property{AppId};%date;%level;%property{ExecutionId};%message" />
         </layout>
     </appender>
@@ -31,7 +31,7 @@
             <converter>
                 <param name="name" value="hostname" />
                 <param name="type" value="Qlik.Sense.Logging.log4net.Layout.Pattern.HostNamePatternConverter" />
-             </converter>
+            </converter>
             <param name="conversionpattern" value="/scheduler-reload-aborted/;%hostname;%property{TaskName};%property{AppName};%property{User};%property{TaskId};%property{AppId};%date;%level;%property{ExecutionId};%message" />
         </layout>
     </appender>
@@ -44,7 +44,7 @@
         <filter type="log4net.Filter.DenyAllFilter" />
         <evaluator type="log4net.Core.LevelEvaluator">
             <param name="threshold" value="ERROR"/>
-			<!--Sets the level of logging, in this case any ERROR in the log will be sent as an email-->
+            <!--Sets the level of logging, in this case any ERROR in the log will be sent as an email-->
         </evaluator>
         <param name="to" value="<email address to send failed task notification emails to>" />
         <param name="from" value="<sender email address used in notification emails>" />
@@ -55,11 +55,12 @@
         <param name="Authentication" value="Basic" />
         <param name="username" value="<Gmail username>" />
         <param name="password" value="<Gmail password>" />
-        <param name="bufferSize" value="0" /> <!-- Set this to 0 to make sure an email is sent on every error -->
+        <param name="bufferSize" value="0" />
+        <!-- Set this to 0 to make sure an email is sent on every error -->
         <param name="lossy" value="true" />
         <layout type="log4net.Layout.PatternLayout">
             <param name="conversionPattern" value="%newline%date %-5level %newline%property{TaskName}%newline%property{AppName}%newline%message%newline%newline%newline" />
-			<!--Defined conversion pattern for the output. To be able to output custom properties in the log (example, Taskname), append %property{propertyname} to the output pattern-->
+            <!--Defined conversion pattern for the output. To be able to output custom properties in the log (example, Taskname), append %property{propertyname} to the output pattern-->
         </layout>
     </appender>
 
@@ -74,8 +75,8 @@
 
     <!--Send email on task failure-->
     <logger name="System.Scheduler.Scheduler.Slave.Tasks.ReloadTask">
-    	<!--Logger name identifies the component to monitor. This can be found by investigating the actual log file-->
-		<!--appender-ref should match the name identifying the appender. More than one appender can be configured in the same configuration file-->
+        <!--Logger name identifies the component to monitor. This can be found by investigating the actual log file-->
+        <!--appender-ref should match the name identifying the appender. More than one appender can be configured in the same configuration file-->
         <appender-ref ref="MailAppender" />
     </logger>
 </configuration>
diff --git a/docs/log4net_user-audit-event/LocalLogConfig.xml b/docs/log4net_user-audit-event/LocalLogConfig.xml
@@ -1,24 +1,48 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <configuration>
-    <appender name="NodeUserLogger" type="log4net.Appender.UdpAppender">
+
+    <appender name="EventSession" type="log4net.Appender.UdpAppender">
         <filter type="log4net.Filter.StringMatchFilter">
-            <param name="stringToMatch" value="Start session" />
+            <param name="stringToMatch" value="Start session for user" />
         </filter>
         <filter type="log4net.Filter.StringMatchFilter">
-            <param name="stringToMatch" value="Stop session" />
+            <param name="stringToMatch" value="Stop session for user" />
         </filter>
         <filter type="log4net.Filter.DenyAllFilter" />
         <param name="remoteAddress" value="<FQDN or IP of server where Butler is running>" />
         <param name="remotePort" value="9997" />
+        <param name="encoding" value="utf-8" />
         <layout type="log4net.Layout.PatternLayout">
             <converter>
                 <param name="name" value="hostname" />
                 <param name="type" value="Qlik.Sense.Logging.log4net.Layout.Pattern.HostNamePatternConverter" />
-             </converter>
-            <param name="conversionpattern" value="%hostname;%property{Command};%property{UserDirectory};%property{UserId}" />
+            </converter>
+            <param name="conversionpattern" value="/proxy-session/;%hostname;%property{Command};%property{UserDirectory};%property{UserId};%property{Origin};%property{Context};%message" />
         </layout>
     </appender>
-  <logger name="AuditActivity.Proxy">
-      <appender-ref ref="NodeUserLogger" />
-  </logger>
+
+    <appender name="EventConnection" type="log4net.Appender.UdpAppender">
+        <filter type="log4net.Filter.StringMatchFilter">
+            <param name="stringToMatch" value="connection Opened for session" />
+        </filter>
+        <filter type="log4net.Filter.StringMatchFilter">
+            <param name="stringToMatch" value="connection Closed for session" />
+        </filter>
+        <filter type="log4net.Filter.DenyAllFilter" />
+        <param name="remoteAddress" value="<FQDN or IP of server where Butler is running>" />
+        <param name="remotePort" value="9997" />
+        <param name="encoding" value="utf-8" />
+        <layout type="log4net.Layout.PatternLayout">
+            <converter>
+                <param name="name" value="hostname" />
+                <param name="type" value="Qlik.Sense.Logging.log4net.Layout.Pattern.HostNamePatternConverter" />
+            </converter>
+            <param name="conversionpattern" value="/proxy-connection/;%hostname;%property{Command};%property{UserDirectory};%property{UserId};%property{Origin};%property{Context};%message" />
+        </layout>
+    </appender>
+
+    <logger name="AuditActivity.Proxy">
+        <appender-ref ref="EventSession" />
+        <appender-ref ref="EventConnection" />
+    </logger>
 </configuration>
diff --git a/docs/sense_apps/Butler 4.3 demo app.qvf b/docs/sense_apps/Butler 4.3 demo app.qvf
diff --git a/docs/sense_apps/Butler 5.0 - demo app (many APIs!).qvf b/docs/sense_apps/Butler 5.0 - demo app (many APIs!).qvf
diff --git a/docs/sense_apps/Butler 5.0 - partial reload demo (step 1).qvf b/docs/sense_apps/Butler 5.0 - partial reload demo (step 1).qvf
diff --git a/docs/sense_apps/Butler 5.0 - partial reload demo (step 2).qvf b/docs/sense_apps/Butler 5.0 - partial reload demo (step 2).qvf
diff --git a/docs/sense_apps/Butler 5.0 - post message to Slack.qvf b/docs/sense_apps/Butler 5.0 - post message to Slack.qvf
diff --git a/docs/sense_apps/Butler 5.0 - publish messages to MQTT.qvf b/docs/sense_apps/Butler 5.0 - publish messages to MQTT.qvf