Re: Review Request 74262: RANGER-4024:Adding requestId as part of Ranger logs via RangerMDCFilter when the request header contains request-Id

[Madhan Neethiraj <ma...@apache.org>]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/74262/#review225156
-----------------------------------------------------------




security-admin/src/main/java/org/apache/ranger/security/web/filter/RangerMDCFilter.java
Lines 42 (patched)
<https://reviews.apache.org/r/74262/#comment313924>

    Consider reading header name and mdc-key from configuration, instead of hardcoding here.



security-admin/src/main/java/org/apache/ranger/security/web/filter/RangerMDCFilter.java
Lines 72 (patched)
<https://reviews.apache.org/r/74262/#comment313925>

    Consider clearing MDC after the request completes.



security-admin/src/test/java/org/apache/ranger/security/web/filter/TestRangerMDCFilter.java
Lines 1 (patched)
<https://reviews.apache.org/r/74262/#comment313926>

    Please add license text.


- Madhan Neethiraj


On Jan. 4, 2023, 7:13 a.m., Ramachandran Krishnan wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/74262/
> -----------------------------------------------------------
> 
> (Updated Jan. 4, 2023, 7:13 a.m.)
> 
> 
> Review request for ranger, Don Bosco Durai, Kirby Zhou, Abhay Kulkarni, Madhan Neethiraj, Mehul Parikh, Nikhil P, Pradeep Agrawal, Ramesh Mani, Selvamohan Neethiraj, Sailaja Polavarapu, Subhrat Chaudhary, and Velmurugan Periasamy.
> 
> 
> Bugs: RANGER-4024
>     https://issues.apache.org/jira/browse/RANGER-4024
> 
> 
> Repository: ranger
> 
> 
> Description
> -------
> 
> In Ranger, we do not have the correlation Id which needs to be stored in the logs whenever we get the requestId header from the caller microservice 
> Proposal:
> RangerMDCFilter will capture the  correlation Id which needs to be stored in the logs whenever we get the requestId header from the caller microservice 
> This RangerMDCFilter can be enabled in the web.xml and logging ConversionPattern if needed to log requestId in the logs
>  
> 
> <filter>
> <filter-name>RangerMDCFilter</filter-name>
> <filter-class&amp;amp;gt;org.apache.ranger.security.web.filter.RangerMDCFilter</filter-class&amp;amp;gt;
> </filter>
> 
> <filter-mapping>
> <filter-name>RangerMDCFilter</filter-name>
> <url-pattern>/service/*</url-pattern>
> </filter-mapping>
>  
> and to change the conversion pattern to something like this, using the %X{} placeholder for each entry contained in the MDC we want to be logged:
> 
> Example:
> 
>   <appender name="xa_log_appender" class="ch.qos.logback.core.rolling.RollingFileAppender">
>     <!--See http://logback.qos.ch/manual/appenders.html#RollingFileAppender-->
>     <!--and http://logback.qos.ch/manual/appenders.html#TimeBasedRollingPolicy-->
>     <!--for further documentation-->
>     <file>${logdir}/ranger-admin-${hostname}-${user}.log</file>
>     <append>true</append>
>     <encoder>
>       <pattern>%date [%thread] %level{5} [%file:%line] [requestId=%X{REQUEST_ID}] %msg%n</pattern>
>     </encoder>
>     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
>       <fileNamePattern>${logdir}/ranger-admin-${hostname}-${user}.log.%d{yyyy-MM-dd}</fileNamePattern>
>       <maxHistory>15</maxHistory>
>       <cleanHistoryOnStart>true</cleanHistoryOnStart>
>     </rollingPolicy>
>   </appender>
> 
> 
> Diffs
> -----
> 
>   security-admin/src/main/java/org/apache/ranger/security/web/filter/RangerMDCFilter.java PRE-CREATION 
>   security-admin/src/test/java/org/apache/ranger/security/web/filter/TestRangerMDCFilter.java PRE-CREATION 
> 
> 
> Diff: https://reviews.apache.org/r/74262/diff/1/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Ramachandran Krishnan
> 
>