Serverless Gateway Logs

A plugin to update the API Gateway Logs/Tracing section for Serverless Framework.

Use Case

• This plugin can be used to update the API Gateway Logs/Tracing section - Access logs and Cloudwatch log options when external rest apiId is used in serverless apiGateway: restApiId: XXXXXXX restApiRootResourceId: XXXXX For the above use-case, this plugin can be used to update the above configuration

Install

Run npm install in your Serverless project.

$ npm install --save serverless-gateway-logs

Add the plugin to your serverless.yml file

plugins:
  - serverless-gateway-logs

Setup

custom:
  apiGatewayLogs:
    # noAccessLogs: true -- To be used if access logs configuration is not to be used
    # noCloudwatchLogs: true -- To be used if cloudwatch logs configuration is not to be used
    accessLogs:
        format: '{ "requestId":"$context.requestId" }' # Format of the access logs
        log-group: /aws/test-api/dev/access-logs # name of the cloudwatch log group to which access logs needs to be pushed - should always start with a '/'
        log-group-exists: true # true if log group is already present, no if its needs to be created
        log-group-retention: 14 # optional, default to 7
    cloudwatchLogs:
        log-level: 'OFF' # Values to be provided are 'ERROR','INFO','OFF' (To turn off cloudwatch logs, should use 'OFF')
        metricsEnabled: true # Enable/Disable Cloudwatch metrics
        fullLogsEnabled: true # Enable/Disable full request and response body 
    tracingEnabled: true # Enable/Disable X-Ray Tracing


## Usage

Run `sls deploy`, API Gateway cloudwatch and access logs configurations will be updated based on the options provided.