Improve Jira logging (#5351)

Improve Jira logging Signed-off-by: Maxwell Brown <[email protected]>
opensearch-project · Jan 30, 2025 · 414a7c9 · 414a7c9
1 parent 49c6a2b
commit 414a7c9
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 14 deletions.
diff --git a/...jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraService.java b/...jira-source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraService.java
@@ -166,7 +166,7 @@ private StringBuilder createIssueFilterCriteria(JiraSourceConfig configuration,
                             .collect(Collectors.joining(DELIMITER, PREFIX, SUFFIX)))
                     .append(CLOSING_ROUND_BRACKET);
         }
-        log.error("Created issue filter criteria JiraQl query: {}", jiraQl);
+        log.info("Created issue filter criteria JiraQl query: {}", jiraQl);
         return jiraQl;
     }
 

diff --git a/...source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraSourceConfig.java b/...source/src/main/java/org/opensearch/dataprepper/plugins/source/jira/JiraSourceConfig.java
@@ -12,6 +12,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import jakarta.validation.Valid;
+import jakarta.validation.constraints.AssertTrue;
 import lombok.Getter;
 import org.opensearch.dataprepper.plugins.source.jira.configuration.AuthenticationConfig;
 import org.opensearch.dataprepper.plugins.source.jira.configuration.FilterConfig;
@@ -30,6 +31,11 @@ public class JiraSourceConfig implements CrawlerSourceConfig {
     @JsonProperty("hosts")
     private List<String> hosts;
 
+    @AssertTrue(message = "Jira hosts must be a list of length 1")
+    boolean isValidHosts() {
+        return hosts != null && hosts.size() == 1;
+    }
+
     /**
      * Authentication Config to Access Jira
      */

diff --git a/...rce/src/main/java/org/opensearch/dataprepper/plugins/source/jira/rest/JiraRestClient.java b/...rce/src/main/java/org/opensearch/dataprepper/plugins/source/jira/rest/JiraRestClient.java
@@ -51,13 +51,11 @@ public class JiraRestClient {
     public static final List<Integer> RETRY_ATTEMPT_SLEEP_TIME = List.of(1, 2, 5, 10, 20, 40);
     private static final String TICKET_FETCH_LATENCY_TIMER = "ticketFetchLatency";
     private static final String SEARCH_CALL_LATENCY_TIMER = "searchCallLatency";
-    private static final String PROJECTS_FETCH_LATENCY_TIMER = "projectFetchLatency";
     private static final String ISSUES_REQUESTED = "issuesRequested";
     private final RestTemplate restTemplate;
     private final JiraAuthConfig authConfig;
     private final Timer ticketFetchLatencyTimer;
     private final Timer searchCallLatencyTimer;
-    private final Timer projectFetchLatencyTimer;
     private final Counter issuesRequestedCounter;
     private final PluginMetrics jiraPluginMetrics = PluginMetrics.fromNames("jiraRestClient", "aws");
     private int sleepTimeMultiplier = 1000;
@@ -68,8 +66,6 @@ public JiraRestClient(RestTemplate restTemplate, JiraAuthConfig authConfig) {
 
         ticketFetchLatencyTimer = jiraPluginMetrics.timer(TICKET_FETCH_LATENCY_TIMER);
         searchCallLatencyTimer = jiraPluginMetrics.timer(SEARCH_CALL_LATENCY_TIMER);
-        projectFetchLatencyTimer = jiraPluginMetrics.timer(PROJECTS_FETCH_LATENCY_TIMER);
-
         issuesRequestedCounter = jiraPluginMetrics.counter(ISSUES_REQUESTED);
     }
 
@@ -119,20 +115,24 @@ private <T> ResponseEntity<T> invokeRestApi(URI uri, Class<T> responseType) thro
             } catch (HttpClientErrorException ex) {
                 HttpStatus statusCode = ex.getStatusCode();
                 String statusMessage = ex.getMessage();
-                log.error("An exception has occurred while getting response from Jira search API  {}", ex.getMessage());
+                log.error(NOISY, "An exception has occurred while getting response from Jira search API with statusCode {} and error message: {}", statusCode, statusMessage);
                 if (statusCode == HttpStatus.FORBIDDEN) {
                     throw new UnAuthorizedException(statusMessage);
                 } else if (statusCode == HttpStatus.UNAUTHORIZED) {
-                    log.error(NOISY, "Token expired. We will try to renew the tokens now", ex);
+                    log.warn(NOISY, "Token expired. We will try to renew the tokens now.");
                     authConfig.renewCredentials();
-                } else if (statusCode == HttpStatus.TOO_MANY_REQUESTS) {
-                    log.error(NOISY, "Hitting API rate limit. Backing off with sleep timer.", ex);
+                } else if (statusCode == HttpStatus.TOO_MANY_REQUESTS || statusCode == HttpStatus.SERVICE_UNAVAILABLE || statusCode == HttpStatus.GATEWAY_TIMEOUT) {
+                    log.error(NOISY, "Received {}. Backing off with sleep timer for {} seconds.", statusCode, RETRY_ATTEMPT_SLEEP_TIME.get(retryCount));
+                } else {
+                    log.error(NOISY, "Received an unexpected status code {} response from Jira.", statusCode, ex);
                 }
                 try {
                     Thread.sleep((long) RETRY_ATTEMPT_SLEEP_TIME.get(retryCount) * sleepTimeMultiplier);
                 } catch (InterruptedException e) {
-                    throw new RuntimeException("Sleep in the retry attempt got interrupted", e);
+                    throw new RuntimeException("Sleep in the retry attempt got interrupted.");
                 }
+            } catch (Exception ex) {
+                log.error(NOISY, "An exception has occurred while getting a response from the Jira search API", ex);
             }
             retryCount++;
         }

diff --git a/...c/main/java/org/opensearch/dataprepper/plugins/source/jira/rest/auth/JiraOauthConfig.java b/...c/main/java/org/opensearch/dataprepper/plugins/source/jira/rest/auth/JiraOauthConfig.java
@@ -100,7 +100,7 @@ public String getJiraAccountCloudId() {
                     if (e.getRawStatusCode() == HttpStatus.UNAUTHORIZED.value()) {
                         renewCredentials();
                     }
-                    log.error("Error occurred while accessing resources: ", e);
+                    log.error("Error occurred while accessing resources.  Status code: {}.  Error message: {}", e.getStatusCode(), e.getMessage());
                 }
             }
             throw new UnAuthorizedException(String.format("Access token expired. Unable to renew even after %s attempts", RETRY_ATTEMPT));
@@ -153,6 +153,7 @@ public void renewCredentials() {
                     this.accessToken = (String) oauth2Config.getAccessToken().getValue();
                     this.refreshToken = (String) oauth2Config.getRefreshToken().getValue();
                     this.expireTime = Instant.now().plusSeconds(10);
+                    log.info("Access Token and Refresh Token pair is now refreshed.");
                 }
                 throw new RuntimeException("Failed to renew access token message:" + ex.getMessage(), ex);
             }

diff --git a/...src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/AddressValidation.java b/...src/main/java/org/opensearch/dataprepper/plugins/source/jira/utils/AddressValidation.java
@@ -38,7 +38,7 @@ public static InetAddress getInetAddress(String url) {
         try {
             return InetAddress.getByName(new URL(url).getHost());
         } catch (UnknownHostException | MalformedURLException e) {
-            log.error(INVALID_URL, e);
+            log.error("{}: {}", INVALID_URL, url);
             throw new BadRequestException(e.getMessage(), e);
         }
     }

diff --git a/...rch/dataprepper/plugins/source/source_crawler/coordination/partition/LeaderPartition.java b/...rch/dataprepper/plugins/source/source_crawler/coordination/partition/LeaderPartition.java
@@ -75,7 +75,7 @@ public LeaderProgressState convertToPartitionState(final String serializedPartit
         try {
             return objectMapper.readValue(serializedPartitionProgressState, LeaderProgressState.class);
         } catch (final JsonProcessingException e) {
-            LOG.error("Unable to convert string to partition progress state class ", e);
+            LOG.error("Unable to convert string to partition progress state class due to {}.  Partition progress state string: {}.", e.getMessage(), serializedPartitionProgressState);
             return null;
         }
     }

diff --git a/...rch/dataprepper/plugins/source/source_crawler/coordination/scheduler/WorkerScheduler.java b/...rch/dataprepper/plugins/source/source_crawler/coordination/scheduler/WorkerScheduler.java
@@ -89,7 +89,7 @@ public void run() {
                 try {
                     Thread.sleep(RETRY_BACKOFF_ON_EXCEPTION_MILLIS);
                 } catch (InterruptedException ex) {
-                    log.warn("Thread interrupted while waiting to retry", ex);
+                    log.warn("Thread interrupted while waiting to retry due to {}", ex.getMessage());
                 }
             }
         }