Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WFCORE-6476] Reduce failed step logging to DEBUG for read-only inter… #5647

Merged
merged 1 commit into from
Sep 13, 2023
Merged

[WFCORE-6476] Reduce failed step logging to DEBUG for read-only inter… #5647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 32 additions & 19 deletions controller/src/main/java/org/jboss/as/controller/AbstractOperationContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
import org.jboss.as.controller.registry.NotificationEntry;
import org.jboss.as.controller.registry.OperationEntry;
import org.jboss.as.controller.registry.Resource;
import org.jboss.as.core.security.AccessMechanism;
import org.jboss.as.protocol.StreamUtils;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.Property;
Expand Down Expand Up @@ -1063,9 +1064,8 @@ private void executeStep(final Step step) {
try {
step.handler.execute(this, step.operation);
// AS7-6046
if (isErrorLoggingNecessary() && step.hasFailed()) {
MGMT_OP_LOGGER.operationFailed(step.operation.get(OP), step.operation.get(OP_ADDR),
step.response.get(FAILURE_DESCRIPTION));
if (step.hasFailed()) {
logStepFailure(step, false);
}
if (step.serviceVerificationHelper != null) {
addStep(step.serviceVerificationHelper, Stage.VERIFY);
Expand All @@ -1077,21 +1077,15 @@ private void executeStep(final Step step) {
}

} catch (Throwable t) {
// If t doesn't implement OperationClientException marker interface, throw it on to outer catch block
// If it doesn't implement OperationClientException marker interface, throw it on to outer catch block
if (!(t instanceof OperationClientException)) {
throw t;
}
// Handler threw OCE; that's equivalent to a request that we set the failure description
final ModelNode failDesc = OperationClientException.class.cast(t).getFailureDescription();
step.response.get(FAILURE_DESCRIPTION).set(failDesc);
if (isErrorLoggingNecessary()) {
MGMT_OP_LOGGER.operationFailed(step.operation.get(OP), step.operation.get(OP_ADDR),
step.response.get(FAILURE_DESCRIPTION));
} else {
// A client-side mistake post-boot that only affects model, not runtime, is logged at DEBUG
MGMT_OP_LOGGER.operationFailedOnClientError(step.operation.get(OP), step.operation.get(OP_ADDR),
step.response.get(FAILURE_DESCRIPTION));
}

logStepFailure(step, true);
}
} catch (Throwable t) {
// Handling for throwables that don't implement OperationClientException marker interface
Expand Down Expand Up @@ -1134,15 +1128,34 @@ void addModifiedResourcesForModelValidation(Set<PathAddress> modifiedResources)
}
}

/** Whether ERROR level logging is appropriate for any operation failures*/
private boolean isErrorLoggingNecessary() {
// Log for any boot failure or for any failure that may affect this processes' runtime services.
private void logStepFailure(Step step, boolean fromOCE) {

// Use ERROR for any boot failure or for any failure that may affect this processes' runtime services.
// Stage.RUNTIME failures in read-only steps haven't affected runtime services so don't require ERROR
// logging if they came from an internal caller that presumably will handle a failure response without
// the aid of the log.
// Post-boot MODEL failures aren't ERROR logged as they have no impact outside the scope of
// the soon-to-be-abandoned OperationContext.
// TODO consider logging Stage.DOMAIN problems if it's clear the message will be comprehensible.
// Currently Stage.DOMAIN failure handling involves message manipulation before sending the
// failure data to the client; logging stuff before that is done is liable to just produce a log mess.
return isBooting() || currentStage == Stage.RUNTIME || currentStage == Stage.VERIFY;
if (isBooting() || currentStage == Stage.VERIFY
|| (currentStage == Stage.RUNTIME && (step.requiresDoneStage || isExternalClient()))) {
MGMT_OP_LOGGER.operationFailed(step.operation.get(OP), step.operation.get(OP_ADDR),
step.response.get(FAILURE_DESCRIPTION));
} else if (fromOCE) {
MGMT_OP_LOGGER.operationFailedOnClientError(step.operation.get(OP), step.operation.get(OP_ADDR),
step.response.get(FAILURE_DESCRIPTION));
} else if (currentStage != Stage.DOMAIN) {
// Post-boot Stage.RUNTIME issues with internal read-only calls
// TODO consider ERROR or DEBUG logging Stage.DOMAIN problems if it's clear the message will be comprehensible.
// Currently Stage.DOMAIN failure handling involves message manipulation before sending the
// failure data to the client; logging stuff before that is done is liable to just produce a log mess.
MGMT_OP_LOGGER.operationFailed(step.operation.get(OP), step.operation.get(OP_ADDR),
step.response.get(FAILURE_DESCRIPTION), "");
}
}

private boolean isExternalClient() {
AccessMechanism am = operationHeaders.getAccessMechanism();
return am != null && am != AccessMechanism.IN_VM_USER;
}

private void handleContainerStabilityFailure(ModelNode response, Exception cause) {
Expand Down
13 changes: 13 additions & 0 deletions controller/src/main/java/org/jboss/as/controller/logging/ControllerLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,19 @@ public interface ControllerLogger extends BasicLogger {
@Message(id = Message.INHERIT, value = "Operation (%s) failed - address: (%s) - failure description: %s")
void operationFailed(ModelNode op, ModelNode opAddress, ModelNode failureDescription);

/**
* Logs a debug message indicating operation failed.
*
* @param op the operation that failed.
* @param opAddress the address the operation failed on.
* @param failureDescription the failure description.
* @param emptyString meaningless param just so we can have a different method signature
* from the variant used by legacy controllers
*/
@LogMessage(level = DEBUG)
@Message(id = Message.INHERIT, value = "Operation (%s) failed - address: (%s) - failure description: %s%s")
void operationFailed(ModelNode op, ModelNode opAddress, ModelNode failureDescription, String emptyString);

// WFCORE-792 -- no longer used
// /**
// * Logs an error message indicating operation failed.
Expand Down