AWS: Add SQS MetricsReporter #7444
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 | ||
| * | ||
| * http://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 org.apache.iceberg.aws; | ||
|
|
||
| import java.time.Duration; | ||
| import java.util.Map; | ||
| import org.apache.iceberg.util.PropertyUtil; | ||
| import software.amazon.awssdk.awscore.client.builder.AwsAsyncClientBuilder; | ||
| import software.amazon.awssdk.http.nio.netty.NettyNioAsyncHttpClient; | ||
|
|
||
| class NettyNioAsyncHttpClientConfigurations { | ||
|
|
||
| private Long connectionMaxIdleTime; | ||
| private Long connectionAcquisitionTimeout; | ||
| private Long connectionTimeout; | ||
| private Long connectionTimeToLive; | ||
| private Integer maxConcurrency; | ||
| private Long readTimeout; | ||
| private Integer maxPendingConnectionAcquires; | ||
| private Long writeTimeout; | ||
|
|
||
| private NettyNioAsyncHttpClientConfigurations() {} | ||
|
|
||
| public <T extends AwsAsyncClientBuilder> void configureHttpClientBuilder(T awsClientBuilder) { | ||
| NettyNioAsyncHttpClient.Builder nettyNioAsyncHttpClientBuilder = | ||
| NettyNioAsyncHttpClient.builder(); | ||
| configureNettyNioAsyncHttpClientBuilder(nettyNioAsyncHttpClientBuilder); | ||
| awsClientBuilder.httpClientBuilder(nettyNioAsyncHttpClientBuilder); | ||
| } | ||
|
|
||
| private void initialize(Map<String, String> httpClientProperties) { | ||
| this.connectionMaxIdleTime = | ||
| PropertyUtil.propertyAsNullableLong( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_CONNECTION_MAX_IDLE_TIME_MS); | ||
| this.connectionAcquisitionTimeout = | ||
| PropertyUtil.propertyAsNullableLong( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_ACQUISITION_TIMEOUT_MS); | ||
| this.connectionTimeout = | ||
| PropertyUtil.propertyAsNullableLong( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_CONNECTION_TIMEOUT_MS); | ||
| this.connectionTimeToLive = | ||
| PropertyUtil.propertyAsNullableLong( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_CONNECTION_TIME_TO_LIVE_MS); | ||
| this.maxConcurrency = | ||
| PropertyUtil.propertyAsNullableInt( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_MAX_CONCURRENCY); | ||
| this.readTimeout = | ||
| PropertyUtil.propertyAsNullableLong( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_READ_TIMEOUT); | ||
| this.maxPendingConnectionAcquires = | ||
| PropertyUtil.propertyAsNullableInt( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_MAX_PENDING_CONNECTION_ACQUIRES); | ||
| this.writeTimeout = | ||
| PropertyUtil.propertyAsNullableLong( | ||
| httpClientProperties, HttpClientProperties.NETTYNIO_WRITE_TIMEOUT); | ||
| } | ||
|
|
||
| void configureNettyNioAsyncHttpClientBuilder( | ||
| NettyNioAsyncHttpClient.Builder nettyNioHttpClientBuilder) { | ||
| if (connectionMaxIdleTime != null) { | ||
| nettyNioHttpClientBuilder.connectionMaxIdleTime(Duration.ofMillis(connectionMaxIdleTime)); | ||
| } | ||
| if (connectionAcquisitionTimeout != null) { | ||
| nettyNioHttpClientBuilder.connectionAcquisitionTimeout( | ||
| Duration.ofMillis(connectionAcquisitionTimeout)); | ||
| } | ||
| if (connectionTimeout != null) { | ||
| nettyNioHttpClientBuilder.connectionTimeout(Duration.ofMillis(connectionTimeout)); | ||
| } | ||
| if (connectionTimeToLive != null) { | ||
| nettyNioHttpClientBuilder.connectionTimeToLive(Duration.ofMillis(connectionTimeToLive)); | ||
| } | ||
| if (maxConcurrency != null) { | ||
| nettyNioHttpClientBuilder.maxConcurrency(maxConcurrency); | ||
| } | ||
| if (readTimeout != null) { | ||
| nettyNioHttpClientBuilder.readTimeout(Duration.ofMillis(readTimeout)); | ||
| } | ||
| if (maxPendingConnectionAcquires != null) { | ||
| nettyNioHttpClientBuilder.maxPendingConnectionAcquires(maxPendingConnectionAcquires); | ||
| } | ||
| if (writeTimeout != null) { | ||
| nettyNioHttpClientBuilder.writeTimeout(Duration.ofMillis(writeTimeout)); | ||
| } | ||
| } | ||
|
|
||
| public static NettyNioAsyncHttpClientConfigurations create( | ||
| Map<String, String> httpClientProperties) { | ||
| NettyNioAsyncHttpClientConfigurations configurations = | ||
| new NettyNioAsyncHttpClientConfigurations(); | ||
| configurations.initialize(httpClientProperties); | ||
| return configurations; | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 | ||
| * | ||
| * http://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 org.apache.iceberg.aws; | ||
|
|
||
| import java.util.Map; | ||
| import org.apache.iceberg.aws.metrics.DefaultSqsMetricsReporterAwsClientFactory; | ||
| import org.apache.iceberg.aws.metrics.SqsMetricsReporterAwsClientFactory; | ||
| import org.apache.iceberg.aws.metrics.SqsMetricsReporterProperties; | ||
| import org.apache.iceberg.common.DynConstructors; | ||
| import org.apache.iceberg.util.PropertyUtil; | ||
|
|
||
| public class SqsMetricsReporterAwsClientFactories { | ||
|
|
||
| private SqsMetricsReporterAwsClientFactories() {} | ||
|
|
||
| /** | ||
| * Attempts to load an AWS client factory class for SQS Metrics Reporter defined in the catalog | ||
| * property {@link SqsMetricsReporterProperties#METRICS_REPORTER_SQS_CLIENT_FACTORY_IMPL}. If the | ||
| * property wasn't set, fallback to {@link AwsClientFactories#from(Map) to intialize an AWS client | ||
| * factory class} | ||
| * | ||
| * @param properties catalog properties | ||
| * @return an instance of a factory class | ||
| */ | ||
| @SuppressWarnings("unchecked") | ||
| public static <T> T initialize(Map<String, String> properties) { | ||
| String factoryImpl = | ||
| PropertyUtil.propertyAsString( | ||
| properties, | ||
| SqsMetricsReporterProperties.METRICS_REPORTER_SQS_CLIENT_FACTORY_IMPL, | ||
| DefaultSqsMetricsReporterAwsClientFactory.class.getName()); | ||
|
Contributor
There was a problem hiding this comment. similar to the old client factory, we should be able to make |
||
| return (T) loadClientFactory(factoryImpl, properties); | ||
| } | ||
|
|
||
| private static SqsMetricsReporterAwsClientFactory loadClientFactory( | ||
| String impl, Map<String, String> properties) { | ||
| DynConstructors.Ctor<SqsMetricsReporterAwsClientFactory> ctor; | ||
| try { | ||
| ctor = | ||
| DynConstructors.builder(SqsMetricsReporterAwsClientFactory.class) | ||
| .loader(SqsMetricsReporterAwsClientFactories.class.getClassLoader()) | ||
| .hiddenImpl(impl) | ||
| .buildChecked(); | ||
| } catch (NoSuchMethodException e) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Cannot initialize SqsMetricsReporterAwsClientFactory, missing no-arg constructor: %s", | ||
| impl), | ||
| e); | ||
| } | ||
|
|
||
| SqsMetricsReporterAwsClientFactory factory; | ||
| try { | ||
| factory = ctor.newInstance(); | ||
| } catch (ClassCastException e) { | ||
| throw new IllegalArgumentException( | ||
| String.format( | ||
| "Cannot initialize SqsMetricsReporterAwsClientFactory, %s does not implement SqsMetricsReporterAwsClientFactory.", | ||
| impl), | ||
| e); | ||
| } | ||
|
|
||
| factory.initialize(properties); | ||
| return factory; | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 | ||
| * | ||
| * http://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 org.apache.iceberg.aws.metrics; | ||
|
|
||
| import java.util.Map; | ||
| import org.apache.iceberg.aws.AwsClientProperties; | ||
| import org.apache.iceberg.aws.HttpClientProperties; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.Maps; | ||
| import software.amazon.awssdk.services.sqs.SqsAsyncClient; | ||
|
|
||
| public class DefaultSqsMetricsReporterAwsClientFactory | ||
|
Contributor
There was a problem hiding this comment. this can be an inner package protected class in the factories class. |
||
| implements SqsMetricsReporterAwsClientFactory { | ||
|
|
||
| private SqsMetricsReporterProperties sqsMetricsReporterProperties; | ||
| private HttpClientProperties httpClientProperties; | ||
| private AwsClientProperties awsClientProperties; | ||
|
|
||
| DefaultSqsMetricsReporterAwsClientFactory() { | ||
| this.sqsMetricsReporterProperties = new SqsMetricsReporterProperties(); | ||
| this.httpClientProperties = new HttpClientProperties(); | ||
| this.awsClientProperties = new AwsClientProperties(); | ||
| } | ||
|
|
||
| @Override | ||
| public void initialize(Map<String, String> properties) { | ||
| Map<String, String> catalogProperties = Maps.newHashMap(properties); | ||
| catalogProperties.put( | ||
| HttpClientProperties.CLIENT_TYPE, HttpClientProperties.HTTP_CLIENT_TYPE_NETTYNIO); | ||
| this.sqsMetricsReporterProperties = new SqsMetricsReporterProperties(catalogProperties); | ||
| this.awsClientProperties = new AwsClientProperties(catalogProperties); | ||
| this.httpClientProperties = new HttpClientProperties(catalogProperties); | ||
| } | ||
|
|
||
| @Override | ||
| public SqsAsyncClient sqs() { | ||
| return SqsAsyncClient.builder() | ||
| .applyMutation(awsClientProperties::applyClientRegionConfiguration) | ||
| .applyMutation(httpClientProperties::applyAsyncHttpClientConfigurations) | ||
| .build(); | ||
| } | ||
| } | ||
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.
nit: can you add time units to this, like
-ms?