From e4e2cd1a8676065b32bd20eb40444ae407c51405 Mon Sep 17 00:00:00 2001 From: Jeroen Reijn Date: Thu, 21 Mar 2024 17:05:47 +0100 Subject: [PATCH] chore(v2): document use of aws-crt-client (#1092) (#1605) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore(v2): document use of aws-crt-client (#1092) * Update docs/FAQs.md Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com> * Update docs/FAQs.md Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com> * Update docs/FAQs.md Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com> * chore(v2): improve documentation based on feedback (#1092) * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update docs/FAQs.md Co-authored-by: Scott Gerring * Update FAQs.md and set version --------- Co-authored-by: Jérôme Van Der Linden <117538+jeromevdl@users.noreply.github.com> Co-authored-by: Scott Gerring --- docs/FAQs.md | 100 ++++++++++++++++++++++++++++++- docs/utilities/batch.md | 26 ++++---- docs/utilities/large_messages.md | 85 +++++++++++++------------- docs/utilities/parameters.md | 1 + 4 files changed, 155 insertions(+), 57 deletions(-) diff --git a/docs/FAQs.md b/docs/FAQs.md index 99ef40905..88aa81c9f 100644 --- a/docs/FAQs.md +++ b/docs/FAQs.md @@ -6,7 +6,7 @@ description: Frequently Asked Questions ## How can I use Powertools for AWS Lambda (Java) with Lombok? -Poweretools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into the project. In case you want to use `Lombok` or other compile-time preprocessor for your project, it is required to change `aspectj-maven-plugin` configuration to enable in-place weaving feature. Otherwise the plugin will ignore changes introduced by `Lombok` and will use `.java` files as a source. +Powertools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into the project. In case you want to use `Lombok` or other compile-time preprocessor for your project, it is required to change `aspectj-maven-plugin` configuration to enable in-place weaving feature. Otherwise the plugin will ignore changes introduced by `Lombok` and will use `.java` files as a source. To enable in-place weaving feature you need to use following `aspectj-maven-plugin` configuration: @@ -29,7 +29,7 @@ To enable in-place weaving feature you need to use following `aspectj-maven-plug ## How can I use Powertools for AWS Lambda (Java) with Kotlin projects? -Poweretools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into the project. When using it with Kotlin projects, it is required to `forceAjcCompile`. +Powertools uses `aspectj-maven-plugin` to compile-time weave (CTW) aspects into the project. When using it with Kotlin projects, it is required to `forceAjcCompile`. No explicit configuration should be required for gradle projects. To enable `forceAjcCompile` you need to use following `aspectj-maven-plugin` configuration: @@ -47,3 +47,99 @@ To enable `forceAjcCompile` you need to use following `aspectj-maven-plugin` con ``` +## How can I use Powertools for AWS Lambda (Java) with the AWS CRT HTTP Client? + +Powertools uses the `url-connection-client` as the default HTTP client. The `url-connection-client` is a lightweight HTTP client, which keeps the impact on Lambda cold starts to a minimum. +With the [announcement](https://aws.amazon.com/blogs/developer/announcing-availability-of-the-aws-crt-http-client-in-the-aws-sdk-for-java-2-x/) of the `aws-crt-client` a new HTTP client has been released, which offers faster SDK startup time and smaller memory footprint. + +Unfortunately, replacing the `url-connection-client` dependency with the `aws-crt-client` will not immediately improve the lambda cold start performance and memory footprint, +as the default version of the dependency contains native system libraries for all supported runtimes and architectures (Linux, MacOS, Windows, AMD64, ARM64, etc). This makes the CRT client portable, without the user having to consider _where_ their code will run, but comes at the cost of JAR size. + +### Configuring dependencies + +Using the `aws-crt-client` in your project requires the exclusion of the `url-connection-client` transitive dependency from the powertools dependency. + +```xml + + software.amazon.lambda + powertools-parameters + 2.0.0 + + + software.amazon.awssdk + url-connection-client + + + +``` +Next, add the `aws-crt-client` and exclude the "generic" `aws-crt` dependency (contains all runtime libraries). +Instead, set a specific classifier of the `aws-crt` to use the one for your target runtime: either `linux-x86_64` for a Lambda configured for x86 or `linux-aarch_64` for Lambda using arm64. + +!!! note "You will need to add a separate maven profile to build and debug locally when your development environment does not share the target architecture you are using in Lambda." +By specifying the specific target runtime, we prevent other target runtimes from being included in the jar file, resulting in a smaller Lambda package and improved cold start times. + +```xml + + + + software.amazon.awssdk + aws-crt-client + 2.23.21 + + + software.amazon.awssdk.crt + aws-crt + + + + + + software.amazon.awssdk.crt + aws-crt + 0.29.9 + linux-x86_64 + + +``` + +### Explicitly set the AWS CRT HTTP Client +After configuring the dependencies, it's required to explicitly specify the AWS SDK HTTP client. +Depending on the Powertools module, there is a different way to configure the SDK client. + +The following example shows how to use the Lambda Powertools Parameters module while leveraging the AWS CRT Client. + + ```java hl_lines="11-16 19-20 22" + import static software.amazon.lambda.powertools.parameters.transform.Transformer.base64; + + import com.amazonaws.services.lambda.runtime.Context; + import com.amazonaws.services.lambda.runtime.RequestHandler; + import software.amazon.awssdk.services.ssm.SsmClient; + import software.amazon.awssdk.http.crt.AwsCrtHttpClient; + import software.amazon.lambda.powertools.parameters.ssm.SSMProvider; + + public class RequestHandlerWithParams implements RequestHandler { + + // Get an instance of the SSMProvider with a custom HTTP client (aws crt). + SSMProvider ssmProvider = SSMProvider + .builder() + .withClient( + SsmClient.builder() + .httpClient(AwsCrtHttpClient.builder().build()) + .build() + ) + .build(); + + public String handleRequest(String input, Context context) { + // Retrieve a single param + String value = ssmProvider + .get("/my/secret"); + // We might instead want to retrieve multiple parameters at once, returning a Map of key/value pairs + // .getMultiple("/my/secret/path"); + + // Return the result + return value; + } + } + ``` +The `aws-crt-client` was considered for adoption as the default HTTP client in Lambda Powertools for Java as mentioned in [Move SDK http client to CRT](https://github.com/aws-powertools/powertools-lambda-java/issues/1092), +but due to the impact on the developer experience it was decided to stick with the `url-connection-client`. \ No newline at end of file diff --git a/docs/utilities/batch.md b/docs/utilities/batch.md index 6b38b438c..7b571bc6e 100644 --- a/docs/utilities/batch.md +++ b/docs/utilities/batch.md @@ -530,19 +530,19 @@ Handlers can be provided when building the batch processor and are available for For instance for DynamoDB: ```java -BatchMessageHandler handler = new BatchMessageHandlerBuilder() - .withDynamoDbBatchHandler() - .withSuccessHandler((m) -> { - // Success handler receives the raw message - LOGGER.info("Message with sequenceNumber {} was successfully processed", - m.getDynamodb().getSequenceNumber()); - }) - .withFailureHandler((m, e) -> { - // Failure handler receives the raw message and the exception thrown. - LOGGER.info("Message with sequenceNumber {} failed to be processed: {}" - , e.getDynamodb().getSequenceNumber(), e); - }) - .buildWithMessageHander(this::processMessage); + BatchMessageHandler handler = new BatchMessageHandlerBuilder() + .withDynamoDbBatchHandler() + .withSuccessHandler((m) -> { + // Success handler receives the raw message + LOGGER.info("Message with sequenceNumber {} was successfully processed", + m.getDynamodb().getSequenceNumber()); + }) + .withFailureHandler((m, e) -> { + // Failure handler receives the raw message and the exception thrown. + LOGGER.info("Message with sequenceNumber {} failed to be processed: {}" + , e.getDynamodb().getSequenceNumber(), e); + }) + .buildWithMessageHander(this::processMessage); ``` !!! info diff --git a/docs/utilities/large_messages.md b/docs/utilities/large_messages.md index c0c1cd599..2f974c3b5 100644 --- a/docs/utilities/large_messages.md +++ b/docs/utilities/large_messages.md @@ -97,48 +97,49 @@ of amazon-sns-java-extended-client-lib. Depending on your version of Java (either Java 1.8 or 11+), the configuration slightly changes. === "Maven Java 11+" -```xml hl_lines="3-7 16 18 24-27" - -... - -software.amazon.lambda -powertools-large-messages -{{ powertools.version }} - -... - -... - - - -... - -dev.aspectj -aspectj-maven-plugin -1.13.1 - -11 -11 -11 - - -software.amazon.lambda -powertools-large-messages - - - - - - -compile - - - - -... - - -``` + + ```xml hl_lines="3-7 16 18 24-27" + + ... + + software.amazon.lambda + powertools-large-messages + {{ powertools.version }} + + ... + + ... + + + + ... + + dev.aspectj + aspectj-maven-plugin + 1.13.1 + + 11 + 11 + 11 + + + software.amazon.lambda + powertools-large-messages + + + + + + + compile + + + + + ... + + + ``` === "Maven Java 1.8" diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index f72c7704e..46c7e8071 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -544,6 +544,7 @@ To simplify the use of the library, you can chain all method calls before a get. .withTransformation(json) // json is a static import from Transformer.json .withDecryption() // enable decryption of the parameter value .get("/my/param", MyObj.class); // finally get the value + ``` ### Create your own Provider You can create your own custom parameter store provider by implementing a handful of classes: