Serverless-application-model: SAM Template AWS API GW logging.

[senthil-nathan]

I am using SAM Template to create API GW that would hook to a lambda function. Is there a way that I can specify the logs to be enabled for the stages ? Right now after the deploy I need to manually enable logs in the UI which is bit annoying.

[anotherhobby]

We are looking for this same functionality.

[terodox]

This is a miss from my perspective. Every deployment actually disables logging even if it was previously enabled.

Do we have any idea of a timeline for this to be addressed?

[sanathkr]

Makes sense. This is a popular feature ask. I will work to get this work prioritized.

[jonmcewen]

+1

[digitalfiz]

+1

[CrazyBS]

+1

[manikandanrs]

+1

[hasansaghir]

+1

[bradleyjames]

I've been told the only way to do this in an automated fashion via CFN is to not use SAM to define the API and stage. Feels like this violates the core tenet from CONTRIBUTING.md:

When defining your feature, keep in mind that one of the core tenets of AWS SAM is to keep it easy to use while allowing customers access to use more advanced components, should they so choose.

Access to more advanced components shouldn't be manual work in the console. This is more of a general comment but the more I use SAM, and the closer I get to production, the less I feel I can actually use it because it misses on simple things... like logging.

To ensure my deployments are repeatable I may just try to script this after my CFN templates are deployed.

[jfuss]

@bradleyjames We are aware this is currently painful and are currently working on this feature. However, it is stuck in some discussions on how to move forward on part of the design. We do not have a date yet, but will reply here once we have something to share.

Please be patient with us as we sort some things out internally.

[bradleyjames]

For anyone looking for a workaround I went ahead and scripted this. The template that creates the API outputs the ApiId at "AwsApiId".

...
Outputs:
  AwsApiId:
    Value: !Ref AwsApi
    Export:
      Name: !Sub ${AWS::StackName}-AwsApiId

After standing up the stack...

API_ID=`aws cloudformation describe-stacks --stack-name $STACK_NAME | jq '.Stacks[0].Outputs[] | select(.OutputKey == "AwsApiId") | .OutputValue' -r`

# http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-stage.html
aws apigateway update-stage --rest-api-id $API_ID --stage-name  $STAGE_NAME --patch-operations \
  op=replace,path=/*/*/logging/dataTrace,value=true \
  op=replace,path=/*/*/logging/loglevel,value=Info \
  op=replace,path=/*/*/metrics/enabled,value=true 

[s83]

@bradleyjames thank you for the workaround!

a little improvement, you can use --query to extract the API_ID

API_ID=$(aws cloudformation describe-stacks --stack-name $STACK_NAME --query 'Stacks[0].Outputs[?OutputKey==`AwsApiId`].OutputValue --output text)

[jfuss]

We created a parent task to track this. Please see #248 for updates.

Closing as duplicate of #248

[CGick]

To enable the CloudWatch Logs for AWS::Serverless::Api, you can set the LoggingLevel in the MethodSettings property.

Type: AWS::Serverless::Api
    Properties:
      MethodSettings:
        - LoggingLevel: INFO
          ResourcePath: '/*' # allows for logging on any resource
          HttpMethod: '*' # allows for logging on any method