james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <server-...@james.apache.org>
Subject [jira] [Commented] (JAMES-2171) LogMessage mailet improvments
Date Tue, 11 Dec 2018 07:49:00 GMT

    [ https://issues.apache.org/jira/browse/JAMES-2171?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16716422#comment-16716422
] 

ASF GitHub Bot commented on JAMES-2171:
---------------------------------------

Github user chibenwa commented on a diff in the pull request:

    https://github.com/apache/james-project/pull/145#discussion_r240499957
  
    --- Diff: mailet/standard/src/main/java/org/apache/james/transport/mailets/LogMessage.java
---
    @@ -73,9 +136,15 @@ public void init() {
                 headers = getInitParameter("headers", true);
                 body = getInitParameter("body", true);
                 bodyMax = (getInitParameter("maxBody") == null) ? 0 : Integer.parseInt(getInitParameter("maxBody"));
    +            if(bodyMax < 0){
    +                logger.error("Parsed a negative maxBody value and caused initialization
failure");
    +                throw new IllegalArgumentException("The value of maxBody cannot be negative.");
    +            }
                 comment = getInitParameter("comment");
    -        } catch (Exception e) {
    -            logger.error("Caught exception while initializing LogMessage", e);
    +        } catch (NumberFormatException e){
    +            logger.error("Caught exception while parsing maxBody value", e);
    --- End diff --
    
    I would argue that we don't want to start with an invalid configuration. Maybe catching
these exceptions is not needed?


> LogMessage mailet improvments
> -----------------------------
>
>                 Key: JAMES-2171
>                 URL: https://issues.apache.org/jira/browse/JAMES-2171
>             Project: James Server
>          Issue Type: Improvement
>          Components: Mailet Contributions
>    Affects Versions: master
>            Reporter: Tellier Benoit
>            Priority: Major
>              Labels: easyfix, newbie
>
> Today, one can use the LogMessage to generate log messages upon mail reception
> But the LogMessage have the following limits:
>  - It do not let you configure the warn level
>  - It does generate several logs. One would be simpler to review.
>  - It does add some unneeded informations, like mail name already carried by the MDC
>  - It does not allow logging of specific headers or specific attributeNames. This leads
to missing information as well as "to much information".
>  - The code quality of the mailet is poor.
> You will:
>  - Ensure a single log message will be generated. For this you will call the logger one
time and concatenate log messages parts.
>  - Remove the log line with mail name.
>  - Add a **level** configuration option. It can takes value **warn**, **info**, **debug**
or **error**. It will be used to set the logger log level.
>  - Add a **specificHeaders** configuration option. It takes a comma separated list of
header names to include in the log message. By default it is empty.
>  - Add a **specificAttributes** configuration option.  It takes a comma separated list
of attribute names to be included in the log message. By default it is empty.
>  - **body** configuration option should be false by default
>  - **header** configuration option should be false by default
>  - **init** should propagate exception while initilizing (Integer parse exception, also
passing a negative max body should throw.)
>  - Remove inlined affectation for field. They can be unset on their declaration and set
when init is called.
> Correct *LogMessageTest* accordingly.
> Don't hesitate to reach us on the *gitter* chat if you have any question.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message