JSPM

serverless-cloudwatch-logs-insights-plugin

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 144
  • Score
    100M100P100Q82879F
  • License ISC

Serverless Framework plugin to generate CloudWatch Logs Insights queries for all Lambda Functions

Package Exports

  • serverless-cloudwatch-logs-insights-plugin
  • serverless-cloudwatch-logs-insights-plugin/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serverless-cloudwatch-logs-insights-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Serverless CloudWatch Logs Insights Plugin

CI npm npm

This Serverless Framework plugin automatically creates CloudWatch Logs Insights queries for all Lambda functions in your service.

Installation

Install the plugin as a dev dependency in your Serverless project:

npm install --save-dev serverless-cloudwatch-logs-insights-plugin

Usage

Add the plugin to your serverless.yml file:

plugins:
  - serverless-cloudwatch-logs-insights-plugin

Configure your queries in the custom section of your serverless.yml:

custom:
  cloudwatchLogsInsights:
    queries:
      - name: "ErrorLogs"
        query: "fields @timestamp, @message | filter @message like /ERROR/ | sort @timestamp desc | limit 20"
      - name: "WarningLogs"
        query: "fields @timestamp, @message | filter @message like /WARNING/ | sort @timestamp desc | limit 20"
      - name: "RecentLogs"
        query: "fields @timestamp, @message | sort @timestamp desc | limit 50"

Configuration

The plugin configuration is placed under the custom.cloudwatchLogsInsights key in your serverless.yml file.

Options

  • queries: An array of query definitions. Each query definition should have:
    • name: A unique name for the query (required). You can use forward slashes to create folder structure for your queries. For example, folder-name/query-name.
    • query: The CloudWatch Logs Insights query string (required). For example: fields @timestamp, @message | filter @message like /ERROR/ | sort @timestamp desc | limit 20

How It Works

  1. The plugin collects all Lambda functions defined in your Serverless service.
  2. It creates a CloudFormation resource of type AWS::CloudWatch::QueryDefinition for each configured query.
  3. Each query includes all Lambda function log groups.

Example

Here's a full example of a serverless.yml file using this plugin:

service: my-service

plugins:
  - serverless-cloudwatch-logs-insights-plugin

provider:
  name: aws
  runtime: nodejs14.x

functions:
  hello:
    handler: handler.hello
  world:
    handler: handler.world

custom:
  cloudwatchLogsInsights:
    queries:
      - name: "ErrorLogs"
        query: "fields @timestamp, @message | filter @message like /ERROR/ | sort @timestamp desc | limit 20"
      - name: "WarningLogs"
        query: "fields @timestamp, @message | filter @message like /WARNING/ | sort @timestamp desc | limit 20"
      - name: "RecentLogs"
        query: "fields @timestamp, @message | sort @timestamp desc | limit 50"

This configuration will create three CloudWatch Logs Insights queries, each including both the hello and world function log groups.

TODO

  • Add templates for common queries like ErrorLogs and other common queries
custom:
  cloudwatchLogsInsights:
    queries:
      - name: "ErrorLogs"
        template: "QueryErrors" # in this case "query" is omitted
        limit: 20
        fields: "@message, @timestamp"
  • Add support for including or excluding functions / log groups

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.