fix(amazonq): Update exception handling for feature dev to improve observability #4953
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
...rc/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/CodeGenerationState.kt
Show resolved
Hide resolved
...unity/src/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/FeatureDevExceptions.kt
Outdated
Show resolved
Hide resolved
...rc/software/aws/toolkits/jetbrains/services/amazonqFeatureDev/session/CodeGenerationState.kt
Show resolved
Hide resolved
ctidd
force-pushed
the
ctidd/feature-dev-exceptions
branch
4 times, most recently
from
512f66e to
05b61d7
Compare
rli
approved these changes
Oct 9, 2024
Comment on lines
23
to
24
| desc -> String.format("%s: %s", this.operation, desc) | ||
| else -> String.format("%s", this.operation) |
There was a problem hiding this comment.
Suggested change
| desc -> String.format("%s: %s", this.operation, desc) | |
| else -> String.format("%s", this.operation) | |
| desc -> "$description: $desc" | |
| else -> operation |
There was a problem hiding this comment.
Incorporated as:
desc -> "$operation | Description: $desc"
else -> operation
| * - Each failure is annotated based on className, operation, and a short desc. Use the `reason()` and `reasonDesc()` members for instrumentation. | ||
| * - To throw an exception without modeling, throw FeatureDevException directly. | ||
| */ | ||
| open class FeatureDevException(override val message: String?, open val operation: String, open val desc: String?, override val cause: Throwable? = null) |
There was a problem hiding this comment.
Suggested change
| open class FeatureDevException(override val message: String?, open val operation: String, open val desc: String?, override val cause: Throwable? = null) | |
| open class FeatureDevException(override val message: String?, val operation: String, val desc: String?, override val cause: Throwable? = null) |
| ) | ||
| } | ||
| else -> { | ||
| var msg = createUserFacingErrorMessage("$FEATURE_NAME request failed: ${err.message ?: err.cause?.message}") |
neilk-aws
approved these changes
Oct 9, 2024
ctidd
force-pushed
the
ctidd/feature-dev-exceptions
branch
from
05b61d7 to
8bdc09d
Compare
ctidd
force-pushed
the
ctidd/feature-dev-exceptions
branch
2 times, most recently
from
372c006 to
ac495d8
Compare
ctidd
force-pushed
the
ctidd/feature-dev-exceptions
branch
from
ac495d8 to
1ec073f
Compare
chengoramazon
approved these changes
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Description
Problem: Feature dev instrumentation 1) records all failures as
FeatureDevException, losing information about the specific exception type, and 2) lacks annotation ofreasonDescand the operation related to the error. (By operation, although we do captureamazonq_codeGenerationInvoke, we're missing the subprocess name such asStartCodeGeneration.) As a result, we do not have insight into feature dev failures in JetBrains.Solution: 1) Update exception modeling pattern for feature dev functionality to derive subclasses of
FeatureDevException, providing a meaningful class name when inspected as errorreason. 2) OnFeatureDevException, accept anoperationanddescto provide further annotation (merged when logged asreasonDesc).This change will have conflicts with #4938 and #4949. I'll rebase on top of those and reconcile any drift in a subsequent revision.
Checklist
License
I confirm that my contribution is made under the terms of the Apache 2.0 license.