-
-
Notifications
You must be signed in to change notification settings - Fork 354
#1457-Introduce-kinesis-autoconfiguration #1483
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
74f5300
dceac87
239f645
93a3d81
609fa6b
ad39096
e7e6000
3ad0c0e
e08b738
83994be
9b27588
a014560
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Copyright 2013-2025 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.awspring.cloud.autoconfigure.kinesis; | ||
|
|
||
| import io.awspring.cloud.autoconfigure.AwsClientCustomizer; | ||
| import software.amazon.awssdk.services.kinesis.KinesisAsyncClientBuilder; | ||
|
|
||
| /** | ||
| * Callback interface that can be used to customize a {@link KinesisAsyncClientBuilder}. | ||
| * | ||
| * @author Matej Nedic | ||
| * @since 4.0.0 | ||
| */ | ||
| @FunctionalInterface | ||
| public interface KinesisAsyncClientCustomizer extends AwsClientCustomizer<KinesisAsyncClientBuilder> { | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * Copyright 2013-2025 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.awspring.cloud.autoconfigure.kinesis; | ||
|
|
||
| import io.awspring.cloud.autoconfigure.AwsAsyncClientCustomizer; | ||
| import io.awspring.cloud.autoconfigure.core.AwsClientBuilderConfigurer; | ||
| import io.awspring.cloud.autoconfigure.core.AwsConnectionDetails; | ||
| import io.awspring.cloud.autoconfigure.core.CredentialsProviderAutoConfiguration; | ||
| import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration; | ||
| import org.springframework.beans.factory.ObjectProvider; | ||
| import org.springframework.boot.autoconfigure.AutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.AutoConfigureAfter; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; | ||
| import org.springframework.boot.context.properties.EnableConfigurationProperties; | ||
| import org.springframework.context.annotation.Bean; | ||
| import software.amazon.awssdk.services.kinesis.KinesisAsyncClient; | ||
|
|
||
| @AutoConfiguration | ||
| @ConditionalOnClass({ KinesisAsyncClient.class }) | ||
| @EnableConfigurationProperties({ KinesisProperties.class }) | ||
| @AutoConfigureAfter({ CredentialsProviderAutoConfiguration.class, RegionProviderAutoConfiguration.class }) | ||
| @ConditionalOnProperty(value = "spring.cloud.aws.kinesis.enabled", havingValue = "true", matchIfMissing = true) | ||
| public class KinesisAutoConfiguration { | ||
|
|
||
| @ConditionalOnMissingBean | ||
| @Bean | ||
| public KinesisAsyncClient kinesisAsyncClient(KinesisProperties properties, | ||
| AwsClientBuilderConfigurer awsClientBuilderConfigurer, | ||
| ObjectProvider<AwsConnectionDetails> connectionDetails, | ||
| ObjectProvider<KinesisAsyncClientCustomizer> kinesisAsyncClientCustomizer, | ||
| ObjectProvider<AwsAsyncClientCustomizer> awsSyncClientCustomizers) { | ||
| return awsClientBuilderConfigurer | ||
| .configureAsyncClient(KinesisAsyncClient.builder(), properties, connectionDetails.getIfAvailable(), | ||
| kinesisAsyncClientCustomizer.orderedStream(), awsSyncClientCustomizers.orderedStream()) | ||
| .build(); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /* | ||
| * Copyright 2013-2025 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.awspring.cloud.autoconfigure.kinesis; | ||
|
|
||
| import io.awspring.cloud.autoconfigure.core.CredentialsProviderAutoConfiguration; | ||
| import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration; | ||
| import org.springframework.beans.factory.ObjectProvider; | ||
| import org.springframework.boot.autoconfigure.AutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.AutoConfigureAfter; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; | ||
| import org.springframework.boot.context.properties.EnableConfigurationProperties; | ||
| import org.springframework.context.annotation.Bean; | ||
| import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient; | ||
| import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient; | ||
| import software.amazon.awssdk.services.kinesis.KinesisAsyncClient; | ||
| import software.amazon.kinesis.coordinator.Scheduler; | ||
| import software.amazon.kinesis.processor.ShardRecordProcessorFactory; | ||
|
|
||
| @AutoConfiguration | ||
| @ConditionalOnClass({ KinesisAsyncClient.class, Scheduler.class }) | ||
| @EnableConfigurationProperties({ KinesisClientLibraryProperties.class }) | ||
| @AutoConfigureAfter({ CredentialsProviderAutoConfiguration.class, RegionProviderAutoConfiguration.class, | ||
| KinesisAutoConfiguration.class }) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cannot we use
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will move away from ObjectProvider since both DynamoDbAsyncClient and CloudWatchAsync client are not nullabe for Scheduler. Meaning will have to play little bit with async autoconfiguration in general since most of our clients are sync |
||
| @ConditionalOnProperty(value = "spring.cloud.aws.kinesis.client.library.enabled", havingValue = "true", matchIfMissing = true) | ||
| public class KinesisClientLibraryAutoConfiguration { | ||
|
|
||
| @ConditionalOnMissingBean | ||
| @Bean | ||
| public Scheduler scheduler(ObjectProvider<DynamoDbAsyncClient> dynamoDbClient, | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is an active components which requires some lifecycle control. This about this like the listener container behind
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I had a same idea for 4.1 to introduce KclListener and work on it! :) Edit: Actually thinking about it I will take little bit longer do dig into SqsContainer and KafkaContainer and will do it as part od 4.0.0
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I will take some time reading through Spring Messaging, Spring Kafka and SQS integration. I need more reading on this, but i understand the point behind SchedularFactory and containers. Tnx on constructive feedback Artem, I appreciate it much. |
||
| ObjectProvider<CloudWatchAsyncClient> cloudWatchClient, KinesisAsyncClient kinesisAsyncClient, | ||
| KinesisClientLibraryProperties properties, ShardRecordProcessorFactory processorFactory) { | ||
| return null; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Copyright 2013-2025 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.awspring.cloud.autoconfigure.kinesis; | ||
|
|
||
| import static io.awspring.cloud.autoconfigure.kinesis.KinesisClientLibraryProperties.PREFIX; | ||
|
|
||
| import org.springframework.boot.context.properties.ConfigurationProperties; | ||
|
|
||
| @ConfigurationProperties(prefix = PREFIX) | ||
| public class KinesisClientLibraryProperties { | ||
|
|
||
| public static final String PREFIX = "spring.cloud.aws.kinesis.client.library"; | ||
|
|
||
| private String streamName; | ||
| private String applicationName; | ||
|
|
||
| public String getStreamName() { | ||
| return streamName; | ||
| } | ||
|
|
||
| public void setStreamName(String streamName) { | ||
| this.streamName = streamName; | ||
| } | ||
|
|
||
| public String getApplicationName() { | ||
| return applicationName; | ||
| } | ||
|
|
||
| public void setApplicationName(String applicationName) { | ||
| this.applicationName = applicationName; | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| /* | ||
| * Copyright 2013-2025 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.awspring.cloud.autoconfigure.kinesis; | ||
|
|
||
| import io.awspring.cloud.autoconfigure.core.AwsClientBuilderConfigurer; | ||
| import io.awspring.cloud.autoconfigure.core.AwsConnectionDetails; | ||
| import io.awspring.cloud.autoconfigure.core.CredentialsProviderAutoConfiguration; | ||
| import io.awspring.cloud.autoconfigure.core.RegionProviderAutoConfiguration; | ||
| import org.springframework.beans.factory.ObjectProvider; | ||
| import org.springframework.boot.autoconfigure.AutoConfiguration; | ||
| import org.springframework.boot.autoconfigure.AutoConfigureAfter; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; | ||
| import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; | ||
| import org.springframework.boot.context.properties.EnableConfigurationProperties; | ||
| import org.springframework.boot.context.properties.PropertyMapper; | ||
| import org.springframework.context.annotation.Bean; | ||
| import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; | ||
| import software.amazon.awssdk.regions.providers.AwsRegionProvider; | ||
| import software.amazon.kinesis.producer.KinesisProducer; | ||
| import software.amazon.kinesis.producer.KinesisProducerConfiguration; | ||
|
|
||
| @AutoConfiguration | ||
| @ConditionalOnClass({ KinesisProducer.class, KinesisProducerConfiguration.class }) | ||
| @EnableConfigurationProperties({ KinesisProducerProperties.class }) | ||
| @AutoConfigureAfter({ CredentialsProviderAutoConfiguration.class, RegionProviderAutoConfiguration.class }) | ||
| @ConditionalOnProperty(value = "spring.cloud.aws.kinesis.producer.enabled", havingValue = "true", matchIfMissing = true) | ||
| public class KinesisProducerAutoConfiguration { | ||
|
|
||
| @ConditionalOnMissingBean | ||
| @Bean | ||
| public KinesisProducerConfiguration kinesisProducerConfiguration(KinesisProducerProperties prop, | ||
| AwsCredentialsProvider credentialsProvider, AwsRegionProvider awsRegionProvider, | ||
| ObjectProvider<AwsConnectionDetails> connectionDetails) { | ||
| PropertyMapper propertyMapper = PropertyMapper.get(); | ||
| KinesisProducerConfiguration config = new KinesisProducerConfiguration(); | ||
| propertyMapper.from(prop::getAggregationEnabled).whenNonNull().to(config::setAggregationEnabled); | ||
| propertyMapper.from(prop::getAggregationMaxCount).whenNonNull().to(config::setAggregationMaxCount); | ||
| propertyMapper.from(prop::getAggregationMaxSize).whenNonNull().to(config::setAggregationMaxSize); | ||
| propertyMapper.from(prop::getCloudwatchEndpoint).whenHasText().to(config::setCloudwatchEndpoint); | ||
| propertyMapper.from(prop::getCloudwatchPort).whenNonNull().to(config::setCloudwatchPort); | ||
| propertyMapper.from(prop::getCollectionMaxCount).whenNonNull().to(config::setCollectionMaxCount); | ||
| propertyMapper.from(prop::getCollectionMaxSize).whenNonNull().to(config::setCollectionMaxSize); | ||
| propertyMapper.from(prop::getConnectTimeout).whenNonNull().to(config::setConnectTimeout); | ||
| propertyMapper.from(prop::getCredentialsRefreshDelay).whenNonNull().to(config::setCredentialsRefreshDelay); | ||
| propertyMapper.from(prop::getEnableCoreDumps).whenNonNull().to(config::setEnableCoreDumps); | ||
| propertyMapper.from(prop::getFailIfThrottled).whenNonNull().to(config::setFailIfThrottled); | ||
| propertyMapper.from(prop::getLogLevel).whenHasText().to(config::setLogLevel); | ||
| propertyMapper.from(prop::getMaxConnections).whenNonNull().to(config::setMaxConnections); | ||
| propertyMapper.from(prop::getMetricsGranularity).whenHasText().to(config::setMetricsGranularity); | ||
| propertyMapper.from(prop::getMetricsLevel).whenHasText().to(config::setMetricsLevel); | ||
| propertyMapper.from(prop::getMetricsNamespace).whenHasText().to(config::setMetricsNamespace); | ||
| propertyMapper.from(prop::getMetricsUploadDelay).whenNonNull().to(config::setMetricsUploadDelay); | ||
| propertyMapper.from(prop::getMinConnections).whenNonNull().to(config::setMinConnections); | ||
| propertyMapper.from(prop::getNativeExecutable).whenNonNull().to(config::setNativeExecutable); | ||
| propertyMapper.from(prop::getRateLimit).whenNonNull().to(config::setRateLimit); | ||
| propertyMapper.from(prop::getRecordMaxBufferedTime).whenNonNull().to(config::setRecordMaxBufferedTime); | ||
| propertyMapper.from(prop::getRecordTtl).whenNonNull().to(config::setRecordTtl); | ||
| propertyMapper.from(prop::getRequestTimeout).whenNonNull().to(config::setRequestTimeout); | ||
| propertyMapper.from(prop::getTempDirectory).whenNonNull().to(config::setTempDirectory); | ||
| propertyMapper.from(prop::getVerifyCertificate).whenNonNull().to(config::setVerifyCertificate); | ||
| propertyMapper.from(prop.getProxyHost()).whenNonNull().to(config::setProxyHost); | ||
| propertyMapper.from(prop.getProxyPort()).whenNonNull().to(config::setProxyPort); | ||
| propertyMapper.from(prop.getProxyUserName()).whenHasText().to(config::setProxyUserName); | ||
| propertyMapper.from(prop.getProxyPassword()).whenHasText().to(config::setProxyPassword); | ||
| propertyMapper.from(prop.getStsEndpoint()).whenHasText().to(config::setStsEndpoint); | ||
| propertyMapper.from(prop.getStsPort()).whenNonNull().to(config::setStsPort); | ||
| propertyMapper.from(prop.getThreadingModel()).whenNonNull().to(config::setThreadingModel); | ||
| propertyMapper.from(prop.getThreadPoolSize()).whenNonNull().to(config::setThreadPoolSize); | ||
| propertyMapper.from(prop.getUserRecordTimeoutInMillis()).whenNonNull().to(config::setUserRecordTimeoutInMillis); | ||
|
|
||
| config.setCredentialsProvider(credentialsProvider); | ||
| config.setRegion(AwsClientBuilderConfigurer | ||
| .resolveRegion(prop, connectionDetails.getIfAvailable(), awsRegionProvider).toString()); | ||
| connectionDetails.ifAvailable(cd -> { | ||
| config.setKinesisPort(cd.getEndpoint().getPort()); | ||
| config.setKinesisEndpoint(cd.getEndpoint().getHost()); | ||
| }); | ||
| return config; | ||
| } | ||
|
|
||
| @ConditionalOnMissingBean | ||
| @Bean | ||
| public KinesisProducer kinesisProducer(KinesisProducerConfiguration kinesisProducerConfiguration) { | ||
| return new KinesisProducer(kinesisProducerConfiguration); | ||
| } | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.