Merge pull request #13 from grishasergii/feature/enable-api-access-logs

Feature/enable api access logs

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.0
+current_version = 0.4.0
 commit = True
 tag = False
 tag_name = v{new_version}

VERSION

@@ -1 +1 @@
-version=0.3.0
+version=0.4.0

ci/deploy_api_gateway_stage.py

@@ -1,8 +1,16 @@
 import click
+import json
 
 from ci.external_cmd import ExternalCmd
 
 
+def _get_output_from_stack_description(stack_description, output_key):
+    for output in stack_description["Outputs"]:
+        if output["OutputKey"] == output_key:
+            return output["OutputValue"]
+    raise KeyError(f"{output_key} not found")
+
+
 @click.command()
 @click.option("--stack-name", help="Name of the stack")
 @click.option("--stage-name", help="Name of the api stage")
@@ -11,21 +19,45 @@ def deploy(stack_name, stage_name):
     stack_descriptions = ExternalCmd.run_and_parse_json(
         f"aws cloudformation describe-stacks --stack-name {stack_name}"
     )
-    api_id = None
-    stack_description = stack_descriptions["Stacks"][0]
-    for output in stack_description["Outputs"]:
-        if output["OutputKey"] == "RestApiId":
-            api_id = output["OutputValue"]
-            break
 
-    if not api_id:
-        raise click.ClickException("RestApiId not found in stack outputs")
+    stack_description = stack_descriptions["Stacks"][0]
+    api_id = _get_output_from_stack_description(stack_description, "RestApiId")
+    log_group_arn = _get_output_from_stack_description(stack_description, "ApiGatewayAccessLogGroupArn")
+    log_group_arn = log_group_arn.rstrip(":*")
 
     click.echo(f"API id is {api_id}")
     click.echo(f"Deploying {stage_name} stage...")
     ExternalCmd.run(
         f"aws apigateway create-deployment --rest-api-id {api_id} --stage-name {stage_name}"
     )
+    click.echo("Deployment done")
+
+    click.echo("Enabling access logging...")
+    operations = [
+        {
+            "op": "add",
+            "path": "/accessLogSettings/destinationArn",
+            "value": f"{log_group_arn}"
+        },
+        {
+            "op": "add",
+            "path": "/accessLogSettings/format",
+            "value": "{ \"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\" }"
+        },
+        {
+            "op": "replace",
+            "path": "/*/*/logging/loglevel",
+            "value": "INFO"
+        },
+        {
+            "op": "replace",
+            "path": "/*/*/logging/dataTrace",
+            "value": "true"
+        }
+    ]
+    ExternalCmd.run(
+        f"aws apigateway update-stage --rest-api-id {api_id} --stage-name {stage_name} --patch-operations '{json.dumps(operations)}'"
+    )
     click.echo("Done")
 
 

readme.md

@@ -1,5 +1,5 @@
 # Kyivmural API
 
-version 0.3.0
+version 0.4.0
 
 API component of kyivmural.com

templates/api-specification.yml

@@ -3,7 +3,7 @@ openapi: 3.0.1
 info:
   title: Kyivmural API
   description: Kyivmural API
-  version: 0.3.0
+  version: 0.4.0
 tags:
   - name: mural
     description: Operations about murals

templates/api.cfn

@@ -1,6 +1,6 @@
 ---
 AWSTemplateFormatVersion: 2010-09-09
-Description: Kyivmural API v0.3.0 - API
+Description: Kyivmural API v0.4.0 - API
 
 Parameters:
   Branch:

templates/backend.cfn

@@ -1,6 +1,6 @@
 ---
 AWSTemplateFormatVersion: 2010-09-09
-Description: Kyivmural API v0.3.0 - Backend
+Description: Kyivmural API v0.4.0 - Backend
 
 Parameters:
   MuralsTableName:

templates/database.cfn

@@ -1,6 +1,6 @@
 ---
 AWSTemplateFormatVersion: 2010-09-09
-Description: Kyivmural API v0.3.0 - Database
+Description: Kyivmural API v0.4.0 - Database
 
 Parameters:
   Branch:

templates/kyivmural-api.cfn

@@ -1,6 +1,6 @@
 ---
 AWSTemplateFormatVersion: "2010-09-09"
-Description: Kyivmural API v0.3.0
+Description: Kyivmural API v0.4.0
 
 Parameters:
   Branch: