article Sending e-mail alerts in Qlik Sense Enterprise Task Failures in Qlik Sense Documents

Sending e-mail alerts in Qlik Sense Enterprise Task Failures

Clever_Anjos — Thu, 26 Apr 2018 23:31:47 GMT

There´s a common request to any Qlik Sense Enterprise Administrator:

"Is there any way to be informed by e-mail when a reload task fails?" Yes, there is!

Before that, let´s have some technical small talk (you can jump to session "Creating your config xml" if you want)

Qlik Sense Enterprise relies on log4Net a very mature Apache Project that is very reliable and powerful. It, besides a lot of features , has the concept of Appender. That concept means that the application being logged (Qlik Sense in our case) does not to take care where the log is being stored, log4net config files handles this.

You can change a config file and choose if your log are meant to be stored into a database, a flat file, a hadoop data lake and you can even send an e-mail for each error message. Qlik Sense Enterprise help to Appenders

1 - Creating your config xml

Pick your favorite text editor and write your config file according this https://logging.apache.org/log4net/release/config-examples.html

No, wait!

I´m posting here a functional config file, you can copy and paste it.

I´m supposing you´re going to use Gmail as the SMTP but is up to you chose any working SMTP that you want

<?xml version="1.0"?>
<configuration>
    <!-- Mail appender-->
    <appender name="MailAppender" type="log4net.Appender.SmtpAppender">
        <filter type="log4net.Filter.LevelRangeFilter">
            <param name="levelMin" value="WARN" />
            <param name="levelMax" value="ERROR" />
        </filter>
        <filter type="log4net.Filter.DenyAllFilter" />
        <evaluator type="log4net.Core.LevelEvaluator">
            <param name="threshold" value="ERROR"/>
        </evaluator>

        <param name="to" value="admin@domain.com" /> <!-- please use your admin e-mail address here -->
        <param name="cc" value="someone.else@domain.com" />
        <param name="from" value="yourgmailaccount@gmail.com" /> <!-- you´re supposed to change this -->
        <param name="subject" value="Qlik Sense Task Fail!!!" />
        <param name="smtpHost" value="smtp.gmail.com" />
        <param name="port" value="587" />
        <param name="EnableSsl" value="true" />
        <param name="Authentication" value="Basic" />
        <param name="username" value="yourgmailaccount@gmail.com" /> <!-- you´re supposed to change this -->
        <param name="password" value="yourpasswordforGmail" /> <!-- you´re supposed to change this -->
        <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">7
<!-- You can change below code if you want to pretify your e-mail message -->
            <param name="conversionPattern" value="%newline%date %-5level %newline%property{TaskName}%newline%property{AppName}%newline%message%newline%newline%newline" />
        </layout>
    </appender>
    <!--Send mail on task failure-->
    <logger name="System.Scheduler.Scheduler.Slave.Tasks.ReloadTask"> <!-- Filter what kind of exceptionname is beeing captured -->
        <appender-ref ref="MailAppender" />
    </logger>
</configuration>

2 - Saving your config xml

You must save your file with LocalLogConfig.xml name and under C:\ProgramData\Qlik\Sense\Scheduler (at least until version April2018). Anything different from this will cause your configuration not work.

3 - Restarting your Scheduler Service

Check if any task is running before restarting the service!!

4 - Test

Create an app and create an very "silly always fail" script like Store notable into [lib://neverland/notable.qvd](qvd)
Schedule your app as usual (under QMC/Apps/[your app]/More options button/Create New Reload Task

(https://help.qlik.com/en-US/sense/April2018/Subsystems/ManagementConsole/Content/create-reload-tasks.htm)

Get a cup of coffee and wait for your task fail and your alert e-mail arrives at your inbox.

This blog post was written with fundamental contribution of ile‌ that sent me a functional config file

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

Michael_Leigh — Mon, 30 Apr 2018 03:19:55 GMT

If using gmail you may need to enable less secure applications in your Google mail settings:

Let less secure apps access your account - Google Account Help.

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

Michael_Leigh — Mon, 30 Apr 2018 03:43:44 GMT

I also tested this in the Qlik Sense April 2018 release, using FakeSMTP for the mail server. This is useful to test and if you need to eliminate your mail service as having issues. Below is an example LocalLogConfig.xml config file.

Note that I used 2525 as the SMTP port and localhost for the smtpHost, as FakeSMTP was running on the Sense server. Fake SMTP can be run on a remote machine, as long a there's network connectivity and your chosen port is open.

<?xml version="1.0"?>

</filter>

</evaluator>

</layout>

</appender>

<appender-ref ref="MailAppender" />

</logger>

</configuration>

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

huangjing — Fri, 18 May 2018 01:13:53 GMT

According to your method, we have succeeded in testing.

But what we need now is that only a part of task send wrong messages, what should i do?

For example, the prefix of the tasks is A , sending mail, others do not send.

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

Michael_Leigh — Mon, 21 May 2018 02:49:30 GMT

You can use the StringToMatch filters in log4net, see Apache log4net™ SDK Documentation - Table of Content and look for StringMatchFilter

I don't have a working example of this, but if my understanding is correct it should work. As far as I know StringToMatch uses OR only, not AND, for multiple filters, and make sure <filter type="log4net.Filter.DenyAllFilter" /> is the last filter line used.

e.g.

</filter>

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

millan123 — Mon, 06 Aug 2018 10:59:51 GMT

Thank you for the info Michael.

Could we use same for the June 2018 version ?

Br,

Clark

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

Michael_Leigh — Tue, 07 Aug 2018 01:25:29 GMT

As far as I can see nothing has changed around this, so it should work as per previous releases - but I have not tested.

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

millan123 — Tue, 07 Aug 2018 06:48:12 GMT

Thank you , I tried using it about I am not getting any mails.

Where should I check Locallogconfig.xml log ? any troubleshooting idea will be helpful to us.

Thank you so much

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

Michael_Leigh — Tue, 07 Aug 2018 07:00:29 GMT

Initially I recommend opening a support case with Qlik as I won't have time to test it anytime soon. I'm not sure where any errors would be logged; but probably either in the Logging service or the Schedule logs somewhere

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

millan123 — Tue, 07 Aug 2018 07:02:22 GMT

thank you sure , we will create a log in to Qlik support

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

miskin_m — Tue, 09 Oct 2018 07:04:45 GMT

Hi Clark/ Mick

I am also trying to send gmail mails from June 18 but no luck. Did anyone of you found the solution.

Regards

Miskin

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

jaisoni_trp — Wed, 10 Oct 2018 19:52:48 GMT

Can we send email notification based on tasks? Say for Task A failure email should go to person A and for Task B failure it should go to Person B? I am looking for personalized notification if possible.

Thanks,

Jai

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

gagiraldoh — Thu, 08 Nov 2018 15:37:59 GMT

In my case this method does not work, i use gmail smtp.

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

antoinelaviron — Thu, 15 Nov 2018 07:46:30 GMT

It works like a charm (Sept 18 SR2)

Thanks a lot

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

gustavgager — Thu, 29 Nov 2018 15:42:10 GMT

I cant get it to work either. I have confirmed that the email-settings are correct, since i use them in Nprinting. But when the task fail, nothing happens. Is there a log i can use for troubleshooting?

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

mike_rowe — Fri, 25 Jan 2019 09:59:50 GMT

Great post and I've managed to set everything up, so that I am able to receive an email alert every time an app fails to reload.

I would like to take it a step further and add the task name to the subject line.

Is this possible?

If so, how would I write this into the config file?

Kind regards

Mike Rowe

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

markp201 — Tue, 05 Feb 2019 21:57:59 GMT

We've been trying this every which way but no luck. We're using Sept 2018 Sense - hoping that's not the issue.

We're not even getting any record of an email being sent. We contacted Qlik support but this is one of those areas they're only going to refer us to the acct rep.

Anyone else have problems with the configuration or where the xml file needs to be ?

If we get this working, we would like to see application, time of failure error code/description in the email.

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

markp201 — Wed, 06 Feb 2019 17:47:17 GMT

We were able to resolve this from a support page which has an example of the xml config.

https://support-cdn.qlik.com/QS_CaseWizardKnowledgeArticle?Id=ka5D0000000TR9zIAG

<?xml version="1.0"?>
<configuration>
    
    <appender name="MailAppender" type="log4net.Appender.SmtpAppender">
        <filter type="log4net.Filter.LevelRangeFilter">
            <param name="levelMin" value="ERROR" />
           
        </filter>
        <filter type="log4net.Filter.DenyAllFilter" />
        <evaluator type="log4net.Core.LevelEvaluator">
            <param name="threshold" value="ERROR"/>
           
        </evaluator>
        <param name="to" value="you@gmail.com" />
        <param name="from" value="you@gmail.com" />
        <param name="subject" value="Qlik Sense" />
        <param name="smtpHost" value="smtp.gmail.com" />
        <param name="port" value="587" />
        <param name="EnableSsl" value="true" />
        <param name="Authentication" value="Basic" />
        <param name="username" value="you@gmail.com" />
        <param name="password" value="yourpassword" />
        <param name="bufferSize" value="0" /> 
        <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" />
           
        </layout>
    </appender>
    
    <logger name="System.Scheduler.Scheduler.Slave.Tasks.ReloadTask">
   
        <appender-ref ref="MailAppender" />
       
    </logger>
</configuration>

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

m_perreault — Fri, 15 Feb 2019 18:46:58 GMT

Very cool! Was wondering if it is possible to put the Task Name in the subject of the email? Was also wondering if it is possible to attach the actual log of the task that failed to the email?

Re: Sending e-mail alerts in Qlik Sense Enterprise Task Failures

sundip — Tue, 05 Mar 2019 17:28:45 GMT

I am able to get it working and it running fine for us. But I notices when new task starts in QMC and if retries to find a slave scheduler - this script sends an failure email. Task never fails, after retry it finds a slave scheduler and finishes fine. Is there any script needs to be added or modifies to ignore retry as a task failure.