Node.js로 Kinesis Client Library 소비자 개발

Kinesis Client Library(KCL)를 사용하여 Kinesis 데이터 스트림의 데이터를 처리하는 애플리케이션을 빌드합니다. Kinesis Client Library는 여러 언어로 제공됩니다. 이 주제에서는 Node.js에 대해 설명합니다.

KCL은 Java 라이브러리입니다. Java 이외의 언어에 대한 지원은 라는 다국어 인터페이스를 사용하여 제공됩니다. MultiLangDaemon 이 데몬은 Java 기반이며, Java 이외의 KCL 언어를 사용하는 경우 배경에서 실행됩니다. 따라서 Node.js 용 KCL을 설치하고 소비자 앱 전체를 Node.js 형식으로 작성하더라도 시스템에 Java를 설치해야 하는 이유는 다음과 같습니다. MultiLangDaemon 또한 사용 사례에 맞게 사용자 지정해야 할 몇 가지 기본 설정 (예: 연결 AWS 지역) 도 있습니다. MultiLangDaemon MultiLangDaemon GitHubon에 대한 자세한 내용은 KCL MultiLangDaemon 프로젝트 페이지를 참조하세요.

에서 GitHub Node.js KCL을 다운로드하려면 Kinesis 클라이언트 라이브러리 (Node.js) 로 이동하십시오.

샘플 코드 다운로드

Node.js KCL에 두 가지 코드 샘플을 사용할 수 있습니다.

• basic-sample

  Node.js로 KCL 소비자 애플리케이션을 빌드하기 위한 기초를 설명하기 위해 다음 섹션에서 사용됩니다.

• click-stream-sample

  기본 샘플 코드에 익숙해진 후에 실제 시나리오를 사용할 수 있는 약간 높은 수준의 코드입니다. 여기서는 이 샘플을 설명하지 않으며 자세한 내용은 README 파일에 있습니다.

Node.js로 KCL 소비자 애플리케이션을 구현할 때 다음 작업을 완료해야 합니다.

레코드 프로세서 구현

Node.js용 KCL을 사용하는 가능한 한 가장 단순한 소비자는 initialize, processRecords 및 shutdown 함수를 차례로 포함하는 recordProcessor 함수를 구현해야 합니다. 이 샘플에서는 시작점으로 사용할 수 있는 구현을 제공합니다(sample_kcl_app.js 참조).

function recordProcessor() {
  // return an object that implements initialize, processRecords and shutdown functions.}

초기화

레코드 프로세서가 시작되면 KCL은 initialize 함수를 직접적으로 호출합니다. 이 레코드 프로세서는 initializeInput.shardId로 전달된 샤드 ID만 처리하고 일반적으로 반대의 경우도 마찬가지입니다. 이 샤드는 해당 레코드 프로세서로만 처리됩니다. 하지만 소비자는 데이터 레코드가 두 번 이상 처리될 가능성을 고려해야 합니다. Kinesis Data Streams에서는 소비자의 워커가 샤드의 모든 데이터 레코드를 적어도 한 번은 처리한다는 적어도 한 번 의미론이 통용되기 때문입니다. 둘 이상의 작업자가 특정 샤드를 처리할 수 있는 경우에 대한 자세한 내용은 리샤딩, 크기 조정 및 병렬 처리를 참조하십시오.

initialize: function(initializeInput, completeCallback)

processRecords

KCL은 지정된 샤드에서 initialize 함수까지 데이터 레코드 목록을 포함하는 입력으로 이 함수를 직접적으로 호출합니다. 구현하는 레코드 프로세서가 소비자의 의미론에 따라 이 레코드의 데이터를 처리합니다. 예를 들어, 워커가 데이터를 전환한 후 그 결과를 Amazon Simple Storage Service(S3) 버킷에 저장할 수 있습니다.

processRecords: function(processRecordsInput, completeCallback)

데이터 자체뿐 아니라 작업자가 데이터를 처리할 때 사용할 수 있는 시퀀스 번호와 파티션 키도 데이터 레코드에 포함됩니다. 예를 들어, 작업자는 파티션 키의 값을 기반으로 데이터를 저장할 S3 버킷을 선택할 수 있습니다. record 딕셔너리가 레코드의 데이터, 시퀀스 번호 및 파티션 키에 액세스하기 위해 다음 키-값 페어를 노출합니다.

record.data
record.sequenceNumber
record.partitionKey

데이터가 Base64로 인코딩됩니다.

기본 샘플에서 processRecords 함수에는 작업자가 레코드의 데이터, 시퀀스 번호 및 파티션 키에 액세스하는 방법을 보여주는 코드가 있습니다.

Kinesis Data Streams는 샤드에서 이미 처리된 레코드를 추적하도록 레코드 프로세서에 요구합니다. KCL은 processRecordsInput.checkpointer로 전달된 checkpointer 객체를 통해 이 추적을 처리합니다. 레코드 프로세서는 checkpointer.checkpoint 함수를 직접적으로 호출하여 샤드의 레코드 처리가 얼마나 진행되었는지 KCL에 알려줍니다. 워커가 실패할 경우 KCL은 샤드 처리를 다시 시작할 때 마지막으로 처리된 레코드에서 계속되도록 이 정보를 사용합니다.

분할 또는 병합 작업의 경우 소스 샤드의 프로세서가 checkpoint를 직접적으로 호출하여 소스 샤드의 모든 처리가 완료되었다고 표시할 때까지 KCL은 새 샤드의 처리를 시작하지 않습니다.

checkpoint 함수에 시퀀스 번호를 전달하지 않으면 KCL은 checkpoint에 대한 호출이 레코드 프로세서에 전달된 마지막 레코드까지 모두 처리되었다는 의미로 간주합니다. 따라서 레코드 프로세서는 전달된 목록의 모든 레코드를 처리한 후에만 checkpoint를 직접적으로 호출해야 합니다. 레코드 프로세서는 checkpoint를 호출할 때마다 processRecords를 호출할 필요가 없습니다. 예를 들어, 프로세서는 세 번째 호출마다 checkpoint 또는 구현된 사용자 지정 검증/확인 서비스와 같은 레코드 프로세서 외부의 이벤트를 호출할 수 있습니다.

선택적으로 레코드의 정확한 시퀀스 번호를 checkpoint의 파라미터로 지정할 수도 있습니다. 이 경우 KCL은 모든 레코드가 해당 레코드까지만 처리되었다고 간주합니다.

기본 샘플 애플리케이션은 checkpointer.checkpoint 함수의 가장 단순하고 가능한 호출을 보여줍니다. 소비자에 필요한 다른 검사 로직을 함수의 이 지점에 추가할 수 있습니다.

shutdown

처리가 종료될 때(shutdownInput.reason이 TERMINATE) 또는 워커가 더 이상 응답하지 않을 때(shutdownInput.reason이 ZOMBIE) KCL은 shutdown 함수를 직접적으로 호출합니다.

shutdown: function(shutdownInput, completeCallback)

샤드 분할이나 병합 또는 스트림 삭제로 인해 레코드 프로세서가 샤드에서 추가 레코드를 수신하지 않으면 처리가 종료됩니다.

또한 KCL은 shutdownInput.checkpointer 객체를 shutdown에 전달합니다. 종료 이유가 TERMINATE이면 레코드 프로세서가 모든 데이터 레코드 처리를 완료했는지 확인하고 이 인터페이스의 checkpoint 함수를 호출해야 합니다.

구성 속성 수정

이 샘플은 구성 속성의 기본값을 제공합니다. 이 속성을 사용자의 값으로 재정의할 수 있습니다(기본 샘플의 sample.properties 참조).

애플리케이션 이름

KCL에는 애플리케이션 및 같은 리전의 Amazon DynamoDB 테이블에서 고유한 애플리케이션이 필요합니다. 다음과 같이 애플리케이션 이름 구성 값이 사용됩니다.

• 이 애플리케이션 이름과 관련된 모든 작업자는 동일한 스트림에서 함께 작업한다고 간주됩니다. 이 작업자는 여러 인스턴스에 분산되어 있을 수 있습니다. 동일한 애플리케이션 코드의 추가 인스턴스를 다른 애플리케이션 이름으로 실행하는 경우 KCL은 두 번째 인스턴스를 동일한 스트림에서 작동하는 완전히 별개의 애플리케이션으로 취급합니다.

• KCL은 애플리케이션 이름이 있는 DynamoDB 테이블을 생성하고 테이블을 사용하여 애플리케이션의 상태 정보(예: 체크포인트 및 워커와 샤드의 매핑)를 보관합니다. 각각의 애플리케이션에는 자체 DynamoDB 테이블이 있습니다. 자세한 정보는 리스 테이블을 사용하여 KCL 소비자 애플리케이션에서 처리한 샤드 추적을 참조하세요.

자격 증명 설정

기본 자격 증명 공급자 체인의 AWS 자격 증명 공급자 중 한 곳에서 자격 증명을 사용할 수 있도록 해야 합니다. AWSCredentialsProvider 속성을 사용하여 자격 증명 공급자를 설정할 수 있습니다. sample.properties 파일에서 기본 자격 증명 공급자 체인의 자격 증명 공급자 중 하나에 자격 증명을 사용할 수 있도록 해야 합니다. Amazon EC2 인스턴스에서 소비자를 실행하는 경우 IAM 역할을 사용하여 인스턴스를 구성하는 것이 좋습니다. AWS 이 IAM 역할과 관련된 권한을 반영하는 자격 증명은 인스턴스 메타데이터를 통해 인스턴스의 애플리케이션에 제공됩니다. 이것이 EC2 인스턴스에서 실행되는 소비자 애플리케이션의 자격 증명을 관리하는 가장 안전한 방법입니다.

다음 예제는 sample_kcl_app.js에 제공된 레코드 프로세서를 사용하여 kclnodejssample이라는 Kinesis 데이터 스트림을 처리하도록 KCL을 구성합니다.

# The Node.js executable script
executableName = node sample_kcl_app.js
# The name of an Amazon Kinesis stream to process
streamName = kclnodejssample
# Unique KCL application name
applicationName = kclnodejssample
# Use default AWS credentials provider chain
AWSCredentialsProvider = DefaultAWSCredentialsProviderChain
# Read from the beginning of the stream
initialPositionInStream = TRIM_HORIZON