AWS CloudTrail를 사용하여 AWS IoT OTA API 직접 호출 로깅

FreeRTOS는 AWS IoT OTA API 호출을 캡처하고 로그 파일을 사용자가 지정한 Amazon S3 버킷에 전달하는 서비스인 CloudTrail과 통합되어 있습니다. CloudTrail은 코드에서 AWS IoT OTA API로의 API 호출을 캡처합니다. CloudTrail에서 수집하는 정보를 사용하여 AWS IoT OTA에 어떤 요청이 이루어졌는지, 어떤 소스 IP 주소에서 요청했는지, 누가 언제 요청했는지 등을 확인할 수 있습니다.

이 서비스를 구성하고 사용하는 방법을 포함한 CloudTrail에 대한 자세한 내용은 AWS CloudTrail 사용 설명서를 참조하세요.

CloudTrail의 FreeRTOS 플랜 정보

AWS 계정에서 CloudTrail 로깅을 활성화하면 AWS IoT OTA 작업에 대한 API 호출이 CloudTrail 로그 파일에서 추적되어 다른 AWS 서비스 레코드와 함께 기록됩니다. CloudTrail은 기간 및 파일 크기를 기준으로 새 파일을 만들고 기록하는 시점을 결정합니다.

다음 AWS IoT OTA 컨트롤 플레인 작업은 CloudTrail에서 로그합니다.

모든 로그 항목은 누가 요청을 생성했는가에 대한 정보가 들어 있습니다. 로그 항목의 사용자 신원 정보를 이용하면 다음을 쉽게 판단할 수 있습니다.

자세한 내용은 CloudTrail userIdentity 요소를 참조하세요. AWS IoT OTA 작업은 AWS IoT OTA API 참조에 나와 있습니다.

원하는 기간만큼 Amazon S3 버킷에 로그 파일을 저장할 수 있습니다. 그러나 Amazon S3 수명 주기 규칙을 정의하여 자동으로 로그 파일을 보관하거나 삭제할 수도 있습니다. 기본적으로 로그 파일은 Amazon S3 서버 측 암호화(SSE)를 통해 암호화합니다.

로그 파일이 전송될 때 알림을 받으려면 Amazon SNS 알림을 게시하도록 CloudTrail을 구성할 수 있습니다. 자세한 내용은 CloudTrail용 Amazon SNS 알림 구성을 참조하세요.

또한 여러 AWS 리전 및 여러 AWS 계정의 AWS IoT OTA 로그 파일을 하나의 Amazon S3 버킷으로 통합할 수도 있습니다.

자세한 내용은 여러 리전에서 CloudTrail 로그 파일 받기와 여러 계정에서 CloudTrail 로그 파일 받기를 참조하세요.

FreeRTOS 로그 파일 항목 이해

CloudTrail 로그 파일에는 하나 이상의 로그 항목이 포함될 수 있습니다. 각 항목은 여러 개의 JSON 형식 이벤트를 표시합니다. 로그 항목은 어떤 소스로부터의 단일 요청을 나타내며 요청된 작업, 작업 날짜와 시간, 요청 파라미터 등에 대한 정보가 들어 있습니다. 로그 항목은 퍼블릭 API 직접 호출의 주문 스택 트레이스가 아니기 때문에 특정 순서로 표시되지 않습니다.

다음은 CreateOTAUpdate 작업 호출의 로그를 보여 주는 CloudTrail 로그 항목을 나타낸 예제입니다.

{
    "eventVersion": "1.05",
    "userIdentity": {
        "type": "IAMUser",
        "principalId": "EXAMPLE",
        "arn": "arn:aws:iam::your_aws_account:user/your_user_id",
        "accountId": "your_aws_account",
        "accessKeyId": "your_access_key_id",
        "userName": "your_username",
        "sessionContext": {
            "attributes": {
                "mfaAuthenticated": "false",
                "creationDate": "2018-08-23T17:27:08Z"
            }
        },
        "invokedBy": "apigateway.amazonaws.com"
    },
    "eventTime": "2018-08-23T17:27:19Z",
    "eventSource": "iot.amazonaws.com",
    "eventName": "CreateOTAUpdate",
    "awsRegion": "your_aws_region",
    "sourceIPAddress": "apigateway.amazonaws.com",
    "userAgent": "apigateway.amazonaws.com",
    "requestParameters": {
        "targets": [
            "arn:aws:iot:your_aws_region:your_aws_account:thing/Thing_CMH"
        ],
        "roleArn": "arn:aws:iam::your_aws_account:role/Role_FreeRTOSJob",
        "files": [
            {
                "fileName": "/sys/mcuflashimg.bin",
                "fileSource": {
                    "fileId": 0,
                    "streamId": "your_stream_id"
                },
                "codeSigning": {
                    "awsSignerJobId": "your_signer_job_id"
                }
            }
        ],
        "targetSelection": "SNAPSHOT",
        "otaUpdateId": "FreeRTOSJob_CMH-23-1535045232806-92"
    },
    "responseElements": {
        "otaUpdateArn": "arn:aws:iot:your_aws_region:your_aws_account:otaupdate/FreeRTOSJob_CMH-23-1535045232806-92",
        "otaUpdateStatus": "CREATE_PENDING",
        "otaUpdateId": "FreeRTOSJob_CMH-23-1535045232806-92"
    },
    "requestID": "c9649630-a6f9-11e8-8f9c-e1cf2d0c9d8e",
    "eventID": "ce9bf4d9-5770-4cee-acf4-0e5649b845c0",
    "eventType": "AwsApiCall",
    "recipientAccountId": "recipient_aws_account"
}