serverless-plugin-thundra-monitor-cw v2.4.0

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.
• thundraMonitorFunctionName: Configures name of the Thundra monitoring Lambda function. This property is optional. Default value is thundra-monitor-cw-${serviceName} where ${serviceName} is the service name of your serverless deployment (service definition in the serverless.yml).
• thundraMonitorRoleName: Configures name of the role assigned to Thundra monitoring Lambda function. This property is optional. Default role name is generated by using Thundra monitoring Lambda function name and deployed AWS region by adding Role postfix.
• 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).
• skipLogGroupCreation: 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>
  thundraMonitorFunctionName: my-thundra-lambda-cw
  thundraMonitorRoleName: my-thundra-lambda-cw-role
  thundraMonitorFunctionMemorySize: 1536
  thundraMonitorFunctionTimeout: 100
  skipLogGroupCreation: true
  ...

Usage

By default all functions are monitored over AWS CloudWatch. If you want to exclude specific ones, you need to mark your functions by setting ignoredByThundra flag to true.

Example usage:

functions:
  my-function:
      ...
      ignoredByThundra: true
      ...
  ...    

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

Example usage:

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