feat(console): add envId and orgId to the loggers

Author: aditya-goyal01

gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-security/src/main/java/io/gravitee/rest/api/management/v2/security/config/BasicSecurityConfigurerAdapter.java

@@ -29,6 +29,7 @@
 import io.gravitee.rest.api.security.cookies.CookieGenerator;
 import io.gravitee.rest.api.security.csrf.CookieCsrfSignedTokenRepository;
 import io.gravitee.rest.api.security.csrf.CsrfRequestMatcher;
+import io.gravitee.rest.api.security.filter.ContextualLoggingFilter;
 import io.gravitee.rest.api.security.filter.CsrfIncludeFilter;
 import io.gravitee.rest.api.security.filter.GraviteeContextAuthorizationFilter;
 import io.gravitee.rest.api.security.filter.GraviteeContextFilter;
@@ -198,6 +199,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
             new GraviteeContextFilter(installationTypeDomainService, accessPointQueryService, environmentService),
             CorsFilter.class
         );
+        http.addFilterAfter(new ContextualLoggingFilter(), GraviteeContextFilter.class);
         http.addFilterAfter(new GraviteeContextAuthorizationFilter(), AuthorizationFilter.class);
 
         return http.build();

gravitee-apim-rest-api/gravitee-apim-rest-api-management/gravitee-apim-rest-api-management-rest/src/main/resources/logback.xml

@@ -18,7 +18,7 @@
 
     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
         <encoder>
-            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} %X{orgId} %X{envId} - %msg%n</pattern>
         </encoder>
     </appender>
 

gravitee-apim-rest-api/gravitee-apim-rest-api-management/gravitee-apim-rest-api-management-security/src/main/java/io/gravitee/rest/api/management/security/config/BasicSecurityConfigurerAdapter.java

@@ -29,6 +29,7 @@
 import io.gravitee.rest.api.security.cookies.CookieGenerator;
 import io.gravitee.rest.api.security.csrf.CookieCsrfSignedTokenRepository;
 import io.gravitee.rest.api.security.csrf.CsrfRequestMatcher;
+import io.gravitee.rest.api.security.filter.ContextualLoggingFilter;
 import io.gravitee.rest.api.security.filter.CsrfIncludeFilter;
 import io.gravitee.rest.api.security.filter.GraviteeContextAuthorizationFilter;
 import io.gravitee.rest.api.security.filter.GraviteeContextFilter;
@@ -198,6 +199,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
             new GraviteeContextFilter(installationTypeDomainService, accessPointQueryService, environmentService),
             CorsFilter.class
         );
+        http.addFilterAfter(new ContextualLoggingFilter(), GraviteeContextFilter.class);
         http.addFilterAfter(new GraviteeContextAuthorizationFilter(), AuthorizationFilter.class);
 
         return http.build();

gravitee-apim-rest-api/gravitee-apim-rest-api-security/src/main/java/io/gravitee/rest/api/security/filter/ContextualLoggingFilter.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright © 2015 The Gravitee team (http://gravitee.io)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.gravitee.rest.api.security.filter;
+
+import io.gravitee.rest.api.service.common.GraviteeContext;
+import jakarta.servlet.FilterChain;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.ServletRequest;
+import jakarta.servlet.ServletResponse;
+import java.io.IOException;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.slf4j.MDC;
+import org.springframework.web.filter.GenericFilterBean;
+
+@Slf4j
+@RequiredArgsConstructor
+public class ContextualLoggingFilter extends GenericFilterBean {
+
+    @Override
+    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
+        MDC.clear();
+        String organization = GraviteeContext.getCurrentOrganization();
+
+        if (organization != null) {
+            MDC.put("orgId", organization);
+        }
+        String environment = GraviteeContext.getCurrentEnvironment();
+
+        if (environment != null) {
+            MDC.put("envId", environment);
+        }
+
+        log.debug("Contextual logging is on");
+
+        filterChain.doFilter(request, response);
+    }
+}

helm/templates/api/api-configmap.yaml

@@ -694,9 +694,15 @@ data:
           <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
               <file>${gravitee.management.log.dir}/gravitee.log</file>
 {{ .Values.api.logging.file.rollingPolicy | indent 14 }}
+              {{- if .Values.api.logging.file.contextualLoggingEnabled}}
+              <encoder>
+                  <pattern>{{ .Values.api.logging.file.contextualLoggingEncoderPattern }}</pattern>
+              </encoder>
+              {{- else}}
               <encoder>
                   <pattern>{{ .Values.api.logging.file.encoderPattern }}</pattern>
               </encoder>
+              {{- end}}
           </appender>
           {{- end }}
 

helm/values.yaml

@@ -475,6 +475,7 @@ api:
       encoderPattern: "%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"
     file:
       enabled: true
+      contextualLoggingEnabled: false
       rollingPolicy: |
         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
             <!-- daily rollover -->
@@ -483,6 +484,7 @@ api:
             <maxHistory>30</maxHistory>
         </rollingPolicy>
       encoderPattern: "%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n%n"
+      contextualLoggingEncoderPattern: "%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} %X{orgId} %X{envId} - %msg%n%n"
     graviteeLevel: DEBUG
     jettyLevel: INFO
   restartPolicy: OnFailure