Versions Compared

Key

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

...

When configuring data values in the appender, staying as generic as possible allows the same logback.xml to be used among dev, test, and production environments without any modifications (always a plus when you're being audited).

  1. Edit %{idp.home}/conf/logback.xml and append this new appender code block after the last existing <appender> definition:

    • <smtpHost> : Hostname or IP address of your mail server (probably localhost in most cases)

    • <from> : The from address on any emails sent from Logback

    • <subject> : The subject of the emails sent from Logback. ${HOSTNAME} will reference the computer name on which Logback is running

    • <level> : What condition to take action on (DEBUG, INFO, WARN, ERROR)

      Logback.xml SMTP Appender

      Code Block
      languagexml
      <!-- Custom SMTP Appender for ERROR -->
      <appender name="Email_Alerts" class="ch.qos.logback.classic.net.SMTPAppender">
            <smtpHost>SMTPHOSTNAME</smtpHost>
            <from>FROMEMAILADDRESS</from>
            <to>TOEMAILADDRESS</to>
            <subject>${HOSTNAME} IDP Error Detected</subject>
            <layout class="ch.qos.logback.classic.html.HTMLLayout"/>
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>ERROR</level>
            </filter>
      </appender>
      <!-- /Custom SMTP Appender for ERROR -->

      Click here for additional SMTPAppender properties and information.

  2. Add a reference to the new appender:

    1. Find the existing code <root level="INFO">

      1. Hooking in here allows you to configure your appender to alert on any severity

      2. Alternatively, you can create your own root level block if you don't want to modify the existing block

    2. Append a new reference after the existing references:

      Code Block
      <appender-ref ref="Email_Alerts"/>