Skip to content

Commit

Permalink
[KYUUBI #6722] Fix AppState when Engine connection is terminated
Browse files Browse the repository at this point in the history
# 🔍 Description
## Issue References 🔗

This issue was noticed a few times when the batch `state` was `set` to `ERROR`, but the `appState` kept the non-terminal state forever (e.g. `RUNNING`), even if the application was finished (in this case Yarn Application).

```json
{
"id": "********",
"user": "****",
"batchType": "SPARK",
"name": "*********",
"appStartTime": 0,
"appId": "********",
"appUrl": "********",
"appState": "RUNNING",
"appDiagnostic": "",
"kyuubiInstance": "*********",
"state": "ERROR",
"createTime": 1725343207318,
"endTime": 1725343300986,
"batchInfo": {}
}
```

It seems that this happens when there is some intermittent failure during the monitoring step and the batch ends with ERROR, leaving the application metadata without an update. This can lead to some misinterpretation that the application is still running. We need to set this to `UNKNOWN` state to avoid errors.

## Describe Your Solution 🔧

This is a simple fix that only checks if the batch state is `ERROR` and the appState is not in a terminal state and changes the `appState` to `UNKNOWN`, in these cases (during the batch metadata update).

## Types of changes 🔖

- [x] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

#### Behavior Without This Pull Request ⚰️

If there is some error between the Kyuubi and the Application request (e.g. YARN client), the batch is finished with `ERROR` state and the application keeps the last know state (e.g. RUNNING).

#### Behavior With This Pull Request 🎉

If there is some error between the Kyuubi and the Application request (e.g. YARN client), the batch is finished with `ERROR `state and the application has a non-terminal state, it is forced to `UNKNOWN` state.

#### Related Unit Tests

I've tried to implement a unit test to replicate this behavior but I didn't make it. We need to force an exception in the Engine Request (e.g. `YarnClient.getApplication`) but we need to wait for the application to be in the RUNNING state before raising this exception, or maybe block the connection between kyuubi and the engine.

---

# Checklist 📝

- [ ] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6722 from joaopamaral/fix/app-state-on-batch-error.

Closes #6722

8409eac [Wang, Fei] fix
da8c356 [Joao Amaral] format fix
73b77b3 [Joao Amaral] use isTerminated
64f96a2 [Joao Amaral] Remove test
1eb80ef [Joao Amaral] Remove test
13498fa [Joao Amaral] Remove test
60ce55e [Joao Amaral] add todo
3a3ba16 [Joao Amaral] Fix
215ac66 [Joao Amaral] Fix AppState when Engine connection is terminated

Lead-authored-by: Joao Amaral <[email protected]>
Co-authored-by: Wang, Fei <[email protected]>
Signed-off-by: Wang, Fei <[email protected]>
  • Loading branch information
joaopamaral and turboFei committed Nov 23, 2024
1 parent b0036fd commit 27c734e
Showing 1 changed file with 11 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -154,13 +154,23 @@ class BatchJobSubmission(
engineId = appInfo.id,
engineName = appInfo.name,
engineUrl = appInfo.url.orNull,
engineState = appInfo.state.toString,
engineState = getAppState(state, appInfo.state).toString,
engineError = appInfo.error,
endTime = endTime)
session.sessionManager.updateMetadata(metadataToUpdate)
}
}

private def getAppState(
opState: OperationState,
appState: ApplicationState.ApplicationState): ApplicationState.ApplicationState = {
if (opState == OperationState.ERROR && !ApplicationState.isTerminated(appState)) {
ApplicationState.UNKNOWN
} else {
appState
}
}

override def getOperationLog: Option[OperationLog] = Option(_operationLog)

// we can not set to other state if it is canceled
Expand Down

0 comments on commit 27c734e

Please sign in to comment.