Kds stream api changes #5239
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,83 @@ | ||||||
| /* | ||||||
| * Copyright OpenSearch Contributors | ||||||
| * SPDX-License-Identifier: Apache-2.0 | ||||||
| * | ||||||
| * The OpenSearch Contributors require contributions made to | ||||||
| * this file be licensed under the Apache-2.0 license or a | ||||||
| * compatible open source license. | ||||||
| * | ||||||
| */ | ||||||
|
|
||||||
| package org.opensearch.dataprepper.plugins.kinesis.source; | ||||||
|
|
||||||
| import com.amazonaws.arn.Arn; | ||||||
| import com.linecorp.armeria.client.retry.Backoff; | ||||||
| import lombok.extern.slf4j.Slf4j; | ||||||
| import org.opensearch.dataprepper.plugins.kinesis.source.exceptions.KinesisRetriesExhaustedException; | ||||||
| import software.amazon.awssdk.services.kinesis.KinesisAsyncClient; | ||||||
| import software.amazon.awssdk.services.kinesis.model.DescribeStreamSummaryRequest; | ||||||
| import software.amazon.awssdk.services.kinesis.model.DescribeStreamSummaryResponse; | ||||||
| import software.amazon.awssdk.services.kinesis.model.StreamDescriptionSummary; | ||||||
| import software.amazon.kinesis.common.StreamIdentifier; | ||||||
|
|
||||||
| import java.time.Duration; | ||||||
|
|
||||||
| @Slf4j | ||||||
| public class KinesisClientAPIHandler { | ||||||
| private static final String COLON = ":"; | ||||||
|
|
||||||
| private final Backoff backoff; | ||||||
| private final KinesisAsyncClient kinesisClient; | ||||||
| private int failedAttemptCount; | ||||||
| private int maxRetryCount; | ||||||
|
|
||||||
| public KinesisClientAPIHandler(final KinesisAsyncClient kinesisClient, final Backoff backoff, final int maxRetryCount) { | ||||||
| this.kinesisClient = kinesisClient; | ||||||
| this.backoff = backoff; | ||||||
| this.failedAttemptCount = 0; | ||||||
| if (maxRetryCount <= 0) { | ||||||
| throw new IllegalArgumentException("Maximum Retry count should be strictly greater than zero."); | ||||||
| } | ||||||
| this.maxRetryCount = maxRetryCount; | ||||||
| } | ||||||
|
|
||||||
| public StreamIdentifier getStreamIdentifier(final String streamName) { | ||||||
| failedAttemptCount = 0; | ||||||
| while (failedAttemptCount < maxRetryCount) { | ||||||
| try { | ||||||
| DescribeStreamSummaryRequest describeStreamSummaryRequest = DescribeStreamSummaryRequest.builder() | ||||||
|
There was a problem hiding this comment. You can move this outside of the |
||||||
| .streamName(streamName).build(); | ||||||
| DescribeStreamSummaryResponse response = kinesisClient.describeStreamSummary(describeStreamSummaryRequest).join(); | ||||||
|
There was a problem hiding this comment. Does this require different There was a problem hiding this comment. Thanks @dlvenable . Yes, we will need to different |
||||||
| String streamIdentifierString = getStreamIdentifierString(response.streamDescriptionSummary()); | ||||||
| return StreamIdentifier.multiStreamInstance(streamIdentifierString); | ||||||
| } catch (Exception ex) { | ||||||
|
There was a problem hiding this comment. Let's catch some known exceptions that the Kinesis client throws for server or client errors and log those without the stack trace. e.g. |
||||||
| log.error("Failed to get stream summary for stream {}, retrying", streamName, ex); | ||||||
| } | ||||||
| applyBackoff(); | ||||||
| ++failedAttemptCount; | ||||||
| } | ||||||
| throw new KinesisRetriesExhaustedException(String.format("Failed to get Kinesis stream summary for stream %s after %d retries", streamName, maxRetryCount)); | ||||||
| } | ||||||
|
|
||||||
| private void applyBackoff() { | ||||||
| final long delayMillis = backoff.nextDelayMillis(failedAttemptCount); | ||||||
| if (delayMillis < 0) { | ||||||
| Thread.currentThread().interrupt(); | ||||||
|
There was a problem hiding this comment. Why are you interrupting the current thread? |
||||||
| throw new KinesisRetriesExhaustedException("Kinesis DescribeStreamSummary request retries exhausted. Make sure that Kinesis configuration is valid, Kinesis stream exists, and IAM role has required permissions."); | ||||||
| } | ||||||
| final Duration delayDuration = Duration.ofMillis(delayMillis); | ||||||
| log.info("Pausing Kinesis DescribeStreamSummary request for {}.{} seconds due to an error in processing.", | ||||||
| delayDuration.getSeconds(), delayDuration.toMillisPart()); | ||||||
| try { | ||||||
| Thread.sleep(delayMillis); | ||||||
| } catch (final InterruptedException e){ | ||||||
| log.error("Thread is interrupted while polling SQS with retry.", e); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
| private String getStreamIdentifierString(StreamDescriptionSummary streamDescriptionSummary) { | ||||||
| String accountId = Arn.fromString(streamDescriptionSummary.streamARN()).getAccountId(); | ||||||
| long creationEpochSecond = streamDescriptionSummary.streamCreationTimestamp().getEpochSecond(); | ||||||
| return String.join(COLON, accountId, streamDescriptionSummary.streamName(), String.valueOf(creationEpochSecond)); | ||||||
| } | ||||||
| } | ||||||
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| * | ||
| */ | ||
|
|
||
| package org.opensearch.dataprepper.plugins.kinesis.source.exceptions; | ||
|
|
||
| public class KinesisRetriesExhaustedException extends RuntimeException { | ||
| public KinesisRetriesExhaustedException(final String errorMessage) { | ||
| super(errorMessage); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rename to
KinesisClientApiHandlerto promote consistency.