Skip to content

Commit 67a0706

Browse files
IvanBorislavovDimitrovIvanBorislavovDimitrov
authored
Remove flowable exceptions from Operation logs (#1817)
LMCROSSITXSADEPLOY-3337
1 parent 6836a2c commit 67a0706

3 files changed

Lines changed: 26 additions & 23 deletions

File tree

‎multiapps-controller-process/src/main/java/org/cloudfoundry/multiapps/controller/process/Messages.java‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ public class Messages {
6161
public static final String ERROR_WHILE_CHECKING_SERVICE_KEY_OPERATION_0 = "Error while checking service key operation \"{0}\"";
6262
public static final String ERROR_OCCURRED_WHILE_CREATING_SERVICE_KEY_0 = "Error occurred while creating service key \"{0}\"";
6363
public static final String ERROR_OCCURRED_WHILE_DELETING_SERVICE_KEY_0 = "Error occurred while deleting service key \"{0}\"";
64-
public static final String OPERATION_FOR_SERVICE_KEY_0_FAILED_WITH_DESCRIPTION_1 = "Operation for service key \"{0}\", failed with description \"{1}\"";
65-
public static final String OPERATION_FOR_OPTIONAL_SERVICE_KEY_0_FAILED_WITH_DESCRIPTION_1 = "Operation for service key \"{0}\". for optional service, failed with description \"{1}\"";
64+
public static final String OPERATION_FOR_SERVICE_KEY_0_FAILED_WITH_DESCRIPTION_1 = "Operation for service key \"{0}\" failed: {1}";
65+
public static final String OPERATION_FOR_OPTIONAL_SERVICE_KEY_0_FAILED_WITH_DESCRIPTION_1 = "Operation for optional service key \"{0}\" failed: {1}";
6666
public static final String APPLICATION_0_WAS_NOT_FOUND = "Application \"{0}\" was not found";
6767
public static final String FAILED_TO_UPDATE_FILES_OF_OPERATION_0 = "Failed to update files of operation: {0}";
6868
public static final String COULD_NOT_DELETE_ORPHANED_FILES_MODIFIED_AFTER_0_AND_BEFORE_1 = "Could not delete orphaned files modified after {0} and before {1}";
@@ -88,13 +88,14 @@ public class Messages {
8888
public static final String SECRET_VALUE_NOT_FOUND_FOR_TOKEN_0_PID_1_VARIABLE_2 = "Secret value not found for token \"{0}\" (process instance id=\"{1}\", variable=\"{2}\")";
8989
public static final String INVALID_ENCRYPTION_KEY_LENGTH = "Length of the encryption key is invalid - it must be 32 characters long!";
9090
public static final String MISSING_MTA_ID_IN_ENCRYPTION_KEY_RESOLVER = "Missing mtaId in encryption key resolver! Cannot continue from here!";
91+
public static final String STEP_OF_THE_PROCESS_HAS_FAILED = "A step of the process has failed.";
9192

9293
// Audit log messages
9394

9495
// ERROR log messages
9596
public static final String COULD_NOT_COMPUTE_ORG_AND_SPACE = "Could not find org and space for space ID \"{0}\"";
9697
public static final String NO_BUILDS_FOUND_FOR_PACKAGE = "No builds found for package \"{0}\"";
97-
public static final String ASYNC_OPERATION_FOR_SERVICE_BROKER_FAILED_WITH = "Async operation for service broker \"{0}\" failed with \"{1}\"";
98+
public static final String ASYNC_OPERATION_FOR_SERVICE_BROKER_FAILED_WITH = "Async operation for service broker \"{0}\" failed with errors: {1}";
9899
public static final String CLEARING_STALE_FLOWABLE_LOCK_OWNER_0_THREW_AN_EXCEPTION_1 = "Clearing stale Flowable lock owner {0} threw an exception: {1}";
99100
public static final String SERVICE_INSTANCE_0_NOT_BOUND_TO_APP_1 = "Service instance \"{0}\" not bound to application \"{1}\"";
100101
public static final String ERROR_WHILE_DELETING_SERVICE_INSTANCE_METADATA_0 = "Error while deleting service instance metadata \"{0}\"";
@@ -136,21 +137,18 @@ public class Messages {
136137
public static final String ERROR_PREPARING_MODULES_DEPLOYMENT = "Error preparing modules deployment";
137138
public static final String ERROR_PREPARING_RESOURCES_FOR_PROCESSING_AND_RESOLVE_DYNAMIC_PARAMETERS = "Error preparing resources for processing and resolution of dynamic parameters";
138139
public static final String ERROR_STOPPING_APP = "Error stopping application \"{0}\"";
139-
public static final String DOWNLOAD_APP_LOGS_FOR_MORE_INFO = "Download the application logs via the dmol command and check them for more information.";
140+
public static final String DOWNLOAD_APP_LOGS_FOR_MORE_INFO = "Download the MTA operation logs for more details.";
140141
public static final String ERROR_STAGING_APP_0 = "Error staging application \"{0}\"";
141-
public static final String ERROR_STAGING_APP_0_DESCRIPTION_1 =
142-
"Error staging application \"{0}\": {1}\n" + DOWNLOAD_APP_LOGS_FOR_MORE_INFO;
142+
public static final String ERROR_STAGING_APP_0_DESCRIPTION_1 = "Error staging application \"{0}\": {1}. Check the application logs of your application for details.";
143143
public static final String ERROR_PUBLISHING_PUBLIC_PROVIDED_DEPENDENCIES = "Error publishing public provided dependencies";
144144
public static final String ERROR_STARTING_APP_0 = "Error starting application \"{0}\"";
145145
public static final String ERROR_NONE_OF_THE_INSTANCES_OF_THE_APP_0_BECOME_ROUTABLE = "None of the instances of the app \"{0}\" become routable. Please verify that the defined MTA parameters for the readiness health check align with the app’s code and configuration.";
146-
public static final String ERROR_STARTING_APP_0_DESCRIPTION_1 =
147-
"Error starting application \"{0}\": {1}\n" + DOWNLOAD_APP_LOGS_FOR_MORE_INFO;
146+
public static final String ERROR_STARTING_APP_0_DESCRIPTION_1 = "Error starting application \"{0}\": {1}";
148147
public static final String ERROR_EXECUTING_APP_1 = "Error executing application \"{0}\"";
149148
public static final String ERROR_EXECUTING_APP_2 = "Error executing application \"{0}\": {1}";
150149
public static final String ERROR_PREPARING_TO_EXECUTE_TASKS_ON_APP = "Error preparing to execute tasks on application \"{0}\"";
151150
public static final String ERROR_PREPARING_TO_RESTART_SERVICE_BROKER_SUBSCRIBERS = "Error preparing to restart service broker subscribers";
152-
public static final String ERROR_EXECUTING_TASK_0_ON_APP_1 =
153-
"Execution of task \"{0}\" on application \"{1}\" failed.\n" + DOWNLOAD_APP_LOGS_FOR_MORE_INFO;
151+
public static final String ERROR_EXECUTING_TASK_0_ON_APP_1 = "Execution of task \"{0}\" on application \"{1}\" failed.";
154152
public static final String ERROR_DETECTING_COMPONENTS_TO_UNDEPLOY = "Error detecting components to undeploy";
155153
public static final String ERROR_DELETING_IDLE_ROUTES = "Error deleting idle routes";
156154
public static final String ERROR_CREATING_SERVICE_BROKERS = "Error creating service brokers";
@@ -188,11 +186,11 @@ public class Messages {
188186
public static final String ERROR_WHILE_POLLING_SERVICE_BINDING_OPERATIONS_BETWEEN_APP_0_AND_SERVICE_INSTANCE_1 = "Error while polling service binding operations between app: \"{0}\" and service instance \"{1}\"";
189187
public static final String ERROR_WHILE_CHECKING_SERVICE_BINDING_OPERATIONS_BETWEEN_APP_0_AND_SERVICE_INSTANCE_1 = "Error while checking service binding operations between app: \"{0}\" and service instance \"{1}\"";
190188
public static final String ERROR_WHILE_CHECKING_SERVICE_BINDING_OPERATIONS_0 = "Error while checking service binding operations for service binding: \"{0}\"";
191-
public static final String ASYNC_OPERATION_FOR_SERVICE_BINDING_FAILED_WITH = "Async operation for service binding \"{0}\" between app \"{1}\" and service instance \"{2}\" with offering \"{3}\" and plan \"{4}\" failed with \"{5}\"";
192-
public static final String ASYNC_OPERATION_FOR_USER_PROVIDED_SERVICE_BINDING_FAILED_WITH = "Async operation for service binding \"{0}\" between app \"{1}\" and user-provided service instance \"{2}\" failed with \"{3}\"";
189+
public static final String ASYNC_OPERATION_FOR_SERVICE_BINDING_FAILED_WITH = "Async operation for service binding \"{0}\" between app \"{1}\" and service instance \"{2}\" with offering \"{3}\" and plan \"{4}\" failed with errors: {5}";
190+
public static final String ASYNC_OPERATION_FOR_USER_PROVIDED_SERVICE_BINDING_FAILED_WITH = "Async operation for service binding \"{0}\" between app \"{1}\" and user-provided service instance \"{2}\" failed with errors: {3}";
193191
public static final String ASYNC_OPERATION_FOR_SERVICE_BINDING_FAILED_INSTANCE_MISSING = "Async operation for service binding \"{0}\" between app \"{1}\" and service instance \"{2}\" failed: Instance not found. Cause: {3}";
194-
public static final String ASYNC_OPERATION_FOR_SERVICE_KEY_FAILED_WITH = "Async operation for service key of service instance \"{0}\" failed with \"{1}\"";
195-
public static final String ASYNC_OPERATION_FOR_OPTIONAL_SERVICE_KEY_FAILED_WITH = "Async operation for service key of optional service instance \"{0}\" failed with \"{1}\"";
192+
public static final String ASYNC_OPERATION_FOR_SERVICE_KEY_FAILED_WITH = "Async operation for service key of service instance \"{0}\" failed with errors: {1}";
193+
public static final String ASYNC_OPERATION_FOR_OPTIONAL_SERVICE_KEY_FAILED_WITH = "Async operation for service key of optional service instance \"{0}\" failed with errors: {1}";
196194
public static final String ASYNC_OPERATION_FOR_SERVICE_BINDING_FOR_OPTIONAL_SERVICE_FAILED_WITH = "Async operation for service binding \"{0}\" for optional service between app \"{1}\" and service instance \"{2}\" failed with \"{3}\"";
197195
public static final String ERROR_WHILE_CALCULATING_SERVICE_BINDINGS_TO_DELETE_0 = "Error while calculating service bindings to delete \"{0}\"";
198196
public static final String ERROR_WHILE_CREATING_SERVICE_KEY_0 = "Error while creating service key \"{0}\"";
@@ -290,8 +288,8 @@ public class Messages {
290288
public static final String UNBINDING_SERVICE_INSTANCE_FROM_APP_FINISHED = "Unbinding service instance \"{0}\" from application \"{1}\" finished";
291289
public static final String POLLING_SERVICE_OPERATIONS = "Polling service operations...";
292290
public static final String AUTO_ABORTING_PROCESS_0 = "Auto-aborting process \"{0}\"...";
293-
public static final String SOME_INSTANCES_ARE_DOWN = "Some instances are down. Check the logs of your application for more information.";
294-
public static final String SOME_INSTANCES_HAVE_CRASHED = "Some instances have crashed. Check the logs of your application for more information.";
291+
public static final String SOME_INSTANCES_ARE_DOWN = "Some instances are down. Check the application logs of your application for details.";
292+
public static final String SOME_INSTANCES_HAVE_CRASHED = "Some instances have crashed. Check the application logs of your application for details.";
295293
public static final String CLEAN_UP_JOB_STARTED_BY_APPLICATION_INSTANCE_0_AT_1 = "Clean-up job started by application instance {0} at: {1}";
296294
public static final String CLEAN_UP_JOB_WHICH_STARTED_AT_0_HAS_FINISHED_AT_1 = "Clean-up job, which started at: {0}, has finished at: {1}";
297295
public static final String WILL_CLEAN_UP_DATA_STORED_BEFORE_0 = "Will clean-up data stored before: {0}";
@@ -337,7 +335,7 @@ public class Messages {
337335
public static final String DELETED_FILE_ENTRIES_0 = "Deleted file entries: {0}";
338336
public static final String APPLICATION_WITH_NAME_0_SAVED_TO_1 = "Application with name \"{0}\" saved to \"{1}\"";
339337
public static final String CLOSING_STREAM_FOR_PART_0 = "Closing stream for part: {0}";
340-
public static final String REACHED_THE_END_OF_THE_INPUTSTREAM = "Reached the end of the InputStream";
338+
public static final String REACHED_THE_END_OF_THE_INPUT_STREAM = "Reached the end of the input stream";
341339
public static final String CLOSING_LAST_STREAM_FOR_PART_0 = "Closing the last stream, part: {0}";
342340
public static final String SCALING_UP_OLD_APPLICATION = "Scaling up old application: \"{0}\" to {1} instances";
343341
public static final String FILE_WITH_ID_0_WAS_DELETED = "File with id \"{0}\" was deleted";

‎multiapps-controller-process/src/main/java/org/cloudfoundry/multiapps/controller/process/steps/SyncFlowableStep.java‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
package org.cloudfoundry.multiapps.controller.process.steps;
22

3-
import java.util.function.BiFunction;
4-
import java.util.function.Consumer;
5-
63
import io.netty.handler.timeout.TimeoutException;
74
import jakarta.inject.Inject;
85
import jakarta.inject.Named;
96
import org.apache.commons.lang3.StringUtils;
107
import org.cloudfoundry.multiapps.common.ContentException;
118
import org.cloudfoundry.multiapps.common.SLException;
9+
import org.cloudfoundry.multiapps.common.StepPhaseRetryException;
1210
import org.cloudfoundry.multiapps.controller.client.facade.CloudControllerException;
1311
import org.cloudfoundry.multiapps.controller.client.facade.CloudOperationException;
1412
import org.cloudfoundry.multiapps.controller.client.facade.CloudServiceBrokerException;
@@ -35,6 +33,9 @@
3533
import org.slf4j.Logger;
3634
import org.slf4j.LoggerFactory;
3735

36+
import java.util.function.BiFunction;
37+
import java.util.function.Consumer;
38+
3839
public abstract class SyncFlowableStep implements JavaDelegate {
3940

4041
protected final Logger logger = LoggerFactory.getLogger(getClass());
@@ -80,7 +81,7 @@ private void executeInternal(DelegateExecution execution) {
8081
getStepHelper().preExecuteStep(context, stepPhase);
8182
stepPhase = executeStep(context);
8283
if (stepPhase == StepPhase.RETRY) {
83-
throw new SLException("A step of the process has failed. Retrying it may solve the issue.");
84+
throw new StepPhaseRetryException(Messages.STEP_OF_THE_PROCESS_HAS_FAILED);
8485
}
8586
} catch (Exception e) {
8687
stepPhase = StepPhase.RETRY;
@@ -114,6 +115,10 @@ protected ProcessContext createProcessContext(DelegateExecution execution) {
114115
}
115116

116117
private void handleException(ProcessContext context, Exception e) {
118+
if (e instanceof StepPhaseRetryException) {
119+
getStepLogger().info(Messages.DOWNLOAD_APP_LOGS_FOR_MORE_INFO);
120+
throw (StepPhaseRetryException) e;
121+
}
117122
try {
118123
StepPhase stepPhase = context.getVariable(Variables.STEP_PHASE);
119124
if (stepPhase == StepPhase.POLL) {

‎multiapps-controller-process/src/main/java/org/cloudfoundry/multiapps/controller/process/stream/LazyArchiveInputStream.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public synchronized int read() throws IOException {
5151
currentInputStream = openBufferedInputStream(archiveFileEntries.get(partIndex.incrementAndGet()));
5252
c = currentInputStream.read();
5353
} else if (c == -1) {
54-
LOGGER.info(MessageFormat.format(Messages.REACHED_THE_END_OF_THE_INPUTSTREAM, partIndex));
54+
LOGGER.info(MessageFormat.format(Messages.REACHED_THE_END_OF_THE_INPUT_STREAM, partIndex));
5555
}
5656
if (c >= 0) {
5757
totalBytesRead.incrementAndGet();
@@ -71,7 +71,7 @@ public synchronized int read(byte[] b, int off, int len) throws IOException {
7171
currentInputStream = openBufferedInputStream(archiveFileEntries.get(partIndex.incrementAndGet()));
7272
bytesRead = currentInputStream.read(b, off, len);
7373
} else if (bytesRead == -1) {
74-
LOGGER.info(MessageFormat.format(Messages.REACHED_THE_END_OF_THE_INPUTSTREAM, partIndex));
74+
LOGGER.info(MessageFormat.format(Messages.REACHED_THE_END_OF_THE_INPUT_STREAM, partIndex));
7575
}
7676
if (bytesRead > 0) {
7777
totalBytesRead.addAndGet(bytesRead);

0 commit comments

Comments
 (0)