[typescript] 타입스크립트를 사용하여 AWS SDK로 API Gateway 사용량 및 로깅 모니터링하기

26 Dec 2023

typescript

AWS API Gateway는 클라이언트 애플리케이션이나 웹사이트에서 AWS 서비스로의 연결을 관리하는데 사용되는 서비스입니다. 이 서비스를 효과적으로 모니터링하기 위해서는 API Gateway의 사용량 및 로깅을 추적해야 합니다. 타입스크립트를 사용하여 AWS SDK를 통해 API Gateway 사용량 및 로깅을 모니터링하는 방법을 다루겠습니다.

사용량 모니터링

API Gateway 사용량 모니터링을 위해 AWS.CloudWatch 모듈을 사용합니다. 타입스크립트에서는 다음과 같이 사용할 수 있습니다.

import AWS from 'aws-sdk';

const cloudwatch = new AWS.CloudWatch();

const params = {
  MetricData: [
    {
      MetricName: 'Count',
      Dimensions: [
        {
          Name: 'ApiName',
          Value: 'yourApiName'
        },
      ],
      Unit: 'Count',
      Value: 1.0
    },
  ],
  Namespace: 'AWS/ApiGateway'
};

cloudwatch.putMetricData(params, (err, data) => {
  if (err) {
    console.error(err, err.stack);
  } else {
    console.log(data);
  }
});

이 코드는 CloudWatch에 API Gateway 사용량을 보내는 예시입니다. yourApiName은 사용자의 API 이름으로 변경되어야 합니다.

로깅 모니터링

API Gateway 로깅을 모니터링하기 위해 AWS.CloudWatchLogs 모듈을 사용합니다. 타입스크립트에서는 다음과 같이 사용할 수 있습니다.

import AWS from 'aws-sdk';

const cloudwatchlogs = new AWS.CloudWatchLogs();

const params = {
  logGroupName: '/aws/api-gateway/yourApiName',
};

cloudwatchlogs.describeLogStreams(params, (err, data) => {
  if (err) {
    console.error(err, err.stack);
  } else {
    console.log(data);
  }
});

이 코드는 API Gateway에서 로그 스트림을 가져오는 예시입니다. yourApiName은 사용자의 API 이름으로 변경되어야 합니다.

위의 코드를 사용하여 API Gateway의 사용량과 로깅을 모니터링할 수 있습니다. 타입스크립트의 강력한 타입 시스템과 AWS SDK의 풍부한 기능을 통해 모니터링 및 분석을 효율적으로 수행할 수 있습니다.

참고 자료

이제, 타입스크립트를 사용하여 API Gateway의 사용량 및 로깅을 모니터링하는 방법에 대해 알아보았습니다. AWS SDK를 통해 CloudWatch를 이용하여 API Gateway를 모니터링하는 방법에 대해 더 자세히 공부하고, 실제 서비스에 적용해 보시기 바랍니다.