Remove stack traces and exception causes from logs

Signed-off-by: Daniel Widdis <[email protected]>
opensearch-project · Feb 16, 2024 · 495e5db · 495e5db
1 parent 13f672e
commit 495e5db
Show file tree

Hide file tree

Showing 41 changed files with 309 additions and 283 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,22 +1,23 @@
-CHANGELOG
-
+# CHANGELOG
+All notable changes to this project are documented in this file.
 
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
-2.12.0 Initial Release
-## [Unreleased]
-### Added
-- Github workflow for changelog verification ([#440](https://github.com/opensearch-project/flow-framework/pull/440))
-
-### Changed
-
-### Deprecated
-
-### Removed
-
-### Fixed
-
-### Security
-
-
-[Unreleased]: https://github.com/opensearch-project/flow-framework/compare/2.x...HEAD
+## [Unreleased 3.0](https://github.com/opensearch-project/flow-framework/compare/2.x...HEAD)
+### Features
+### Enhancements
+### Bug Fixes
+### Infrastructure
+### Documentation
+### Maintenance
+### Refactoring
+
+## [Unreleased 2.x](https://github.com/opensearch-project/flow-framework/compare/2.12...2.x)
+### Features
+### Enhancements
+### Bug Fixes
+### Infrastructure
+### Documentation
+### Maintenance
+### Refactoring
+- Remove stack traces and exception causes from logs ([#524](https://github.com/opensearch-project/flow-framework/pull/524))
diff --git a/src/main/java/org/opensearch/flowframework/indices/FlowFrameworkIndicesHandler.java b/src/main/java/org/opensearch/flowframework/indices/FlowFrameworkIndicesHandler.java
diff --git a/src/main/java/org/opensearch/flowframework/model/Template.java b/src/main/java/org/opensearch/flowframework/model/Template.java
@@ -367,7 +367,7 @@ public String toJson() {
             XContentBuilder builder = JsonXContent.contentBuilder();
             return this.toXContent(builder, EMPTY_PARAMS).toString();
         } catch (IOException e) {
-            return "{\"error\": \"couldn't create JSON: " + e.getMessage() + "\"}";
+            return "{\"error\": \"couldn't create JSON from XContent\"}";
         }
     }
 
@@ -381,7 +381,7 @@ public String toYaml() {
             XContentBuilder builder = YamlXContent.contentBuilder();
             return this.toXContent(builder, EMPTY_PARAMS).toString();
         } catch (IOException e) {
-            return "error: couldn't create YAML: " + e.getMessage();
+            return "error: couldn't create YAML from XContent";
         }
     }
 

diff --git a/src/main/java/org/opensearch/flowframework/model/WorkflowStepValidator.java b/src/main/java/org/opensearch/flowframework/model/WorkflowStepValidator.java
@@ -97,11 +97,9 @@ public static WorkflowStepValidator parse(XContentParser parser) throws IOExcept
                     try {
                         timeout = TimeValue.parseTimeValue(parser.text(), TIMEOUT);
                     } catch (IllegalArgumentException e) {
-                        logger.error("Failed to parse TIMEOUT value for field [{}]", fieldName, e);
-                        throw new FlowFrameworkException(
-                            "Failed to parse workflow-step.json file for field [" + fieldName + "]",
-                            RestStatus.INTERNAL_SERVER_ERROR
-                        );
+                        String errorMessage = "Failed to parse workflow-step.json file for field [" + fieldName + "]";
+                        logger.error(errorMessage);
+                        throw new FlowFrameworkException(errorMessage, RestStatus.INTERNAL_SERVER_ERROR);
                     }
                     break;
                 default:

diff --git a/src/main/java/org/opensearch/flowframework/model/WorkflowValidator.java b/src/main/java/org/opensearch/flowframework/model/WorkflowValidator.java
@@ -76,7 +76,7 @@ public String toJson() {
             XContentBuilder builder = JsonXContent.contentBuilder();
             return this.toXContent(builder, EMPTY_PARAMS).toString();
         } catch (IOException e) {
-            return "{\"error\": \"couldn't create JSON: " + e.getMessage() + "\"}";
+            return "{\"error\": \"couldn't create JSON from XContent\"}";
         }
     }
 

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestCreateWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestCreateWorkflowAction.java
@@ -98,16 +98,24 @@ protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient cli
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to create workflow.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
                 } catch (IOException e) {
-                    logger.error("Failed to send back provision workflow exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back create workflow exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
-        } catch (Exception e) {
-            FlowFrameworkException ex = new FlowFrameworkException(e.getMessage(), RestStatus.BAD_REQUEST);
+        } catch (FlowFrameworkException e) {
+            return channel -> channel.sendResponse(
+                new BytesRestResponse(e.getRestStatus(), e.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))
+            );
+        } catch (IOException e) {
+            FlowFrameworkException ex = new FlowFrameworkException(
+                "IOException: template content invalid for specified Content-Type.",
+                RestStatus.BAD_REQUEST
+            );
             return channel -> channel.sendResponse(
                 new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))
             );

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestDeleteWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestDeleteWorkflowAction.java
@@ -86,16 +86,15 @@ protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to delete workflow.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
-
                 } catch (IOException e) {
-                    logger.error("Failed to send back delete workflow exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back delete workflow exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
-
         } catch (FlowFrameworkException ex) {
             return channel -> channel.sendResponse(
                 new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestDeprovisionWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestDeprovisionWorkflowAction.java
@@ -82,15 +82,15 @@ protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to deprovision workflow.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
                 } catch (IOException e) {
-                    logger.error("Failed to send back provision workflow exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back deprovision workflow exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
-
         } catch (FlowFrameworkException ex) {
             return channel -> channel.sendResponse(
                 new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestGetWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestGetWorkflowAction.java
@@ -87,16 +87,15 @@ protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to get workflow.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
-
                 } catch (IOException e) {
-                    logger.error("Failed to send back get workflow exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back get workflow exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
-
         } catch (FlowFrameworkException ex) {
             return channel -> channel.sendResponse(
                 new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestGetWorkflowStateAction.java b/src/main/java/org/opensearch/flowframework/rest/RestGetWorkflowStateAction.java
@@ -84,16 +84,15 @@ protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to get workflow state.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
-
                 } catch (IOException e) {
-                    logger.error("Failed to send back provision workflow exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back get workflow state exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
-
         } catch (FlowFrameworkException ex) {
             return channel -> channel.sendResponse(
                 new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestGetWorkflowStepAction.java b/src/main/java/org/opensearch/flowframework/rest/RestGetWorkflowStepAction.java
@@ -82,16 +82,15 @@ public ActionRequestValidationException validate() {
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to get workflow step.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
-
                 } catch (IOException e) {
-                    logger.error("Failed to send back get workflow step exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back get workflow step exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
-
         } catch (FlowFrameworkException ex) {
             return channel -> channel.sendResponse(
                 new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS))

diff --git a/src/main/java/org/opensearch/flowframework/rest/RestProvisionWorkflowAction.java b/src/main/java/org/opensearch/flowframework/rest/RestProvisionWorkflowAction.java
@@ -93,12 +93,13 @@ protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient cli
                 try {
                     FlowFrameworkException ex = exception instanceof FlowFrameworkException
                         ? (FlowFrameworkException) exception
-                        : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception));
+                        : new FlowFrameworkException("Failed to provision workflow.", ExceptionsHelper.status(exception));
                     XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS);
                     channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder));
                 } catch (IOException e) {
-                    logger.error("Failed to send back provision workflow exception", e);
-                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage()));
+                    String errorMessage = "IOException: Failed to send back provision workflow exception";
+                    logger.error(errorMessage);
+                    channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), errorMessage));
                 }
             }));
         } catch (FlowFrameworkException ex) {