#115 - Turn on API Gateway Access Logs

formkiq · Feb 16, 2023 · 42037cf · 42037cf
1 parent ed8ad3a
commit 42037cf
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 1 deletion.
diff --git a/lambda-api/src/main/resources/cloudformation/template-snippet.yaml b/lambda-api/src/main/resources/cloudformation/template-snippet.yaml
@@ -197,6 +197,20 @@ Resources:
         Ref: DocumentsApiRequests
       Principal: apigateway.amazonaws.com
 
+  DocumentsStageAccessLogs:
+    Type: AWS::Logs::LogGroup
+    Properties:
+      RetentionInDays: 90
+      LogGroupName: 
+        Fn::Sub: "/${AWS::StackName}/APIDocumentsHttpAccessLogs"
+
+  IamDocumentsStageAccessLogs:
+    Type: AWS::Logs::LogGroup
+    Properties:
+      RetentionInDays: 90
+      LogGroupName: 
+        Fn::Sub: "/${AWS::StackName}/APIDocumentsIamAccessLogs"
+
   DocumentsStage:
     Type: AWS::ApiGatewayV2::Stage
     Properties:
@@ -206,6 +220,12 @@ Resources:
       Description: 
         Fn::Sub: "Documents API ${AppEnvironment}"
       StageName: "$default"
+      AccessLogSettings:
+        DestinationArn: 
+          Fn::GetAtt: 
+          - DocumentsStageAccessLogs
+          - Arn
+        Format: '{ "requestId":"$context.requestId", "ip": "$context.identity.sourceIp", "requestTime":"$context.requestTime", "httpMethod":"$context.httpMethod","routeKey":"$context.routeKey", "status":"$context.status","protocol":"$context.protocol", "integrationStatus": $context.integrationStatus, "integrationLatency": $context.integrationLatency, "responseLength":"$context.responseLength" }'
 
   IamDocumentsStage:
     Type: AWS::ApiGatewayV2::Stage
@@ -216,6 +236,13 @@ Resources:
       Description: 
         Fn::Sub: "Documents IAM API ${AppEnvironment}"
       StageName: "$default"
+      AccessLogSettings:
+        DestinationArn: 
+          Fn::GetAtt: 
+          - IamDocumentsStageAccessLogs
+          - Arn
+        Format: '{ "requestId":"$context.requestId", "ip": "$context.identity.sourceIp", "requestTime":"$context.requestTime", "httpMethod":"$context.httpMethod","routeKey":"$context.routeKey", "status":"$context.status","protocol":"$context.protocol", "integrationStatus": $context.integrationStatus, "integrationLatency": $context.integrationLatency, "responseLength":"$context.responseLength" }'
+
 
   DocumentsHttpApiUrlParameter:
     Type: AWS::SSM::Parameter

diff --git a/lambda-typesense/src/main/resources/cloudformation/typesense/template.yaml b/lambda-typesense/src/main/resources/cloudformation/typesense/template.yaml
@@ -485,6 +485,13 @@ Resources:
           - Arn
       PayloadFormatVersion: "1.0"
 
+  StageAccessLogs:
+    Type: AWS::Logs::LogGroup
+    Properties:
+      RetentionInDays: 90
+      LogGroupName: 
+        Fn::Sub: "/${AWS::StackName}/APITypeSenseAccessLogs"
+
   Stage:
     Type: AWS::ApiGatewayV2::Stage
     Condition: CreateResources
@@ -493,6 +500,12 @@ Resources:
         Ref: ApiGateway
       StageName: $default
       AutoDeploy: true
+      AccessLogSettings:
+        DestinationArn: 
+          Fn::GetAtt: 
+          - StageAccessLogs
+          - Arn
+        Format: '{ "requestId":"$context.requestId", "ip": "$context.identity.sourceIp", "requestTime":"$context.requestTime", "httpMethod":"$context.httpMethod","routeKey":"$context.routeKey", "status":"$context.status","protocol":"$context.protocol", "integrationStatus": $context.integrationStatus, "integrationLatency": $context.integrationLatency, "responseLength":"$context.responseLength" }'
 
   Route:
     Type: AWS::ApiGatewayV2::Route

diff --git a/websocket-api/src/main/resources/cloudformation/template-sar.yaml b/websocket-api/src/main/resources/cloudformation/template-sar.yaml
@@ -98,7 +98,14 @@ Resources:
     Properties:
       ApiId: 
         Ref: WebSocketApi
-
+
+  StageAccessLogs:
+    Type: AWS::Logs::LogGroup
+    Properties:
+      RetentionInDays: 90
+      LogGroupName: 
+        Fn::Sub: "/${AWS::StackName}/APIWebsocketAccessLogs"
+
   Stage:
     Type: AWS::ApiGatewayV2::Stage
     Properties:
@@ -109,6 +116,12 @@ Resources:
         Ref: Deployment
       ApiId: 
         Ref: WebSocketApi
+      AccessLogSettings:
+        DestinationArn: 
+          Fn::GetAtt: 
+          - StageAccessLogs
+          - Arn
+        Format: '{ "requestId":"$context.requestId", "ip": "$context.identity.sourceIp", "requestTime":"$context.requestTime", "httpMethod":"$context.httpMethod","routeKey":"$context.routeKey", "status":"$context.status","protocol":"$context.protocol", "integrationStatus": $context.integrationStatus, "integrationLatency": $context.integrationLatency, "responseLength":"$context.responseLength" }'
       Tags:
         Application: 
           Fn::Sub: "FormKiQ ${FormKiQType}"