Add back stack traces in error logging for failed transport queries

Signed-off-by: Daniel Widdis <[email protected]>
opensearch-project · Feb 26, 2024 · 899f031 · 899f031
1 parent 28c331c
commit 899f031
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,19 +14,16 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## [Unreleased 2.x](https://github.com/opensearch-project/flow-framework/compare/2.12...2.x)
 ### Features
-<<<<<<< HEAD
 - Add HttpHost WorkflowStep ([#530](https://github.com/opensearch-project/flow-framework/pull/530))
 
 ### Enhancements
 - Substitute REST path or body parameters in Workflow Steps ([#525](https://github.com/opensearch-project/flow-framework/pull/525))
 
-=======
 ### Enhancements
->>>>>>> 495e5db (Remove stack traces and exception causes from logs)
 ### Bug Fixes
 ### Infrastructure
 ### Documentation
 ### Maintenance
 ### Refactoring
 - Moved workflow-steps.json to Enum ([#523](https://github.com/opensearch-project/flow-framework/pull/523))
-- Refactored loging for consistency ([#524](https://github.com/opensearch-project/flow-framework/pull/524))
+- Refactored logging for consistency ([#524](https://github.com/opensearch-project/flow-framework/pull/524))
diff --git a/src/main/java/org/opensearch/flowframework/transport/CreateWorkflowTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/CreateWorkflowTransportAction.java
@@ -110,7 +110,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                 validateWorkflows(templateWithUser);
             } catch (Exception e) {
                 String errorMessage = "Workflow validation failed for template " + templateWithUser.name();
-                logger.error(errorMessage);
+                logger.error(errorMessage, e);
                 listener.onFailure(
                     e instanceof FlowFrameworkException ? e : new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e))
                 );
@@ -163,7 +163,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                                                             listener.onResponse(new WorkflowResponse(provisionResponse.getWorkflowId()));
                                                         }, exception -> {
                                                             String errorMessage = "Provisioning failed.";
-                                                            logger.error(errorMessage);
+                                                            logger.error(errorMessage, exception);
                                                             if (exception instanceof FlowFrameworkException) {
                                                                 listener.onFailure(exception);
                                                             } else {
@@ -181,7 +181,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                                                 }
                                             }, exception -> {
                                                 String errorMessage = "Failed to save workflow state";
-                                                logger.error(errorMessage);
+                                                logger.error(errorMessage, exception);
                                                 if (exception instanceof FlowFrameworkException) {
                                                     listener.onFailure(exception);
                                                 } else {
@@ -191,7 +191,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                                         );
                                     }, exception -> {
                                         String errorMessage = "Failed to save use case template";
-                                        logger.error(errorMessage);
+                                        logger.error(errorMessage, exception);
                                         if (exception instanceof FlowFrameworkException) {
                                             listener.onFailure(exception);
                                         } else {
@@ -204,7 +204,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                             }
                         }, exception -> {
                             String errorMessage = "Failed to initialize config index";
-                            logger.error(errorMessage);
+                            logger.error(errorMessage, exception);
                             if (exception instanceof FlowFrameworkException) {
                                 listener.onFailure(exception);
                             } else {
@@ -214,7 +214,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                     }
                 }, exception -> {
                     String errorMessage = "Failed to update use case template " + request.getWorkflowId();
-                    logger.error(errorMessage);
+                    logger.error(errorMessage, exception);
                     if (exception instanceof FlowFrameworkException) {
                         listener.onFailure(exception);
                     } else {
@@ -239,7 +239,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                             listener.onResponse(new WorkflowResponse(request.getWorkflowId()));
                         }, exception -> {
                             String errorMessage = "Failed to update workflow " + request.getWorkflowId() + " in template index";
-                            logger.error(errorMessage);
+                            logger.error(errorMessage, exception);
                             if (exception instanceof FlowFrameworkException) {
                                 listener.onFailure(exception);
                             } else {
@@ -249,7 +249,7 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                     );
                 }, exception -> {
                     String errorMessage = "Failed to update use case template " + request.getWorkflowId();
-                    logger.error(errorMessage);
+                    logger.error(errorMessage, exception);
                     if (exception instanceof FlowFrameworkException) {
                         listener.onFailure(exception);
                     } else {
@@ -280,12 +280,12 @@ void checkMaxWorkflows(TimeValue requestTimeOut, Integer maxWorkflow, ActionList
                     internalListener.onResponse(searchResponse.getHits().getTotalHits().value < maxWorkflow);
                 }, exception -> {
                     String errorMessage = "Unable to fetch the workflows";
-                    logger.error(errorMessage);
+                    logger.error(errorMessage, exception);
                     internalListener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(exception)));
                 }));
             } catch (Exception e) {
                 String errorMessage = "Unable to fetch the workflows";
-                logger.error(errorMessage);
+                logger.error(errorMessage, e);
                 internalListener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e)));
             }
         }

diff --git a/src/main/java/org/opensearch/flowframework/transport/DeprovisionWorkflowTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/DeprovisionWorkflowTransportAction.java
@@ -107,12 +107,12 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                     .execute(() -> executeDeprovisionSequence(workflowId, response.getWorkflowState().resourcesCreated(), listener));
             }, exception -> {
                 String errorMessage = "Failed to get workflow state for workflow " + workflowId;
-                logger.error(errorMessage);
+                logger.error(errorMessage, exception);
                 listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(exception)));
             }));
         } catch (Exception e) {
             String errorMessage = "Failed to retrieve template from global context.";
-            logger.error(errorMessage);
+            logger.error(errorMessage, e);
             listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e)));
         }
     }
@@ -235,7 +235,7 @@ private void updateWorkflowState(
                 ),
                 ActionListener.wrap(updateResponse -> {
                     logger.info("updated workflow {} state to NOT_STARTED", workflowId);
-                }, exception -> { logger.error("Failed to update workflow state"); })
+                }, exception -> { logger.error("Failed to update workflow state", exception); })
             );
             // return workflow ID
             listener.onResponse(new WorkflowResponse(workflowId));
@@ -251,7 +251,7 @@ private void updateWorkflowState(
                 ),
                 ActionListener.wrap(updateResponse -> {
                     logger.info("updated workflow {} state to COMPLETED", workflowId);
-                }, exception -> { logger.error("Failed to update workflow {} state", workflowId); })
+                }, exception -> { logger.error("Failed to update workflow {} state", workflowId, exception); })
             );
             // give user list of remaining resources
             listener.onFailure(

diff --git a/src/main/java/org/opensearch/flowframework/transport/GetWorkflowStateTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/GetWorkflowStateTransportAction.java
@@ -79,7 +79,7 @@ protected void doExecute(Task task, GetWorkflowStateRequest request, ActionListe
                         listener.onResponse(new GetWorkflowStateResponse(workflowState, request.getAll()));
                     } catch (Exception e) {
                         String errorMessage = "Failed to parse workflowState: " + r.getId();
-                        logger.error(errorMessage);
+                        logger.error(errorMessage, e);
                         listener.onFailure(new FlowFrameworkException(errorMessage, RestStatus.BAD_REQUEST));
                     }
                 } else {
@@ -90,13 +90,13 @@ protected void doExecute(Task task, GetWorkflowStateRequest request, ActionListe
                     listener.onFailure(new FlowFrameworkException("Fail to find workflow " + workflowId, RestStatus.NOT_FOUND));
                 } else {
                     String errorMessage = "Failed to get workflow status of: " + workflowId;
-                    logger.error(errorMessage);
+                    logger.error(errorMessage, e);
                     listener.onFailure(new FlowFrameworkException(errorMessage, RestStatus.NOT_FOUND));
                 }
             }), context::restore));
         } catch (Exception e) {
             String errorMessage = "Failed to get workflow: " + workflowId;
-            logger.error(errorMessage);
+            logger.error(errorMessage, e);
             listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e)));
         }
     }

diff --git a/src/main/java/org/opensearch/flowframework/transport/GetWorkflowStepTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/GetWorkflowStepTransportAction.java
@@ -55,7 +55,7 @@ protected void doExecute(Task task, ActionRequest request, ActionListener<GetWor
             listener.onResponse(new GetWorkflowStepResponse(workflowValidator));
         } catch (Exception e) {
             String errorMessage = "Failed to retrieve workflow step json.";
-            logger.error(errorMessage);
+            logger.error(errorMessage, e);
             listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e)));
         }
     }

diff --git a/src/main/java/org/opensearch/flowframework/transport/GetWorkflowTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/GetWorkflowTransportAction.java
@@ -85,12 +85,12 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<GetW
                     }
                 }, exception -> {
                     String errorMessage = "Failed to retrieve template (" + workflowId + ") from global context.";
-                    logger.error(errorMessage);
+                    logger.error(errorMessage, exception);
                     listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(exception)));
                 }));
             } catch (Exception e) {
                 String errorMessage = "Failed to retrieve template (" + workflowId + ") from global context.";
-                logger.error(errorMessage);
+                logger.error(errorMessage, e);
                 listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e)));
             }
         } else {

diff --git a/src/main/java/org/opensearch/flowframework/transport/ProvisionWorkflowTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/ProvisionWorkflowTransportAction.java
@@ -148,13 +148,13 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                                 listener.onResponse(new WorkflowResponse(workflowId));
                             }, exception -> {
                                 String errorMessage = "Failed to update workflow state: " + workflowId;
-                                logger.error(errorMessage);
+                                logger.error(errorMessage, exception);
                                 listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(exception)));
                             })
                         );
                     } else {
                         String errorMessage = "The template has already been provisioned: " + workflowId;
-                        logger.error(errorMessage);
+                        logger.info(errorMessage);
                         listener.onFailure(new FlowFrameworkException(errorMessage, RestStatus.BAD_REQUEST));
                     }
                 }, listener);
@@ -164,13 +164,13 @@ protected void doExecute(Task task, WorkflowRequest request, ActionListener<Work
                     listener.onFailure(exception);
                 } else {
                     String errorMessage = "Failed to retrieve template from global context for workflow " + workflowId;
-                    logger.error(errorMessage);
+                    logger.error(errorMessage, exception);
                     listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(exception)));
                 }
             }));
         } catch (Exception e) {
             String errorMessage = "Failed to retrieve template from global context for workflow " + workflowId;
-            logger.error(errorMessage);
+            logger.error(errorMessage, e);
             listener.onFailure(new FlowFrameworkException(errorMessage, ExceptionsHelper.status(e)));
         }
     }
@@ -232,10 +232,10 @@ private void executeWorkflow(List<ProcessNode> workflowSequence, String workflow
                 ),
                 ActionListener.wrap(updateResponse -> {
                     logger.info("updated workflow {} state to {}", workflowId, State.COMPLETED);
-                }, exception -> { logger.error("Failed to update workflow state for workflow {}", workflowId); })
+                }, exception -> { logger.error("Failed to update workflow state for workflow {}", workflowId, exception); })
             );
         } catch (Exception ex) {
-            logger.error("Provisioning failed for workflow {} during step {}.", workflowId, currentStepId);
+            logger.error("Provisioning failed for workflow {} during step {}.", workflowId, currentStepId, ex);
             String errorMessage = (ex.getCause() == null ? ex.getClass().getName() : ex.getCause().getClass().getName())
                 + " during step "
                 + currentStepId;
@@ -249,7 +249,7 @@ private void executeWorkflow(List<ProcessNode> workflowSequence, String workflow
                 ),
                 ActionListener.wrap(updateResponse -> {
                     logger.info("updated workflow {} state to {}", workflowId, State.FAILED);
-                }, exceptionState -> { logger.error("Failed to update workflow state for workflow {}", workflowId); })
+                }, exceptionState -> { logger.error("Failed to update workflow state for workflow {}", workflowId, exceptionState); })
             );
         }
     }

diff --git a/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowStateTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowStateTransportAction.java
@@ -49,7 +49,7 @@ protected void doExecute(Task task, SearchRequest request, ActionListener<Search
             logger.info("Searching workflow states in global context");
             client.search(request, ActionListener.runBefore(actionListener, context::restore));
         } catch (Exception e) {
-            logger.error("Failed to search workflow states in global context");
+            logger.error("Failed to search workflow states in global context", e);
             actionListener.onFailure(e);
         }
     }

diff --git a/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowTransportAction.java b/src/main/java/org/opensearch/flowframework/transport/SearchWorkflowTransportAction.java
@@ -49,7 +49,7 @@ protected void doExecute(Task task, SearchRequest request, ActionListener<Search
             logger.info("Searching workflows in global context");
             client.search(request, ActionListener.runBefore(actionListener, context::restore));
         } catch (Exception e) {
-            logger.error("Failed to search workflows in global context");
+            logger.error("Failed to search workflows in global context", e);
             actionListener.onFailure(e);
         }
     }