From 0fa90a29367f4c7c10ac68d223c4492629cb8c03 Mon Sep 17 00:00:00 2001 From: Indranil Banerjee Date: Mon, 21 Oct 2024 15:16:24 -0700 Subject: [PATCH] msk-lambda-iam-java-sam - Java AWS Lambda Kafka consumer with IAM auth, using AWS SAM --- msk-lambda-iam-java-sam/.gitignore | 23 ++ msk-lambda-iam-java-sam/README.md | 134 ++++++++++++ msk-lambda-iam-java-sam/events/event.json | 31 +++ msk-lambda-iam-java-sam/example-pattern.json | 90 ++++++++ .../kafka_event_consumer_function/.gitignore | 1 + .../.settings/org.eclipse.jdt.core.prefs | 8 + .../kafka_event_consumer_function/pom.xml | 67 ++++++ .../lambda/samples/events/msk/HandlerMSK.java | 110 ++++++++++ .../samples/events/msk/KafkaHeader.java | 67 ++++++ .../samples/events/msk/KafkaMessage.java | 198 ++++++++++++++++++ .../samples/events/msk/HandlerMSKTest.java | 70 +++++++ .../samples/events/msk/TestContext.java | 45 ++++ .../lambda/samples/events/msk/TestLogger.java | 14 ++ msk-lambda-iam-java-sam/template.yaml | 87 ++++++++ 14 files changed, 945 insertions(+) create mode 100644 msk-lambda-iam-java-sam/.gitignore create mode 100644 msk-lambda-iam-java-sam/README.md create mode 100644 msk-lambda-iam-java-sam/events/event.json create mode 100644 msk-lambda-iam-java-sam/example-pattern.json create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/.gitignore create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/.settings/org.eclipse.jdt.core.prefs create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/pom.xml create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSK.java create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaHeader.java create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaMessage.java create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSKTest.java create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestContext.java create mode 100644 msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestLogger.java create mode 100644 msk-lambda-iam-java-sam/template.yaml diff --git a/msk-lambda-iam-java-sam/.gitignore b/msk-lambda-iam-java-sam/.gitignore new file mode 100644 index 000000000..cf4f80259 --- /dev/null +++ b/msk-lambda-iam-java-sam/.gitignore @@ -0,0 +1,23 @@ +node_modules +npm-debug.log +package-lock.json +package +*out.yml +out.json +bucket-name.txt +target +build +.gradle +*.zip +bin +obj +Gemfile.lock +lib +__pycache__ +*.pyc +.classpath +.factorypath +.project +.settings/* +.aws +.sam diff --git a/msk-lambda-iam-java-sam/README.md b/msk-lambda-iam-java-sam/README.md new file mode 100644 index 000000000..f58d74424 --- /dev/null +++ b/msk-lambda-iam-java-sam/README.md @@ -0,0 +1,134 @@ +# msk-lambda-iam-java-sam +# Java AWS Lambda Kafka consumer with IAM auth, using AWS SAM + +This pattern is an example of a Lambda function that consumes messages from an Amazon Managed Streaming for Kafka (Amazon MSK) topic, where the MSK Cluster has been configured to use IAM authentication. This pattern assumes you already have an MSK cluster with a topic configured, if you need a sample pattern to deploy an MSK cluster either in Provisioned or Serverless modes please see the [msk-cfn-sasl-lambda pattern](https://serverlessland.com/patterns/msk-cfn-sasl-lambda). + +This project contains source code and supporting files for a serverless application that you can deploy with the SAM CLI. It includes the following files and folders. + +- kafka_event_consumer_function/src/main/java - Code for the application's Lambda function. +- events - Invocation events that you can use to invoke the function. +- kafka_event_consumer_function/src/test/java - Unit tests for the application code. +- template.yaml - A template that defines the application's AWS resources. + +The application uses several AWS resources, including Lambda functions and an MSK event source. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code. + +Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example. + +## Requirements + +* [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources. +* [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) installed and configured +* [Git installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +* [AWS Serverless Application Model](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) (AWS SAM) installed +* Create MSK cluster and topic that will be used for testing. It is important to create the topic before deploying the Lambda function, otherwise the event source mapping will stay disabled. + + +Before proceeding with the next step, please make sure you have Java JDK and Maven installed on your machine + +For the latest version of Amazon Corretto JDK (at the time of publishing), please go the following link: + +https://docs.aws.amazon.com/corretto/latest/corretto-21-ug/downloads-list.html + +Please follow the instructions to download and install the JDK for your Operating System + +Note that you don't have to use Amazon Corretto JDK but can use JDK from another source as well + +For the latest version of Maven (at the time of publishing) please go the following link: + +https://maven.apache.org/download.cgi#:~:text=Apache%20Maven%203.9.9%20is,recommended%20version%20for%20all%20users. + +Please follow the instructions to download and install Maven and then add the location to the bin folder of Maven in your System PATH + +To ensure Java and Maven are correctly installed, run the commands: + +java --version + +mvn --version + + +## Deploy the sample application + +The AWS SAM CLI is a serverless tool for building and testing Lambda applications. It uses Docker to locally test your functions in an Amazon Linux environment that resembles the Lambda execution environment. It can also emulate your application's build environment and API. + +To use the AWS SAM CLI, you need the following tools. + +* AWS SAM CLI - [Install the AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) +* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) + +1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository: + ``` + git clone https://github.com/aws-samples/serverless-patterns.git + ``` +1. Change directory to the pattern directory: + ``` + cd msk-lambda-iam-java-sam + ``` + +## Use the SAM CLI to build and test locally + +Build your application with the `sam build` command. + +```bash +sam build +``` + +The SAM CLI installs dependencies defined in `kafka_event_consumer_function/pom.xml`, creates a deployment package, and saves it in the `.aws-sam/build` folder. + +Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project. + +Run functions locally and invoke them with the `sam local invoke` command. + +```bash +sam local invoke --event events/event.json +``` + +## Deploy the sample application + +The Serverless Application Model Command Line Interface (SAM CLI) is an extension of the AWS CLI that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API. + +To use the SAM CLI, you need the following tools. + +* SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) +* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) + +To build and deploy your application for the first time, run the following in your shell: + +```bash +sam build +sam deploy --guided +``` + +The first command will build the source of your application. The second command will package and deploy your application to AWS, with a series of prompts: + +* **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name. +* **AWS Region**: The AWS region you want to deploy your app to. +* **Parameter MSKClusterName**: The name of the MSKCluster +* **Parameter MSKClusterId**: The unique ID of the MSKCluster +* **Parameter MSKTopic**: The Kafka topic on which the lambda function will listen on +* **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes. +* **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command. +* **Disable rollback**: Defaults to No and it preserves the state of previously provisioned resources when an operation fails +* **Save arguments to configuration file**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application. +* **SAM configuration file [samconfig.toml]**: Name of the configuration file to store configuration information locally +* **SAM configuration environment [default]**: Environment for storing deployment information locally + +You should get a message "Successfully created/updated stack - in " if all goes well + + +## Test the sample application + +Once the lambda function is deployed, send some Kafka messages on the topic that the lambda function is listening on, on the MSK server. + +Either send at least 10 messages or wait for 300 seconds (check the values of BatchSize: 10 and MaximumBatchingWindowInSeconds: 300 in the template.yaml file) + +Then check Cloudwatch logs and you should see messages for the Cloudwatch Log Group with the name of the deployed Lambda function. + +The lambda code parses the Kafka messages and outputs the fields in the Kafka messages to Cloudwatch logs + +A single lambda function receives a batch of messages. The messages are received as a map with each key being a combination of the topic and the partition, as a single batch can receive messages from multiple partitions. + +Each key has a list of messages. Each Kafka message has the following properties - Topic, Partition, Offset, TimeStamp, TimeStampType, Key and Value + +The Key and Value are base64 encoded and have to be decoded. A message can also have a list of headers, each header having a key and a value. + +The code in this example prints out the fields in the Kafka message and also decrypts the key and the value and logs them in Cloudwatch logs. diff --git a/msk-lambda-iam-java-sam/events/event.json b/msk-lambda-iam-java-sam/events/event.json new file mode 100644 index 000000000..b527986ab --- /dev/null +++ b/msk-lambda-iam-java-sam/events/event.json @@ -0,0 +1,31 @@ +{ + "records":{ + "myTopic-0":[ + { + "topic":"myTopic", + "partition":0, + "offset":250, + "timestamp":1678072110111, + "timestampType":"CREATE_TIME", + "value":"Zg==", + "headers":[ + + ] + }, + { + "topic":"myTopic", + "partition":0, + "offset":251, + "timestamp":1678072111086, + "timestampType":"CREATE_TIME", + "value":"Zw==", + "headers":[ + + ] + } + ] + }, + "eventSource":"aws:kafka", + "eventSourceArn":"arn:aws:kafka:us-west-2:123456789012:cluster/MSKWorkshopCluster/a93759a9-c9d0-4952-984c-492c6bfa2be8-13", + "bootstrapServers":"b-2.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098,b-3.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098,b-1.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098" +} \ No newline at end of file diff --git a/msk-lambda-iam-java-sam/example-pattern.json b/msk-lambda-iam-java-sam/example-pattern.json new file mode 100644 index 000000000..571060cb0 --- /dev/null +++ b/msk-lambda-iam-java-sam/example-pattern.json @@ -0,0 +1,90 @@ +{ + "title": "AWS Lambda function subscribed to an Amazon MSK topic using IAM auth", + "description": "Creates a Lambda function that uses an Amazon MSK topic as an event source with IAM authentication.", + "language": "Java", + "level": "200", + "framework": "SAM", + "introBox": { + "headline": "How it works", + "text": [ + "This pattern provides a Lambda function along with an Event Source Mapping to a Kafka topic.", + "It requires that you already have an Amazon Managed Streaming for Kafka (Amazon MSK) cluster setup with a topic created. ", + "If you don't already have an MSK cluster, you can use the example in this pattern https://serverlessland.com/patterns/msk-cfn-sasl-lambda (linked in the resources) to deploy a cluster.", + "This pattern works with either a Provisioned or Serverless MSK cluster as long as the cluster is configured to use IAM authentication. ", + "For detailed deployment instructions instructions see the README." + ] + }, + "gitHub": { + "template": { + "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/msk-lambda-iam-java-sam", + "templateURL": "serverless-patterns/msk-lambda-iam-java-sam", + "projectFolder": "msk-lambda-iam-java-sam", + "templateFile": "template.yaml" + } + }, + "resources": { + "bullets": [ + { + "text": "Amazon MSK cluster pattern", + "link": "https://serverlessland.com/patterns/msk-cfn-sasl-lambda" + }, + { + "text": "Using AWS Lambda with Amazon MSK", + "link": "https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html" + }, + { + "text": "AWS CloudFormation Provisioned MSK cluster reference", + "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html" + }, + { + "text": "AWS CloudFormation Serverless MSK cluster reference", + "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html" + } + ] + }, + "deploy": { + "text": [ + "sam deploy --guided" + ] + }, + "testing": { + "text": [ + "See the GitHub repo for detailed testing instructions." + ] + }, + "cleanup": { + "text": [ + "Delete the template: sam delete." + ] + }, + "authors": [ + { + "name": "Indranil Banerjee", + "bio": "AWS - Senior Solutions Architect", + "linkedin": "https://www.linkedin.com/in/indranil-banerjee-b00a261/" + }, + { + "name": "Vaibhav Jain", + "bio": "AWS - Sr. Application Architect", + "image": "https://media.licdn.com/dms/image/C4E03AQEqzZWHGT4dBQ/profile-displayphoto-shrink_800_800/0/1580165399872?e=1687392000&v=beta&t=zdxENLnqCpqCz9i1Uf5Yx4YXlR9EYvgxP8N5UTsy6J8", + "linkedin": "https://www.linkedin.com/in/vaibhavjainv/" + }, + { + "name": "Paveen Allam", + "bio": "Senior Solutions Architect", + "image": "https://www.fintail.me/images/pa.jpg", + "linkedin": "https://www.linkedin.com/in/pallam/" + }, + { + "name": "Suraj Tripathi", + "bio": "AWS - AppDev Cloud Consultant", + "linkedin": "https://www.linkedin.com/in/suraj-tripathi-01b49a140/" + }, + { + "name": "Adam Wagner", + "bio": "AWS - Principal Serverless Solutions Architect", + "linkedin": "https://www.linkedin.com/in/adam-wagner-4bb412/" + } + ] + } + \ No newline at end of file diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/.gitignore b/msk-lambda-iam-java-sam/kafka_event_consumer_function/.gitignore new file mode 100644 index 000000000..b83d22266 --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/.gitignore @@ -0,0 +1 @@ +/target/ diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/.settings/org.eclipse.jdt.core.prefs b/msk-lambda-iam-java-sam/kafka_event_consumer_function/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 000000000..2af1e7b99 --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,8 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=11 +org.eclipse.jdt.core.compiler.compliance=11 +org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled +org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning +org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore +org.eclipse.jdt.core.compiler.release=disabled +org.eclipse.jdt.core.compiler.source=11 diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/pom.xml b/msk-lambda-iam-java-sam/kafka_event_consumer_function/pom.xml new file mode 100644 index 000000000..ffd678ec0 --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/pom.xml @@ -0,0 +1,67 @@ + + 4.0.0 + com.amazonaws.services.lambda.samples.events.msk + MSKConsumer + 1.0 + jar + A sample Lambda MSK consumer + + 11 + 11 + + + + + com.amazonaws + aws-lambda-java-core + 1.2.1 + + + com.amazonaws + aws-lambda-java-events + 3.11.0 + + + com.google.code.gson + gson + 2.10.1 + + + + org.apache.kafka + kafka-clients + 3.4.0 + + + org.junit.jupiter + junit-jupiter-api + 5.6.0 + test + + + org.junit.jupiter + junit-jupiter-engine + 5.6.0 + test + + + + + + + org.apache.maven.plugins + maven-shade-plugin + 3.2.4 + + + + package + + shade + + + + + + + diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSK.java b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSK.java new file mode 100644 index 000000000..7e140a603 --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSK.java @@ -0,0 +1,110 @@ +//Lambda Runtime delivers a batch of messages to the lambda function +//Each batch of messages has two fields EventSource and EventSourceARN +//Each batch of messages also has a field called Records +//The Records is a map with multiple keys and values +//Each key is a combination of the Topic Name and the Partition Number +//One batch of messages can contain messages from multiple partitions + +/* +To simplify representing a batch of Kafka messages as a list of messages +We have created a Java class called KafkaMessage under the models package +Here we are mapping the structure of an incoming Kafka event to a list of +objects of the KafkaMessage class +*/ + +package com.amazonaws.services.lambda.samples.events.msk; + +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.LambdaLogger; +import com.amazonaws.services.lambda.runtime.RequestHandler; +import com.amazonaws.services.lambda.runtime.events.KafkaEvent; +import com.amazonaws.services.lambda.runtime.events.KafkaEvent.KafkaEventRecord; + +import java.util.ArrayList; +import java.util.Base64; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Set; +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; + +public class HandlerMSK implements RequestHandler{ + //We initialize an empty list of the KafkaMessage class + List listOfMessages = new ArrayList(); + Gson gson = new GsonBuilder().setPrettyPrinting().create(); + @Override + public String handleRequest(KafkaEvent event, Context context) { + LambdaLogger logger = context.getLogger(); + String response = new String("200 OK"); + this.listOfMessages = new ArrayList(); + //Incoming KafkaEvent object has a property called records that is a map + //Each key in the map is a combination of a topic and a partition + Map> record=event.getRecords(); + Set keySet = record.keySet(); + Iterator iterator = keySet.iterator(); + //We iterate through each of the keys in the map + while (iterator.hasNext()) { + String thisKey=(String)iterator.next(); + //Using the key we retrieve the value of the map which is a list of KafkaEventRecord + //One object of KafkaEventRecord represents an individual Kafka message + List thisListOfRecords = record.get(thisKey); + //We now iterate through the list of KafkaEventRecords + for(KafkaEventRecord thisRecord : thisListOfRecords) { + /* + We initialize a new object of the KafkaMessage class which is a simplified representation in our models package + We then get the fields from each kafka message in the object of KafkaEventRecord class and set them to the fields + of the KafkaRecord class + */ + KafkaMessage thisMessage = new KafkaMessage(); + thisMessage.setTopic(thisRecord.getTopic()); + thisMessage.setPartition(thisRecord.getPartition()); + thisMessage.setOffset(thisRecord.getOffset()); + thisMessage.setTimestamp(thisRecord.getTimestamp()); + thisMessage.setTimestampType(thisRecord.getTimestampType()); + String key = thisRecord.getKey(); + String value = thisRecord.getValue(); + String decodedKey = "null"; + String decodedValue = "null"; + //the key and value inside a kafka message are base64 encrypted and will need to be decrypted + if (null != key) { + byte[] decodedKeyBytes = Base64.getDecoder().decode(key); + decodedKey = new String(decodedKeyBytes); + } + if (null != value) { + byte[] decodedValueBytes = Base64.getDecoder().decode(value); + decodedValue = new String(decodedValueBytes); + } + thisMessage.setKey(key); + thisMessage.setValue(value); + thisMessage.setDecodedKey(decodedKey); + thisMessage.setDecodedValue(decodedValue); + //A kafka message can optionally have a list of headers + //the below code is to get the headers, iterate through each header and get its key and value + List headersInThisMessage = new ArrayList(); + List> headers = thisRecord.getHeaders(); + for (Map thisHeader : headers) { + Set thisHeaderKeys = thisHeader.keySet(); + Iterator thisHeaderKeysIterator = thisHeaderKeys.iterator(); + while (thisHeaderKeysIterator.hasNext()) { + String thisHeaderKey = thisHeaderKeysIterator.next(); + byte[] thisHeaderValue = (byte[])thisHeader.get(thisHeaderKey); + String thisHeaderValueString = new String(thisHeaderValue); + KafkaHeader thisMessageHeader = new KafkaHeader(); + thisMessageHeader.setKey(thisHeaderKey); + thisMessageHeader.setValue(thisHeaderValueString); + headersInThisMessage.add(thisMessageHeader); + } + } + thisMessage.setHeaders(headersInThisMessage); + listOfMessages.add(thisMessage); + // Below we are logging the particular kafka message in string format using the toString method + // as well as in Json format using gson.toJson function + logger.log("Received this message from Kafka - " + thisMessage.toString()); + logger.log("Message in JSON format : " + gson.toJson(thisMessage)); + } + } + logger.log("All Messages in this batch = " + gson.toJson(listOfMessages)); + return response; + } +} diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaHeader.java b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaHeader.java new file mode 100644 index 000000000..d093d05ee --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaHeader.java @@ -0,0 +1,67 @@ +package com.amazonaws.services.lambda.samples.events.msk; + +import java.util.Objects; + +public class KafkaHeader { + String key; + String value; + /** + * + */ + public KafkaHeader() { + super(); + } + /** + * @param key + * @param value + */ + public KafkaHeader(String key, String value) { + super(); + this.key = key; + this.value = value; + } + /** + * @return the key + */ + public String getKey() { + return key; + } + /** + * @param key the key to set + */ + public void setKey(String key) { + this.key = key; + } + /** + * @return the value + */ + public String getValue() { + return value; + } + /** + * @param value the value to set + */ + public void setValue(String value) { + this.value = value; + } + @Override + public int hashCode() { + return Objects.hash(key, value); + } + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + KafkaHeader other = (KafkaHeader) obj; + return Objects.equals(key, other.key) && Objects.equals(value, other.value); + } + @Override + public String toString() { + return "KafkaHeader [key=" + key + ", value=" + value + "]"; + } + +} diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaMessage.java b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaMessage.java new file mode 100644 index 000000000..98422a29f --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/main/java/com/amazonaws/services/lambda/samples/events/msk/KafkaMessage.java @@ -0,0 +1,198 @@ +package com.amazonaws.services.lambda.samples.events.msk; + +import java.util.List; +import java.util.Objects; + +public class KafkaMessage { + String topic; + int partition; + long offset; + long timestamp; + String timestampType; + String key; + String value; + String decodedKey; + String decodedValue; + List headers; + /** + * + */ + public KafkaMessage() { + super(); + } + /** + * @param topic + * @param partition + * @param offset + * @param timestamp + * @param timestampType + * @param key + * @param value + * @param decodedKey + * @param decodedValue + * @param headers + */ + public KafkaMessage(String topic, int partition, long offset, long timestamp, String timestampType, String key, String value, + String decodedKey, String decodedValue, List headers) { + super(); + this.topic = topic; + this.partition = partition; + this.offset = offset; + this.timestamp = timestamp; + this.timestampType = timestampType; + this.key = key; + this.value = value; + this.decodedKey = decodedKey; + this.decodedValue = decodedValue; + this.headers = headers; + } + /** + * @return the topic + */ + public String getTopic() { + return topic; + } + /** + * @param topic the topic to set + */ + public void setTopic(String topic) { + this.topic = topic; + } + /** + * @return the partition + */ + public int getPartition() { + return partition; + } + /** + * @param partition the partition to set + */ + public void setPartition(int partition) { + this.partition = partition; + } + /** + * @return the offset + */ + public long getOffset() { + return offset; + } + /** + * @param offset the offset to set + */ + public void setOffset(long offset) { + this.offset = offset; + } + /** + * @return the timestamp + */ + public long getTimestamp() { + return timestamp; + } + /** + * @param timestamp the timestamp to set + */ + public void setTimestamp(long timestamp) { + this.timestamp = timestamp; + } + /** + * @return the timestampType + */ + public String getTimestampType() { + return timestampType; + } + /** + * @param timestampType the timestampType to set + */ + public void setTimestampType(String timestampType) { + this.timestampType = timestampType; + } + /** + * @return the key + */ + public String getKey() { + return key; + } + /** + * @param key the key to set + */ + public void setKey(String key) { + this.key = key; + } + /** + * @return the value + */ + public String getValue() { + return value; + } + /** + * @param value the value to set + */ + public void setValue(String value) { + this.value = value; + } + /** + * @return the decodedKey + */ + public String getDecodedKey() { + return decodedKey; + } + /** + * @param decodedKey the decodedKey to set + */ + public void setDecodedKey(String decodedKey) { + this.decodedKey = decodedKey; + } + /** + * @return the decodedValue + */ + public String getDecodedValue() { + return decodedValue; + } + /** + * @param decodedValue the decodedValue to set + */ + public void setDecodedValue(String decodedValue) { + this.decodedValue = decodedValue; + } + /** + * @return the headers + */ + public List getHeaders() { + return headers; + } + /** + * @param headers the headers to set + */ + public void setHeaders(List headers) { + this.headers = headers; + } + + @Override + public int hashCode() { + return Objects.hash(decodedKey, decodedValue, headers, key, offset, partition, timestamp, timestampType, topic, + value); + } + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + KafkaMessage other = (KafkaMessage) obj; + return Objects.equals(decodedKey, other.decodedKey) && Objects.equals(decodedValue, other.decodedValue) + && Objects.equals(headers, other.headers) && Objects.equals(key, other.key) && offset == other.offset + && partition == other.partition && timestamp == other.timestamp + && Objects.equals(timestampType, other.timestampType) && Objects.equals(topic, other.topic) + && Objects.equals(value, other.value); + } + @Override + public String toString() { + return "KafkaMessage [topic=" + topic + ", partition=" + partition + ", timestamp=" + timestamp + + ", timestampType=" + timestampType + ", key=" + key + ", value=" + value + ", decodedKey=" + + decodedKey + ", decodedValue=" + decodedValue + ", headers=" + headers.toString() + "]"; + } + + +} diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSKTest.java b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSKTest.java new file mode 100644 index 000000000..65bd543d3 --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/HandlerMSKTest.java @@ -0,0 +1,70 @@ +package com.amazonaws.services.lambda.samples.events.msk; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import org.junit.jupiter.api.Test; + +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.events.KafkaEvent; +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; + + +class HandlerMSKTest { + private static final String kafkaEventJson = "{\n" + + " \"records\":{\n" + + " \"myTopic-0\":[\n" + + " {\n" + + " \"topic\":\"myTopic\",\n" + + " \"partition\":0,\n" + + " \"offset\":250,\n" + + " \"timestamp\":1678072110111,\n" + + " \"timestampType\":\"CREATE_TIME\",\n" + + " \"value\":\"Zg==\",\n" + + " \"headers\":[\n" + + " \n" + + " ]\n" + + " },\n" + + " {\n" + + " \"topic\":\"myTopic\",\n" + + " \"partition\":0,\n" + + " \"offset\":251,\n" + + " \"timestamp\":1678072111086,\n" + + " \"timestampType\":\"CREATE_TIME\",\n" + + " \"value\":\"Zw==\",\n" + + " \"headers\":[\n" + + " \n" + + " ]\n" + + " }\n" + + " ]\n" + + " },\n" + + " \"eventSource\":\"aws:kafka\",\n" + + " \"eventSourceArn\":\"arn:aws:kafka:us-west-2:123456789012:cluster/MSKWorkshopCluster/a93759a9-c9d0-4952-984c-492c6bfa2be8-13\",\n" + + " \"bootstrapServers\":\"b-2.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098,b-3.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098,b-1.mskworkshopcluster.z9kc4f.c13.kafka.us-west-2.amazonaws.com:9098\"\n" + + "}"; + + @Test + void invokeTest() { + Gson gson = new GsonBuilder().setPrettyPrinting().create(); + KafkaEvent event = gson.fromJson(kafkaEventJson, KafkaEvent.class); + Context context = new TestContext(); + HandlerMSK handler = new HandlerMSK(); + String result = handler.handleRequest(event, context); + assertEquals(result, "200 OK"); + assertEquals(handler.listOfMessages.size(), 2); + assertEquals(handler.listOfMessages.get(0).getTopic(), "myTopic"); + assertEquals(handler.listOfMessages.get(0).getPartition(), 0); + assertEquals(handler.listOfMessages.get(0).getOffset(), 250L); + assertEquals(handler.listOfMessages.get(0).getTimestamp(), 1678072110111L); + assertEquals(handler.listOfMessages.get(0).getTimestampType(), "CREATE_TIME"); + assertEquals(handler.listOfMessages.get(0).getDecodedKey(), "null"); + assertEquals(handler.listOfMessages.get(0).getDecodedValue(), "f"); + assertEquals(handler.listOfMessages.get(1).getTopic(), "myTopic"); + assertEquals(handler.listOfMessages.get(1).getPartition(), 0); + assertEquals(handler.listOfMessages.get(1).getOffset(), 251L); + assertEquals(handler.listOfMessages.get(1).getTimestamp(), 1678072111086L); + assertEquals(handler.listOfMessages.get(1).getTimestampType(), "CREATE_TIME"); + assertEquals(handler.listOfMessages.get(1).getDecodedKey(), "null"); + assertEquals(handler.listOfMessages.get(1).getDecodedValue(), "g"); + } +} diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestContext.java b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestContext.java new file mode 100644 index 000000000..479a3b98a --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestContext.java @@ -0,0 +1,45 @@ +package com.amazonaws.services.lambda.samples.events.msk; + +import com.amazonaws.services.lambda.runtime.Context; +import com.amazonaws.services.lambda.runtime.CognitoIdentity; +import com.amazonaws.services.lambda.runtime.ClientContext; +import com.amazonaws.services.lambda.runtime.LambdaLogger; + +public class TestContext implements Context{ + + public TestContext() {} + public String getAwsRequestId(){ + return new String("495b12a8-xmpl-4eca-8168-160484189f99"); + } + public String getLogGroupName(){ + return new String("/aws/lambda/my-function"); + } + public String getLogStreamName(){ + return new String("2020/02/26/[$LATEST]704f8dxmpla04097b9134246b8438f1a"); + } + public String getFunctionName(){ + return new String("my-function"); + } + public String getFunctionVersion(){ + return new String("$LATEST"); + } + public String getInvokedFunctionArn(){ + return new String("arn:aws:lambda:us-east-2:123456789012:function:my-function"); + } + public CognitoIdentity getIdentity(){ + return null; + } + public ClientContext getClientContext(){ + return null; + } + public int getRemainingTimeInMillis(){ + return 300000; + } + public int getMemoryLimitInMB(){ + return 512; + } + public LambdaLogger getLogger(){ + return new TestLogger(); + } + +} \ No newline at end of file diff --git a/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestLogger.java b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestLogger.java new file mode 100644 index 000000000..0fb16cdc6 --- /dev/null +++ b/msk-lambda-iam-java-sam/kafka_event_consumer_function/src/test/java/com/amazonaws/services/lambda/samples/events/msk/TestLogger.java @@ -0,0 +1,14 @@ +package com.amazonaws.services.lambda.samples.events.msk; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import com.amazonaws.services.lambda.runtime.LambdaLogger; + +public class TestLogger implements LambdaLogger { + private static final Logger logger = LoggerFactory.getLogger(TestLogger.class); + public void log(String message){ + logger.info(message); + } + public void log(byte[] message){ + logger.info(new String(message)); + } +} diff --git a/msk-lambda-iam-java-sam/template.yaml b/msk-lambda-iam-java-sam/template.yaml new file mode 100644 index 000000000..e0da4f901 --- /dev/null +++ b/msk-lambda-iam-java-sam/template.yaml @@ -0,0 +1,87 @@ +AWSTemplateFormatVersion: '2010-09-09' +Transform: AWS::Serverless-2016-10-31 +Description: > + kafka_event_consumer_function + + Sample SAM Template for simple-kafka-consumer-with-sam + +# More info about Globals: https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst +Globals: + Function: + Timeout: 15 + +Resources: + LambdaMSKConsumerJavaFunction: + Type: AWS::Serverless::Function # More info about Function Resource: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction + Properties: + CodeUri: kafka_event_consumer_function + Handler: com.amazonaws.services.lambda.samples.events.msk.HandlerMSK::handleRequest + Runtime: java11 + Architectures: + - x86_64 + MemorySize: 512 + Environment: # More info about Env Vars: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#environment-object + Variables: + PARAM1: VALUE + JAVA_TOOL_OPTIONS: -XX:+TieredCompilation -XX:TieredStopAtLevel=1 # More info about tiered compilation https://aws.amazon.com/blogs/compute/optimizing-aws-lambda-function-performance-for-java/ + Events: + MSKEvent: + Type: MSK + Properties: + StartingPosition: LATEST + BatchSize: 10 + MaximumBatchingWindowInSeconds: 300 + Stream: !Join [ '', ["arn:", "aws:", "kafka:", !Ref "AWS::Region" , ":" ,!Ref "AWS::AccountId", ":", "cluster/", !Ref MSKClusterName, "/" , !Ref MSKClusterId] ] + Topics: + - !Ref MSKTopic + Policies: + - Statement: + - Sid: KafkaClusterPermissionsPolicy + Effect: Allow + Action: + - kafka-cluster:Connect + - kafka-cluster:DescribeGroup + - kafka-cluster:DescribeCluster + - kafka-cluster:AlterCluster + - kafka-cluster:AlterClusterDynamicConfiguration + - kafka-cluster:WriteDataIdempotently + - kafka-cluster:AlterGroup + - kafka-cluster:DescribeTopic + - kafka-cluster:ReadData + - kafka-cluster:DescribeClusterDynamicConfiguration + Resource: + - !Join ['', ["arn:", "aws:", "kafka:", !Ref "AWS::Region", ":", !Ref "AWS::AccountId", ":", "cluster/", !Ref MSKClusterName, "/" , !Ref MSKClusterId]] + - !Join ['', ["arn:", "aws:", "kafka:", !Ref "AWS::Region", ":", !Ref "AWS::AccountId", ":", "topic/", !Ref MSKClusterName, "/" , !Ref MSKClusterId, "/*"]] + - !Join ['', ["arn:", "aws:", "kafka:", !Ref "AWS::Region", ":", !Ref "AWS::AccountId", ":", "group/", !Ref MSKClusterName, "/" , !Ref MSKClusterId, "/*"]] + + - Sid: KafkaPermissionsPolicy + Effect: Allow + Action: + - kafka:DescribeClusterV2 + - kafka:GetBootstrapBrokers + Resource: '*' + + - Sid: EC2PermissionsPolicy + Effect: Allow + Action: + - ec2:DescribeSecurityGroups + - ec2:DescribeSubnets + - ec2:DescribeVpcs + - ec2:CreateNetworkInterface + - ec2:DescribeNetworkInterfaces + - ec2:DeleteNetworkInterface + Resource: '*' +Parameters: + MSKClusterName: + Type: String + Description: Enter the name of the MSK Cluster + MSKClusterId: + Type: String + Description: Enter the ID of the MSK Cluster + MSKTopic: + Type: String + Description: Enter the name of the MSK Topic +Outputs: + HelloWorldKafkaJavaFunction: + Description: "Topic Consumer Lambda Function ARN" + Value: !GetAtt LambdaMSKConsumerJavaFunction.Arn