Add content type

Author: russgold

wls-exporter-core/src/main/java/com/oracle/wls/exporter/AuthenticatedCall.java

@@ -1,17 +1,20 @@
-// Copyright (c) 2017, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2017, 2025, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.exporter;
 
 import java.io.IOException;
 import java.io.PrintStream;
+import java.time.Duration;
 import java.time.OffsetDateTime;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.stream.Collectors;
 
 import com.oracle.wls.exporter.domain.MBeanSelector;
@@ -38,11 +41,12 @@ public abstract class AuthenticatedCall {
      * A map of authentication credentials to lists of cookies. The cookies will be sent on any request with
      * the specified credentials.
      */
-    private static final Map<String,List<Cookie>> COOKIES = new HashMap<>();
+    private static final Map<String,Map<String,Cookie>> COOKIES = new HashMap<>();
 
     private final WebClientFactory webClientFactory;
     private final InvocationContext context;
     private final UrlBuilder urlBuilder;
+    private static final List<Retry> callRetries = new ArrayList<>();
 
     // For unit testing only
     static void clearCookies() {
@@ -55,6 +59,10 @@ protected AuthenticatedCall(WebClientFactory webClientFactory, InvocationContext
         this.urlBuilder = context.createUrlBuilder();
     }
 
+    public static int getRecentRetries() {
+        return callRetries.size();
+    }
+
     public String getAuthenticationUrl() {
         return urlBuilder.createUrl(QueryType.RUNTIME_URL_PATTERN);
     }
@@ -86,23 +94,25 @@ private void manageCookies(WebClient webClient) {
 
     public List<String> getCookies(String credentials) {
         final OffsetDateTime now = SystemClock.now();
-        final List<Cookie> cookieList = getCookieList(credentials);
+        final Collection<Cookie> cookieList = getCookieList(credentials);
         cookieList.removeIf(c -> c.isExpiredAt(now));
 
         return cookieList.stream().map(Cookie::getValue).collect(Collectors.toList());
     }
 
-    private List<Cookie> getCookieList(String credentials) {
-        return Optional.ofNullable(COOKIES.get(credentials)).orElse(Collections.emptyList());
+    private Collection<Cookie> getCookieList(String credentials) {
+        return Optional.ofNullable(COOKIES.get(credentials))
+              .map(Map::values)
+              .orElse(Collections.emptySet());
     }
 
     void handleNewCookie(String cookieHeader) {
         if (context.getAuthenticationHeader() == null) return;
 
         final Cookie cookie = new Cookie(cookieHeader);
         COOKIES
-              .computeIfAbsent(context.getAuthenticationHeader(), h -> new ArrayList<>())
-              .add(cookie);
+              .computeIfAbsent(context.getAuthenticationHeader(), h -> new HashMap<>())
+              .put(cookie.getCookieName(), cookie);
     }
 
     private static class Cookie {
@@ -117,6 +127,13 @@ String getValue() {
             return value;
         }
 
+        String getCookieName() {
+            if (!value.contains("="))
+                return value;
+            else
+                return value.substring(0, value.indexOf('='));
+        }
+
         boolean isExpiredAt(OffsetDateTime now) {
             return now.isAfter(expirationTime);
         }
@@ -184,9 +201,12 @@ public String getRequestContentType() {
 
 
     private void performRequest(WebClient webClient) throws IOException {
+        boolean retryNeeded;
         do {
             invoke(webClient, context);
-        } while (webClient.isRetryNeeded());
+            retryNeeded = webClient.isRetryNeeded();
+            if (retryNeeded) addRetry();
+        } while (retryNeeded);
     }
 
     private void reportUnableToContactRestApiPort(String uri) throws IOException {
@@ -211,4 +231,20 @@ private void reportUnableToContactRestApiPort(String uri) throws IOException {
      */
     protected abstract void invoke(WebClient webClient, InvocationContext context) throws IOException;
 
+    private void addRetry() {
+        callRetries.removeIf(Retry::isObsolete);
+        callRetries.add(new Retry());
+    }
+
+    private static class Retry {
+        private final OffsetDateTime time;
+
+        Retry() {
+            this.time = SystemClock.now();
+        }
+
+        private boolean isObsolete() {
+            return Duration.between(time, SystemClock.now()).toMinutes() > 10;
+        }
+    }
 }

wls-exporter-core/src/main/java/com/oracle/wls/exporter/ExporterCall.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2021, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2021, 2025, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.exporter;
@@ -25,6 +25,7 @@ public ExporterCall(WebClientFactory webClientFactory, InvocationContext context
   @Override
   protected void invoke(WebClient webClient, InvocationContext context) throws IOException {
     LiveConfiguration.updateConfiguration();
+    context.setResponseHeader("Content-Type", "text/plain");
     try (OutputStream responseStream = context.getResponseStream();
          MetricsStream metricsStream = new MetricsStream(getInstanceName(), responseStream)) {
       if (!LiveConfiguration.hasQueries())

wls-exporter-core/src/main/java/com/oracle/wls/exporter/MetricsStream.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2017, 2025, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.exporter;
@@ -21,6 +21,14 @@
 class MetricsStream extends PrintStream {
     private static final String PROMETHEUS_LINE_SEPARATOR = "\n"; // This is not dependent on the platform running the exporter.
     private static final double NANOSEC_PER_SECONDS = 1000000000;
+    static final String CPU_USAGE_METRIC = "wls_scrape_cpu_seconds";
+    static final String NUM_MBEANS_SCRAPED_METRIC = "wls_scrape_mbeans_count_total";
+    static final String SCRAPE_DURATION_SECONDS_METRIC = "wls_scrape_duration_seconds";
+    static final String FREE_MEMORY_METRIC = "exporter_free_memory_bytes";
+    static final String MESSAGES_DIAGNOSTIC_SIZE = "exporter_messages_diagnostics_bytes";
+    static final String MAXIMUM_EXCHANGE_SIZE = "exporter_messages_maximum_exchange_bytes";
+    static final String RECENT_MESSAGES_DIAGNOSTIC_SIZE = "exporter_messages_recent_bytes";
+    static final String RECENT_RETRIES = "exporter_recent_retries";
 
     private final PerformanceProbe performanceProbe;
     private final long startTime;
@@ -67,14 +75,19 @@ void printMetric(String name, Object value) {
      * Prints the summary performance metrics
      */
     void printPlatformMetrics() {
-        printMetric(getCountName(), scrapeCount);
-        printMetric(getDurationName(), toSecondsString(getElapsedTime()));
-        printMetric(getCpuUsageName(), toSecondsString(getCpuUsed()));
+        printPlatformMetric(NUM_MBEANS_SCRAPED_METRIC, scrapeCount);
+        printPlatformMetric(SCRAPE_DURATION_SECONDS_METRIC, toSecondsString(getElapsedTime()));
+        printPlatformMetric(CPU_USAGE_METRIC, toSecondsString(getCpuUsed()));
+        printPlatformMetric(FREE_MEMORY_METRIC, Runtime.getRuntime().freeMemory());
+        printPlatformMetric(MESSAGES_DIAGNOSTIC_SIZE, WlsRestExchanges.getMessageAllocation());
+        printPlatformMetric(MAXIMUM_EXCHANGE_SIZE, WlsRestExchanges.getMaximumExchangeLength());
+        printPlatformMetric(RECENT_MESSAGES_DIAGNOSTIC_SIZE, WlsRestExchanges.getTotalExchangeLengthOverPastTenMinutes());
+        printPlatformMetric(RECENT_RETRIES, AuthenticatedCall.getRecentRetries());
         printMetric(getExporterVersionName(), 1);
     }
 
-    private String getDurationName() {
-        return "wls_scrape_duration_seconds" + getPlatformQualifier();
+    private void printPlatformMetric(String metricName, Object value) {
+        printMetric(metricName + getPlatformQualifier(), value);
     }
 
     /**
@@ -85,14 +98,6 @@ private String getPlatformQualifier() {
         return String.format("{instance=\"%s\"}", instance);
     }
 
-    private String getCpuUsageName() {
-        return "wls_scrape_cpu_seconds" + getPlatformQualifier();
-    }
-
-    private String getCountName() {
-        return "wls_scrape_mbeans_count_total" + getPlatformQualifier();
-    }
-
     private String getExporterVersionName() {
         return "exporter_version" + getExporterVersionQualifier();
     }

wls-exporter-core/src/main/java/com/oracle/wls/exporter/WlsRestExchanges.java

@@ -1,12 +1,15 @@
-// Copyright (c) 2021, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2021, 2025, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.exporter;
 
-import java.util.ArrayList;
+import java.nio.charset.Charset;
+import java.time.Duration;
+import java.time.OffsetDateTime;
 import java.util.List;
 import java.util.Queue;
 import java.util.concurrent.ConcurrentLinkedDeque;
+import java.util.stream.Collectors;
 
 import static java.time.format.DateTimeFormatter.ISO_LOCAL_TIME;
 
@@ -18,7 +21,34 @@ public class WlsRestExchanges {
   public static final int MAX_EXCHANGES = 5;
   private static final String TEMPLATE = "At %s, REQUEST to %s:%n%s%nREPLY:%n%s%n";
 
-  private static final Queue<String> exchanges = new ConcurrentLinkedDeque<>();
+  private static final Queue<Exchange> exchanges = new ConcurrentLinkedDeque<>();
+  static final int TEN_MINUTES = 10;
+
+  private static class Exchange {
+    private final OffsetDateTime time;
+    private final String url;
+    private final String request;
+    private final String response;
+
+    Exchange(String url, String request, String response) {
+      this.time = SystemClock.now();
+      this.url = url;
+      this.request = request;
+      this.response = response;
+    }
+
+    private String getContent() {
+      return String.format(TEMPLATE, ISO_LOCAL_TIME.format(time), url, request, response);
+    }
+
+    private int getContentLength() {
+      return getContent().getBytes(Charset.defaultCharset()).length;
+    }
+
+    private boolean isWithinTenMinutes() {
+      return Duration.between(time, SystemClock.now()).toMinutes() <= TEN_MINUTES;
+    }
+  }
 
   private WlsRestExchanges() {
   }
@@ -27,7 +57,7 @@ private WlsRestExchanges() {
    * Returns a list of the most recent exchanges.
    */
   public static List<String> getExchanges() {
-      return new ArrayList<>(exchanges);
+      return exchanges.stream().map(Exchange::getContent).collect(Collectors.toList());
   }
 
   /**
@@ -37,18 +67,26 @@ public static List<String> getExchanges() {
    * @param response the returned JSON string
    */
   public static void addExchange(String url, String request, String response) {
-      exchanges.add(String.format(TEMPLATE, getCurrentTime(), url, request, response));
+      exchanges.add(new Exchange(url, request, response));
       if (exchanges.size() > MAX_EXCHANGES) exchanges.remove();
   }
 
-  private static String getCurrentTime() {
-    return ISO_LOCAL_TIME.format(SystemClock.now());
-  }
-
   /**
    * Clears the set of recorded exchanges. Intended for unit testing.
    */
   public static void clear() {
       exchanges.clear();
   }
+
+  public static int getMessageAllocation() {
+    return exchanges.stream().map(Exchange::getContentLength).reduce(Integer::sum).orElse(0);
+  }
+
+  public static int getMaximumExchangeLength() {
+    return exchanges.stream().map(Exchange::getContentLength).reduce(Math::max).orElse(0);
+  }
+
+  public static int getTotalExchangeLengthOverPastTenMinutes() {
+    return exchanges.stream().filter(Exchange::isWithinTenMinutes).map(Exchange::getContentLength).reduce(Integer::sum).orElse(0);
+  }
 }

wls-exporter-core/src/test/java/com/oracle/wls/exporter/AuthenticatedCallTest.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2023, Oracle and/or its affiliates.
+// Copyright (c) 2023, 2025, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.exporter;
@@ -64,7 +64,7 @@ private void configureResponseWithSetCookieHeaders() {
           .addResponse();
   }
 
-  @Test 
+  @Test
   void whenResponseFromRestApiContainsSetCookieHeaders_cacheThem() throws IOException {
     configureResponseWithSetCookieHeaders();
 
@@ -73,6 +73,21 @@ void whenResponseFromRestApiContainsSetCookieHeaders_cacheThem() throws IOExcept
     assertThat(callStub.getCookies(CREDENTIALS), containsInAnyOrder("cookie1=value1", "cookie2=value2"));
   }
 
+  @Test
+  void whenMultipleResponsesContainsSetCookieHeadersWithTheSameName_keepOnlyTheLast() throws IOException {
+    handleServerCookieWithValue("value1");
+    handleServerCookieWithValue("value2");
+
+    assertThat(callStub.getCookies(CREDENTIALS), containsInAnyOrder("cookie1=value2"));
+  }
+
+  private void handleServerCookieWithValue(String cookieValue) throws IOException {
+    webClientFactory.forJson("{}")
+          .withResponseHeader(SET_COOKIE_HEADER, "cookie1=" + cookieValue)
+          .addResponse();
+    callStub.doWithAuthentication();
+  }
+
   @Test
   void whenResponseFromRestApiContainsSetCookieHeaders_ignoreForDifferentCredentials() throws IOException {
     configureResponseWithSetCookieHeaders();

wls-exporter-core/src/test/java/com/oracle/wls/exporter/ExporterServletTest.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, 2023, Oracle and/or its affiliates.
+// Copyright (c) 2017, 2025, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.exporter;
@@ -21,6 +21,11 @@
 
 import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath;
 import static com.oracle.wls.exporter.InMemoryFileSystem.withNoParams;
+import static com.oracle.wls.exporter.MetricsStream.FREE_MEMORY_METRIC;
+import static com.oracle.wls.exporter.MetricsStream.MAXIMUM_EXCHANGE_SIZE;
+import static com.oracle.wls.exporter.MetricsStream.MESSAGES_DIAGNOSTIC_SIZE;
+import static com.oracle.wls.exporter.MetricsStream.NUM_MBEANS_SCRAPED_METRIC;
+import static com.oracle.wls.exporter.MetricsStream.RECENT_MESSAGES_DIAGNOSTIC_SIZE;
 import static com.oracle.wls.exporter.WebAppConstants.AUTHENTICATION_CHALLENGE_HEADER;
 import static com.oracle.wls.exporter.WebAppConstants.AUTHENTICATION_HEADER;
 import static com.oracle.wls.exporter.matchers.CommentsOnlyMatcher.containsOnlyComments;
@@ -322,7 +327,11 @@ void onGet_producePerformanceMetrics() throws Exception {
 
         servlet.doGet(request, response);
 
-        assertThat(toHtml(response), containsString("wls_scrape_mbeans_count_total"));
+        assertThat(toHtml(response), containsString(NUM_MBEANS_SCRAPED_METRIC + "{instance="));
+        assertThat(toHtml(response), containsString(FREE_MEMORY_METRIC));
+        assertThat(toHtml(response), containsString(MESSAGES_DIAGNOSTIC_SIZE));
+        assertThat(toHtml(response), containsString(MAXIMUM_EXCHANGE_SIZE));
+        assertThat(toHtml(response), containsString(RECENT_MESSAGES_DIAGNOSTIC_SIZE));
     }
 
     @Test