README.md

serverless-plugin-thundra-monitor-cw

This plugin is a serverless framework plugin which subscribes Thundra monitoring Lambda to the monitored functions' CloudWatch log groups for listening and sending monitor datas asynchronously.

Installation

Install the plugin via NPM:

npm install --save serverless-plugin-thundra-monitor-cw

Configuration

• thundraApiKey: Specifies your API key to be used for sending your monitor data to our side. This property is optional if the API key is configured at monitored Lambda function. Otherwise, it must be configured here. Monited Lambda function basis API key configuration overrides API key configuration here.
• thundraMonitorFunctionMemorySize: Configures the memory size in MB of the Lambda function which collects monitor data over CloudWatch. This property is optional. Default value is 512 MB.
• thundraMonitorFunctionTimeout: Configures the timeout in milliseconds of the Lambda function which collects monitor data over CloudWatch. This property is optional. Default value is 300 seconds (5 minutes).
• skipAllLogGroupCreations: Skips log group creations for all functions to be monitored. By default this plugin create log groups of monitored functions to subscribe them. But if the log group is already created without this plugin (by invocation or manually), log group creation should be skipped, otherwise you will get log group already exist error. This property is optional. Default value is false.

Example configuration:

custom:
  ...
  thundraApiKey: <my-api-key>
  ...

Usage

You need to mark your functions by setting thundraMonitoredOverCW flag to be monitored over AWS CloudWatch.

Example usage:

functions:
  my-function:
      ...
      thundraMonitoredOverCW: true
      ...
  ...    

• skipLogGroupCreation: Optionally log group creation for the specific function can be disabled by this flag.

Example usage:

functions:
  my-function:
      ...
      skipLogGroupCreation: true
      ...
  ...