dannycranmer commented on a change in pull request #18314: URL: https://github.com/apache/flink/pull/18314#discussion_r793805846
########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/main/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkBuilder.java ########## @@ -0,0 +1,166 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.api.common.serialization.SerializationSchema; +import org.apache.flink.connector.base.sink.AsyncSinkBaseBuilder; + +import software.amazon.awssdk.http.Protocol; +import software.amazon.awssdk.services.firehose.model.Record; + +import java.util.Optional; +import java.util.Properties; + +import static org.apache.flink.connector.aws.config.AWSConfigConstants.HTTP_PROTOCOL_VERSION; +import static software.amazon.awssdk.http.Protocol.HTTP1_1; + +/** + * Builder to construct {@link KinesisFirehoseSink}. + * + * <p>The following example shows the minimum setup to create a {@link KinesisFirehoseSink} that + * writes String values to a Kinesis Data Firehose delivery stream named delivery-stream-name. + * + * <pre>{@code + * private static final KinesisFirehoseSinkElementConverter<String> elementConverter = + * KinesisFirehoseSinkElementConverter.<String>builder() + * .setSerializationSchema(new SimpleStringSchema()) + * .build(); Review comment: This comment is outdated I believe ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/main/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkBuilder.java ########## @@ -0,0 +1,166 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.api.common.serialization.SerializationSchema; +import org.apache.flink.connector.base.sink.AsyncSinkBaseBuilder; + +import software.amazon.awssdk.http.Protocol; +import software.amazon.awssdk.services.firehose.model.Record; + +import java.util.Optional; +import java.util.Properties; + +import static org.apache.flink.connector.aws.config.AWSConfigConstants.HTTP_PROTOCOL_VERSION; +import static software.amazon.awssdk.http.Protocol.HTTP1_1; + +/** + * Builder to construct {@link KinesisFirehoseSink}. + * + * <p>The following example shows the minimum setup to create a {@link KinesisFirehoseSink} that + * writes String values to a Kinesis Data Firehose delivery stream named delivery-stream-name. + * + * <pre>{@code + * private static final KinesisFirehoseSinkElementConverter<String> elementConverter = + * KinesisFirehoseSinkElementConverter.<String>builder() + * .setSerializationSchema(new SimpleStringSchema()) + * .build(); + * + * Properties sinkProperties = new Properties(); + * sinkProperties.put(AWSConfigConstants.AWS_REGION, "eu-west-1"); + * + * KinesisFirehoseSink<String> kdfSink = + * KinesisFirehoseSink.<String>builder() + * .setElementConverter(elementConverter) + * .setDeliveryStreamName("delivery-stream-name") + * .setMaxBatchSize(20) + * .setFirehoseClientProperties(sinkProperties) + * .build(); + * }</pre> + * + * <p>If the following parameters are not set in this builder, the following defaults will be used: + * + * <ul> + * <li>{@code maxBatchSize} will be 500 + * <li>{@code maxInFlightRequests} will be 50 + * <li>{@code maxBufferedRequests} will be 10000 + * <li>{@code maxBatchSizeInBytes} will be 4 MB i.e. {@code 4 * 1024 * 1024} + * <li>{@code maxTimeInBufferMS} will be 5000ms + * <li>{@code maxRecordSizeInBytes} will be 1000 KB i.e. {@code 1000 * 1024} + * <li>{@code failOnError} will be false + * </ul> + * + * @param <InputT> type of elements that should be persisted in the destination + */ +@PublicEvolving +public class KinesisFirehoseSinkBuilder<InputT> + extends AsyncSinkBaseBuilder<InputT, Record, KinesisFirehoseSinkBuilder<InputT>> { + + private static final int DEFAULT_MAX_BATCH_SIZE = 500; + private static final int DEFAULT_MAX_IN_FLIGHT_REQUESTS = 50; + private static final int DEFAULT_MAX_BUFFERED_REQUESTS = 10000; Review comment: nit: More readable like `10_000` ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/test/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkITCase.java ########## @@ -0,0 +1,117 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.api.common.serialization.SimpleStringSchema; +import org.apache.flink.connector.aws.testutils.LocalstackContainer; +import org.apache.flink.streaming.api.datastream.DataStream; +import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; +import org.apache.flink.util.DockerImageVersions; + +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper; + +import org.junit.After; +import org.junit.Before; +import org.junit.ClassRule; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testcontainers.utility.DockerImageName; +import software.amazon.awssdk.core.SdkSystemSetting; +import software.amazon.awssdk.services.firehose.FirehoseAsyncClient; +import software.amazon.awssdk.services.iam.IamAsyncClient; +import software.amazon.awssdk.services.s3.S3AsyncClient; +import software.amazon.awssdk.services.s3.model.S3Object; +import software.amazon.awssdk.utils.ImmutableMap; + +import java.util.List; + +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.createBucket; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.createIAMRole; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.getConfig; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.getIamClient; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.getS3Client; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.listBucketObjects; +import static org.apache.flink.connector.firehose.sink.testutils.KinesisFirehoseTestUtils.createDeliveryStream; +import static org.apache.flink.connector.firehose.sink.testutils.KinesisFirehoseTestUtils.getFirehoseClient; +import static org.assertj.core.api.Assertions.assertThat; + +/** Integration test suite for the {@code KinesisFirehoseSink} using a localstack container. */ +public class KinesisFirehoseSinkITCase { + + private static final Logger LOG = LoggerFactory.getLogger(KinesisFirehoseSinkITCase.class); + private S3AsyncClient s3AsyncClient; + private FirehoseAsyncClient firehoseAsyncClient; + private IamAsyncClient iamAsyncClient; + + private static final String ROLE_NAME = "super-role"; + private static final String ROLE_ARN = "arn:aws:iam::000000000000:role/" + ROLE_NAME; + private static final String BUCKET_NAME = "s3-firehose"; + private static final String STREAM_NAME = "s3-stream"; + private static final int NUMBER_OF_ELEMENTS = 92; + + @ClassRule + public static LocalstackContainer mockFirehoseContainer = + new LocalstackContainer(DockerImageName.parse(DockerImageVersions.LOCALSTACK)); + + @Before + public void setup() throws Exception { + System.setProperty(SdkSystemSetting.CBOR_ENABLED.property(), "false"); + s3AsyncClient = getS3Client(mockFirehoseContainer.getEndpoint()); + firehoseAsyncClient = getFirehoseClient(mockFirehoseContainer.getEndpoint()); + iamAsyncClient = getIamClient(mockFirehoseContainer.getEndpoint()); + } + + @After + public void teardown() { + System.clearProperty(SdkSystemSetting.CBOR_ENABLED.property()); + } + + @Test + public void test() throws Exception { + LOG.info("1 - Creating the bucket for Firehose to deliver into..."); + createBucket(s3AsyncClient, BUCKET_NAME); + LOG.info("2 - Creating the IAM Role for Firehose to write into the s3 bucket..."); + createIAMRole(iamAsyncClient, ROLE_NAME); + LOG.info("3 - Creating the Firehose delivery stream..."); + createDeliveryStream(STREAM_NAME, BUCKET_NAME, ROLE_ARN, firehoseAsyncClient); + + ObjectMapper mapper = new ObjectMapper(); + final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(); + + DataStream<String> generator = + env.fromSequence(1, NUMBER_OF_ELEMENTS) + .map(Object::toString) + .returns(String.class) + .map(data -> mapper.writeValueAsString(ImmutableMap.of("data", data))); + + KinesisFirehoseSink<String> kdsSink = + KinesisFirehoseSink.<String>builder() + .setSerializationSchema(new SimpleStringSchema()) + .setDeliveryStreamName(STREAM_NAME) + .setMaxBatchSize(1) + .setFirehoseClientProperties(getConfig(mockFirehoseContainer.getEndpoint())) + .build(); + + generator.sinkTo(kdsSink); + env.execute("Integration Test"); + + List<S3Object> objects = listBucketObjects(s3AsyncClient, BUCKET_NAME); + assertThat(objects.size()).isEqualTo(NUMBER_OF_ELEMENTS); Review comment: Can we verify the contents of the objects too for full confidence? ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/main/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkWriter.java ########## @@ -0,0 +1,205 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.api.connector.sink.Sink; +import org.apache.flink.connector.aws.util.AWSAsyncSinkUtil; +import org.apache.flink.connector.aws.util.AWSGeneralUtil; +import org.apache.flink.connector.base.sink.writer.AsyncSinkWriter; +import org.apache.flink.connector.base.sink.writer.ElementConverter; +import org.apache.flink.metrics.Counter; +import org.apache.flink.metrics.groups.SinkWriterMetricGroup; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import software.amazon.awssdk.http.async.SdkAsyncHttpClient; +import software.amazon.awssdk.services.firehose.FirehoseAsyncClient; +import software.amazon.awssdk.services.firehose.model.PutRecordBatchRequest; +import software.amazon.awssdk.services.firehose.model.PutRecordBatchResponse; +import software.amazon.awssdk.services.firehose.model.PutRecordBatchResponseEntry; +import software.amazon.awssdk.services.firehose.model.Record; +import software.amazon.awssdk.services.firehose.model.ResourceNotFoundException; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import java.util.function.Consumer; + +/** + * Sink writer created by {@link KinesisFirehoseSink} to write to Kinesis Data Firehose. More + * details on the operation of this sink writer may be found in the doc for {@link + * KinesisFirehoseSink}. More details on the internals of this sink writer may be found in {@link + * AsyncSinkWriter}. + * + * <p>The {@link FirehoseAsyncClient} used here may be configured in the standard way for the AWS + * SDK 2.x. e.g. the provision of {@code AWS_REGION}, {@code AWS_ACCESS_KEY_ID} and {@code + * AWS_SECRET_ACCESS_KEY} through environment variables etc. + */ +@Internal +class KinesisFirehoseSinkWriter<InputT> extends AsyncSinkWriter<InputT, Record> { + private static final Logger LOG = LoggerFactory.getLogger(KinesisFirehoseSinkWriter.class); + + /* A counter for the total number of records that have encountered an error during put */ + private final Counter numRecordsOutErrorsCounter; + + /* Name of the delivery stream in Kinesis Data Firehose */ + private final String deliveryStreamName; + + /* The sink writer metric group */ + private final SinkWriterMetricGroup metrics; + + /* The asynchronous Firehose client - construction is by firehoseClientProperties */ + private final FirehoseAsyncClient client; + + /* Flag to whether fatally fail any time we encounter an exception when persisting records */ + private final boolean failOnError; + + KinesisFirehoseSinkWriter( + ElementConverter<InputT, Record> elementConverter, + Sink.InitContext context, + int maxBatchSize, + int maxInFlightRequests, + int maxBufferedRequests, + long maxBatchSizeInBytes, + long maxTimeInBufferMS, + long maxRecordSizeInBytes, + boolean failOnError, + String deliveryStreamName, + Properties firehoseClientProperties) { + super( + elementConverter, + context, + maxBatchSize, + maxInFlightRequests, + maxBufferedRequests, + maxBatchSizeInBytes, + maxTimeInBufferMS, + maxRecordSizeInBytes); + this.failOnError = failOnError; + this.deliveryStreamName = deliveryStreamName; + this.metrics = context.metricGroup(); + this.numRecordsOutErrorsCounter = metrics.getNumRecordsOutErrorsCounter(); + this.client = buildClient(firehoseClientProperties); + } + + private FirehoseAsyncClient buildClient(Properties firehoseClientProperties) { + final SdkAsyncHttpClient httpClient = + AWSGeneralUtil.createAsyncHttpClient(firehoseClientProperties); + + return AWSAsyncSinkUtil.createAwsAsyncClient( + firehoseClientProperties, + httpClient, + FirehoseAsyncClient.builder(), + KinesisFirehoseConfigConstants.BASE_FIREHOSE_USER_AGENT_PREFIX_FORMAT, + KinesisFirehoseConfigConstants.FIREHOSE_CLIENT_USER_AGENT_PREFIX); + } + + @Override + protected void submitRequestEntries( + List<Record> requestEntries, Consumer<List<Record>> requestResult) { + + PutRecordBatchRequest batchRequest = + PutRecordBatchRequest.builder() + .records(requestEntries) + .deliveryStreamName(deliveryStreamName) + .build(); + + LOG.trace("Request to submit {} entries to KDF using KDF Sink.", requestEntries.size()); + + CompletableFuture<PutRecordBatchResponse> future = client.putRecordBatch(batchRequest); + + future.whenComplete( + (response, err) -> { + if (err != null) { + handleFullyFailedRequest(err, requestEntries, requestResult); + } else if (response.failedPutCount() > 0) { + handlePartiallyFailedRequest(response, requestEntries, requestResult); + } else { + requestResult.accept(Collections.emptyList()); + } + }); + } + + @Override + protected long getSizeInBytes(Record requestEntry) { + return requestEntry.data().asByteArrayUnsafe().length; + } + + private void handleFullyFailedRequest( + Throwable err, List<Record> requestEntries, Consumer<List<Record>> requestResult) { + LOG.warn( + "KDF Sink failed to persist {} entries to KDF first request was {}", + requestEntries.size(), + requestEntries.get(0).toString(), + err); + numRecordsOutErrorsCounter.inc(requestEntries.size()); + + if (isRetryable(err)) { + requestResult.accept(requestEntries); + } + } + + private void handlePartiallyFailedRequest( + PutRecordBatchResponse response, + List<Record> requestEntries, + Consumer<List<Record>> requestResult) { + LOG.warn( + "KDF Sink failed to persist {} entries to KDF first request was {}", + requestEntries.size(), + requestEntries.get(0).toString()); + numRecordsOutErrorsCounter.inc(response.failedPutCount()); + + if (failOnError) { + getFatalExceptionCons() + .accept(new KinesisFirehoseException.KinesisFirehoseFailFastException()); + return; + } + List<Record> failedRequestEntries = new ArrayList<>(response.failedPutCount()); + List<PutRecordBatchResponseEntry> records = response.requestResponses(); + + for (int i = 0; i < records.size(); i++) { + if (records.get(i).errorCode() != null) { + failedRequestEntries.add(requestEntries.get(i)); + } + } Review comment: nit: ``` for (PutRecordBatchResponseEntry entry : records) { if (entry.errorCode() != null) { failedRequestEntries.add(entry); } } ``` ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/main/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkElementConverter.java ########## @@ -0,0 +1,75 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.api.common.serialization.SerializationSchema; +import org.apache.flink.api.connector.sink.SinkWriter; +import org.apache.flink.connector.base.sink.writer.ElementConverter; +import org.apache.flink.util.Preconditions; + +import software.amazon.awssdk.core.SdkBytes; +import software.amazon.awssdk.services.firehose.model.Record; + +/** + * An implementation of the {@link ElementConverter} that uses the AWS Kinesis SDK v2. The user only + * needs to provide a {@link SerializationSchema} of the {@code InputT} to transform it into a + * {@link Record} that may be persisted. + */ +@PublicEvolving +public class KinesisFirehoseSinkElementConverter<InputT> + implements ElementConverter<InputT, Record> { + + /** A serialization schema to specify how the input element should be serialized. */ + private final SerializationSchema<InputT> serializationSchema; + + private KinesisFirehoseSinkElementConverter(SerializationSchema<InputT> serializationSchema) { + this.serializationSchema = serializationSchema; + } + + @Override + public Record apply(InputT element, SinkWriter.Context context) { + return Record.builder() + .data(SdkBytes.fromByteArray(serializationSchema.serialize(element))) + .build(); + } + + public static <InputT> Builder<InputT> builder() { + return new Builder<>(); + } + + /** A builder for the KinesisFirehoseSinkElementConverter. */ + @PublicEvolving Review comment: Same as above ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/main/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkElementConverter.java ########## @@ -0,0 +1,75 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.api.common.serialization.SerializationSchema; +import org.apache.flink.api.connector.sink.SinkWriter; +import org.apache.flink.connector.base.sink.writer.ElementConverter; +import org.apache.flink.util.Preconditions; + +import software.amazon.awssdk.core.SdkBytes; +import software.amazon.awssdk.services.firehose.model.Record; + +/** + * An implementation of the {@link ElementConverter} that uses the AWS Kinesis SDK v2. The user only + * needs to provide a {@link SerializationSchema} of the {@code InputT} to transform it into a + * {@link Record} that may be persisted. + */ +@PublicEvolving Review comment: This should be `@Internal` inline with KDS? ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/test/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkITCase.java ########## @@ -0,0 +1,117 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.api.common.serialization.SimpleStringSchema; +import org.apache.flink.connector.aws.testutils.LocalstackContainer; +import org.apache.flink.streaming.api.datastream.DataStream; +import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; +import org.apache.flink.util.DockerImageVersions; + +import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper; + +import org.junit.After; +import org.junit.Before; +import org.junit.ClassRule; +import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testcontainers.utility.DockerImageName; +import software.amazon.awssdk.core.SdkSystemSetting; +import software.amazon.awssdk.services.firehose.FirehoseAsyncClient; +import software.amazon.awssdk.services.iam.IamAsyncClient; +import software.amazon.awssdk.services.s3.S3AsyncClient; +import software.amazon.awssdk.services.s3.model.S3Object; +import software.amazon.awssdk.utils.ImmutableMap; + +import java.util.List; + +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.createBucket; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.createIAMRole; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.getConfig; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.getIamClient; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.getS3Client; +import static org.apache.flink.connector.aws.testutils.AWSServicesTestUtils.listBucketObjects; +import static org.apache.flink.connector.firehose.sink.testutils.KinesisFirehoseTestUtils.createDeliveryStream; +import static org.apache.flink.connector.firehose.sink.testutils.KinesisFirehoseTestUtils.getFirehoseClient; +import static org.assertj.core.api.Assertions.assertThat; + +/** Integration test suite for the {@code KinesisFirehoseSink} using a localstack container. */ +public class KinesisFirehoseSinkITCase { + + private static final Logger LOG = LoggerFactory.getLogger(KinesisFirehoseSinkITCase.class); + private S3AsyncClient s3AsyncClient; + private FirehoseAsyncClient firehoseAsyncClient; + private IamAsyncClient iamAsyncClient; Review comment: Move these below the `static` fields ########## File path: flink-connectors/flink-connector-aws-kinesis-firehose/src/main/java/org/apache/flink/connector/firehose/sink/KinesisFirehoseSinkWriter.java ########## @@ -0,0 +1,205 @@ +/* + * 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.flink.connector.firehose.sink; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.api.connector.sink.Sink; +import org.apache.flink.connector.aws.util.AWSAsyncSinkUtil; +import org.apache.flink.connector.aws.util.AWSGeneralUtil; +import org.apache.flink.connector.base.sink.writer.AsyncSinkWriter; +import org.apache.flink.connector.base.sink.writer.ElementConverter; +import org.apache.flink.metrics.Counter; +import org.apache.flink.metrics.groups.SinkWriterMetricGroup; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import software.amazon.awssdk.http.async.SdkAsyncHttpClient; +import software.amazon.awssdk.services.firehose.FirehoseAsyncClient; +import software.amazon.awssdk.services.firehose.model.PutRecordBatchRequest; +import software.amazon.awssdk.services.firehose.model.PutRecordBatchResponse; +import software.amazon.awssdk.services.firehose.model.PutRecordBatchResponseEntry; +import software.amazon.awssdk.services.firehose.model.Record; +import software.amazon.awssdk.services.firehose.model.ResourceNotFoundException; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; +import java.util.function.Consumer; + +/** + * Sink writer created by {@link KinesisFirehoseSink} to write to Kinesis Data Firehose. More + * details on the operation of this sink writer may be found in the doc for {@link + * KinesisFirehoseSink}. More details on the internals of this sink writer may be found in {@link + * AsyncSinkWriter}. + * + * <p>The {@link FirehoseAsyncClient} used here may be configured in the standard way for the AWS + * SDK 2.x. e.g. the provision of {@code AWS_REGION}, {@code AWS_ACCESS_KEY_ID} and {@code + * AWS_SECRET_ACCESS_KEY} through environment variables etc. + */ +@Internal +class KinesisFirehoseSinkWriter<InputT> extends AsyncSinkWriter<InputT, Record> { + private static final Logger LOG = LoggerFactory.getLogger(KinesisFirehoseSinkWriter.class); + + /* A counter for the total number of records that have encountered an error during put */ + private final Counter numRecordsOutErrorsCounter; + + /* Name of the delivery stream in Kinesis Data Firehose */ + private final String deliveryStreamName; + + /* The sink writer metric group */ + private final SinkWriterMetricGroup metrics; + + /* The asynchronous Firehose client - construction is by firehoseClientProperties */ + private final FirehoseAsyncClient client; + + /* Flag to whether fatally fail any time we encounter an exception when persisting records */ + private final boolean failOnError; + + KinesisFirehoseSinkWriter( + ElementConverter<InputT, Record> elementConverter, + Sink.InitContext context, + int maxBatchSize, + int maxInFlightRequests, + int maxBufferedRequests, + long maxBatchSizeInBytes, + long maxTimeInBufferMS, + long maxRecordSizeInBytes, + boolean failOnError, + String deliveryStreamName, + Properties firehoseClientProperties) { + super( + elementConverter, + context, + maxBatchSize, + maxInFlightRequests, + maxBufferedRequests, + maxBatchSizeInBytes, + maxTimeInBufferMS, + maxRecordSizeInBytes); + this.failOnError = failOnError; + this.deliveryStreamName = deliveryStreamName; + this.metrics = context.metricGroup(); + this.numRecordsOutErrorsCounter = metrics.getNumRecordsOutErrorsCounter(); + this.client = buildClient(firehoseClientProperties); + } + + private FirehoseAsyncClient buildClient(Properties firehoseClientProperties) { + final SdkAsyncHttpClient httpClient = + AWSGeneralUtil.createAsyncHttpClient(firehoseClientProperties); + + return AWSAsyncSinkUtil.createAwsAsyncClient( + firehoseClientProperties, + httpClient, + FirehoseAsyncClient.builder(), + KinesisFirehoseConfigConstants.BASE_FIREHOSE_USER_AGENT_PREFIX_FORMAT, + KinesisFirehoseConfigConstants.FIREHOSE_CLIENT_USER_AGENT_PREFIX); + } + + @Override + protected void submitRequestEntries( + List<Record> requestEntries, Consumer<List<Record>> requestResult) { + + PutRecordBatchRequest batchRequest = + PutRecordBatchRequest.builder() + .records(requestEntries) + .deliveryStreamName(deliveryStreamName) + .build(); + + LOG.trace("Request to submit {} entries to KDF using KDF Sink.", requestEntries.size()); + + CompletableFuture<PutRecordBatchResponse> future = client.putRecordBatch(batchRequest); + + future.whenComplete( + (response, err) -> { + if (err != null) { + handleFullyFailedRequest(err, requestEntries, requestResult); + } else if (response.failedPutCount() > 0) { + handlePartiallyFailedRequest(response, requestEntries, requestResult); + } else { + requestResult.accept(Collections.emptyList()); + } + }); + } + + @Override + protected long getSizeInBytes(Record requestEntry) { + return requestEntry.data().asByteArrayUnsafe().length; + } + + private void handleFullyFailedRequest( + Throwable err, List<Record> requestEntries, Consumer<List<Record>> requestResult) { + LOG.warn( + "KDF Sink failed to persist {} entries to KDF first request was {}", + requestEntries.size(), + requestEntries.get(0).toString(), + err); + numRecordsOutErrorsCounter.inc(requestEntries.size()); + + if (isRetryable(err)) { + requestResult.accept(requestEntries); + } + } + + private void handlePartiallyFailedRequest( + PutRecordBatchResponse response, + List<Record> requestEntries, + Consumer<List<Record>> requestResult) { + LOG.warn( + "KDF Sink failed to persist {} entries to KDF first request was {}", + requestEntries.size(), + requestEntries.get(0).toString()); + numRecordsOutErrorsCounter.inc(response.failedPutCount()); + + if (failOnError) { + getFatalExceptionCons() + .accept(new KinesisFirehoseException.KinesisFirehoseFailFastException()); + return; + } + List<Record> failedRequestEntries = new ArrayList<>(response.failedPutCount()); + List<PutRecordBatchResponseEntry> records = response.requestResponses(); + + for (int i = 0; i < records.size(); i++) { + if (records.get(i).errorCode() != null) { + failedRequestEntries.add(requestEntries.get(i)); + } + } + + requestResult.accept(failedRequestEntries); + } + + private boolean isRetryable(Throwable err) { + if (err instanceof CompletionException + && err.getCause() instanceof ResourceNotFoundException) { + getFatalExceptionCons() + .accept( + new KinesisFirehoseException( + "Encountered non-recoverable exception", err)); + return false; + } + if (failOnError) { + getFatalExceptionCons() Review comment: I have forgot what this method name means. Based on that, is it worth renaming to something people might understand? What is `Cons` ? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
