Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Setup → Services → HTTP, TCP, EMail, ... → Check Email → Add Rule

    1. Service description

      1. Here you can type in a service description. Please make sure that this is unique per host and does not collide with other services.

    2. Mail Receiving

      1. Here you can select if you want to check your IMAP or POP3 login. You need your login credentials for your E-Mail Mailbox.


    3. Forward emails as events to Event Console

      1. Forwarding Method

        • Here you can select if you want to send the events either to the EC or to a remote syslog host. If you want to send the events to the local EC, we would recommend using the spooling mechanism.

          By using the spooling mechanism, the check will store all collected events in one file in ~/var/mkeventd/spool.

          Code Block
          languagebash
          themeRDark
          OMD[mysite]:~$ ll ~/var/mkeventd/spool/
          
          total 3600
          
          -rw-rw---- 1 mysite mysite 79124 Dec 7 15:36 mysite_407343_1607351778
          
          -rw-rw---- 1 mysite mysite 79124 Dec 7 15:37 mysite_408329_1607351841
          
          


      2. Only process mails with matching subject

        1. Use this option to not process all messages found in the inbox but only those whose subject matches the given regular expression. The text entered here is handled as a regular expression pattern. The pattern is matched from the beginning. Add a tailing $ to change it to a whole text match. The match is performed case-sensitive. Read more about regular expression matching in Checkmk in our user official guide.
          .

          1. You need to be aware that a subject field could contain line breaks. This is depending on your mail client and mail gateway. To find out how many line breaks you have, you could check the raw email

            .

          2. Now you can use regex platforms like regex101.com to create a regex

            .

          3. For advanced debugging
            .
              1. Copy the plugin to the local path

                Code Block
                languagebash
                themeRDark
                OMD[mysite]:~/lib/nagios/plugins$ cp check_mail ~/local/lib/nagios/plugins/

                .

              2. Add a print for the subject

                Code Block
                languagebash
                themeRDark
                     for index, msg in sorted(mails.items()):
                         subject = msg.get('Subject', 'None')
                         print(subject)

                .

              3. Run the script manually

                Code Block
                languagebash
                themeRDark
                OMD[mysite]:~/lib/nagios/plugins$ ./check_mail --pwstore=6@17@password_1 '--fetch-protocol=IMAP' '--fetch-server=imap.strato.de' '--fetch-tls' '--fetch-port=993' '--fetch-username=user@provider.com' '--fetch-password=*************' '--connect-timeout=10' '--forward-ec' '--match-subject=.*Incident.*\n.*assigned' 
                =?utf-8?Q?Incident_INC000000XXXX_has_bee?=
                 =?utf-8?Q?n_assigned_to_your_group_'XXXX=
                 =?utf-8?Q?XXXXX'_=XXXXX:_Comuni?=
                 =?utf-8?Q?XXXXX_-_Priority:_Low?=
                =?utf-8?Q?Incident_INC000000XXXX_has_bee?=
                 =?utf-8?Q?n_assigned_to_your_group_'XXXX=
                 =?utf-8?Q?XXXXX'_=XXXXX:_Comuni?=
                 =?utf-8?Q?XXXXX_-_Priority:_Low?=
                Forwarded 2 messages to event console | messages=2
                
                


      3. Events: Syslog facility

        1. Use this syslog facility for all created events

      4. Events: Hostname

        1. Use this hostname for all created events instead of the name of the mailserver

      5. Limit the length of the mail body

        1. When forwarding mails mail from the mailbox to the event console, the body of the mail is limited to the given number of characters.

      6. Cleanup messages

        1. The handled messages (see subject matching) can be cleaned up by either deleting them or moving them to a subfolder. By default, nothing is cleaned up.

          InfoImage Removed


          Image Added



Debugging

EC Log

In the log of the EC you can see the processing messages from the spool file:

...