Update to change API Gateway CloudWatch log from XML to JSON

Canadian-Geospatial-Platform/semantic-search-with-amazon-opensearch#8
Canadian-Geospatial-Platform · Jan 28, 2025 · 7c4473f · 7c4473f
1 parent deba4f2
commit 7c4473f
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 3 deletions.
diff --git a/docs/cloudformation/geocore-semantic-search-with-opensearch.yml b/docs/cloudformation/geocore-semantic-search-with-opensearch.yml
@@ -146,6 +146,10 @@ Resources:
       Environment:
         Variables:
           OSEndpoint: !Ref OSEndpoint
+          MODEL_NAME: !If 
+            - IsProd
+            - minilm-knn
+            - minilm-pretrain-knn
       Code:
         ZipFile: |
           import json
@@ -482,7 +486,25 @@ Resources:
       Name: search-opensearch
       AccessLogSetting:
         DestinationArn: !GetAtt LogGroup.Arn
-        Format: '<request id="$context.requestId"> <ip>$context.identity.sourceIp</ip> <caller>$context.identity.caller</caller> <user>$context.identity.user</user> <requestTime>$context.requestTime</requestTime> <httpMethod>$context.httpMethod</httpMethod> <resourcePath>$context.resourcePath</resourcePath> <status>$context.status</status> <protocol>$context.protocol</protocol> <responseLength>$context.responseLength</responseLength><errorMessage>$context.error.message</errorMessage></request>'
+        Format: >-
+          {
+            "requestId": "$context.requestId",
+            "ip": "$context.identity.sourceIp",
+            "caller": "$context.identity.caller",
+            "user": "$context.identity.user",
+            "requestTime": "$context.requestTime",
+            "httpMethod": "$context.httpMethod",
+            "resourcePath": "$context.resourcePath",
+            "status": "$context.status",
+            "protocol": "$context.protocol",
+            "responseLength": "$context.responseLength",
+            "errorMessage": "$context.error.message",
+            "integrationLatency": "$context.integrationLatency",
+            "apiId": "$context.apiId",
+            "stage": "$context.stage",
+            "latency": "$context.latency",
+            "userAgent": "$context.identity.userAgent"
+          }
       EndpointConfiguration:
         Type: REGIONAL
       OpenApiVersion: '2.0'
@@ -538,7 +560,8 @@ Resources:
                       "sort": "$input.params('sort')",
                       "order": "$input.params('order')",
                       "size": "$input.params('size')",
-                      "from": "$input.params('from')"
+                      "from": "$input.params('from')",
+                      "userAgent": "$input.params().header.get('User-Agent')"
                     }
             options:
               consumes:

diff --git a/docs/cloudformation/geolocator-web-presence.yml b/docs/cloudformation/geolocator-web-presence.yml
@@ -194,7 +194,24 @@ Resources:
       Name: geolocator
       AccessLogSetting:
         DestinationArn: !GetAtt LogGroup.Arn
-        Format: '<request id="$context.requestId"> <ip>$context.identity.sourceIp</ip> <caller>$context.identity.caller</caller> <user>$context.identity.user</user> <requestTime>$context.requestTime</requestTime> <httpMethod>$context.httpMethod</httpMethod> <resourcePath>$context.resourcePath</resourcePath> <status>$context.status</status> <protocol>$context.protocol</protocol> <responseLength>$context.responseLength</responseLength><errorMessage>$context.error.message</errorMessage></request>'
+        Format: >-
+          {
+            "requestId": "$context.requestId",
+            "ip": "$context.identity.sourceIp",
+            "caller": "$context.identity.caller",
+            "user": "$context.identity.user",
+            "requestTime": "$context.requestTime",
+            "httpMethod": "$context.httpMethod",
+            "resourcePath": "$context.resourcePath",
+            "status": "$context.status",
+            "protocol": "$context.protocol",
+            "responseLength": "$context.responseLength",
+            "errorMessage": "$context.error.message",
+            "integrationLatency": "$context.integrationLatency",
+            "apiId": "$context.apiId",
+            "stage": "$context.stage",
+            "latency": "$context.latency"
+          }
       EndpointConfiguration:
         Type: REGIONAL
       OpenApiVersion: '2.0'