Skip to content

NIFI-7371 - Improve error handling of S3 processors#5606

Closed
greyp9 wants to merge 2 commits intoapache:mainfrom
greyp9:NIFI-7371-A
Closed

NIFI-7371 - Improve error handling of S3 processors#5606
greyp9 wants to merge 2 commits intoapache:mainfrom
greyp9:NIFI-7371-A

Conversation

@greyp9
Copy link
Contributor

@greyp9 greyp9 commented Dec 16, 2021

Thank you for submitting a contribution to Apache NiFi.

Please provide a short description of the PR here:

Description of PR

Adds exception attributes to flow file on failure of S3 processor operations. New attributes are derived from information contained in the S3 exception class.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • Have you verified that the full build is successful on JDK 8?
  • Have you verified that the full build is successful on JDK 11?
  • [-] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • [-] If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • [-] If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • [-] If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

@greyp9
Copy link
Contributor Author

greyp9 commented Dec 16, 2021

Pulled these attributes out of a NiFi instance testing some failure conditions:

[INCORRECT BUCKET NAME]
s3.additionalDetails = {BucketName=<bad bucket name>, Error=<base64 string>}
s3.errorCode = NoSuchBucket
s3.errorMessage = The specified bucket does not exist
s3.exception = com.amazonaws.services.s3.model.AmazonS3Exception
s3.statusCode = 404

[BAD FILENAME] (appended garbage to end of FetchS3Object field "Object Key")
s3.additionalDetails = {Error=<base64 string>, Key=<bad path>}
s3.errorCode = NoSuchKey
s3.errorMessage = The specified key does not exist.
s3.exception = com.amazonaws.services.s3.model.AmazonS3Exception
s3.statusCode = 404

[NETWORK CONNECTIVITY FAILURE] (disabled wifi)
s3.exception = com.amazonaws.SdkClientException

[BAD CREDENTIALS] (incorrect AWS Secret Access Key)
s3.additionalDetails = {CanonicalRequestBytes=<hex string>}
s3.errorCode = SignatureDoesNotMatch
s3.errorMessage = The request signature we calculated does not match the signature you provided. Check your key and signing method.
s3.exception = com.amazonaws.services.s3.model.AmazonS3Exception
s3.statusCode = 403

[BAD CREDENTIALS] (incorrect AWS Access Key ID)
s3.additionalDetails = {AWSAccessKeyId=<bad key id>, Error=<base64 string>}
s3.errorCode = InvalidAccessKeyId
s3.errorMessage = The AWS Access Key Id you provided does not exist in our records.
s3.exception = com.amazonaws.services.s3.model.AmazonS3Exception
s3.statusCode = 403

Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvement @greyp9, the additional attributes should support a variety of use cases in handling failure scenarios. I noted one minor optimization, otherwise it looks good.

Comment on lines +327 to +329
flowFile = putAttribute(session, flowFile, "s3.statusCode", ((AmazonServiceException) e).getStatusCode());
flowFile = putAttribute(session, flowFile, "s3.errorCode", ((AmazonServiceException) e).getErrorCode());
flowFile = putAttribute(session, flowFile, "s3.errorMessage", ((AmazonServiceException) e).getErrorMessage());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor adjustment, it looks like the exception could be cast once as an AmazonServiceException and then the various methods could be called.

Suggested change
flowFile = putAttribute(session, flowFile, "s3.statusCode", ((AmazonServiceException) e).getStatusCode());
flowFile = putAttribute(session, flowFile, "s3.errorCode", ((AmazonServiceException) e).getErrorCode());
flowFile = putAttribute(session, flowFile, "s3.errorMessage", ((AmazonServiceException) e).getErrorMessage());
final AmazonServiceException ase = (AmazonServiceException) e;
flowFile = putAttribute(session, flowFile, "s3.statusCode", ase.getStatusCode());
flowFile = putAttribute(session, flowFile, "s3.errorCode", ase.getErrorCode());
flowFile = putAttribute(session, flowFile, "s3.errorMessage", ase.getErrorMessage());

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure; update pushed.

Copy link
Contributor

@exceptionfactory exceptionfactory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates @greyp9, looks good! +1 Merging.

krisztina-zsihovszki pushed a commit to krisztina-zsihovszki/nifi that referenced this pull request Jun 28, 2022
This closes apache#5606

Signed-off-by: David Handermann <exceptionfactory@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants