@serverless/dashboard-plugin

What is @serverless/dashboard-plugin?

@serverless/dashboard-plugin is a plugin for the Serverless Framework that provides enhanced monitoring, troubleshooting, and management capabilities for serverless applications. It integrates with the Serverless Dashboard to offer real-time insights, alerts, and deployment tracking.

What are @serverless/dashboard-plugin's main functionalities?

Monitoring and Alerts

This feature allows you to set up monitoring and alerts for your serverless applications. The code sample demonstrates how to configure an alert for a high error rate.

module.exports = {
  service: 'my-service',
  frameworkVersion: '2',
  plugins: ['@serverless/dashboard-plugin'],
  custom: {
    dashboard: {
      org: 'my-org',
      app: 'my-app',
      alerts: [
        {
          name: 'High Error Rate',
          conditions: {
            errorRate: {
              threshold: 5,
              period: 300
            }
          }
        }
      ]
    }
  }
};

Deployment Tracking

This feature provides deployment tracking capabilities, allowing you to monitor the status and history of your deployments. The code sample shows the basic configuration needed to enable deployment tracking.

module.exports = {
  service: 'my-service',
  frameworkVersion: '2',
  plugins: ['@serverless/dashboard-plugin'],
  custom: {
    dashboard: {
      org: 'my-org',
      app: 'my-app'
    }
  }
};

Real-time Insights

This feature offers real-time insights into the performance and health of your serverless applications. The code sample demonstrates the basic setup to enable real-time insights.

module.exports = {
  service: 'my-service',
  frameworkVersion: '2',
  plugins: ['@serverless/dashboard-plugin'],
  custom: {
    dashboard: {
      org: 'my-org',
      app: 'my-app'
    }
  }
};

Other packages similar to @serverless/dashboard-plugin

serverless-plugin-datadog

The serverless-plugin-datadog package integrates Datadog with the Serverless Framework, providing monitoring, logging, and alerting capabilities. Compared to @serverless/dashboard-plugin, it offers more advanced integrations with Datadog's suite of tools but requires a Datadog account.

serverless-newrelic-lambda-layers

The serverless-newrelic-lambda-layers package integrates New Relic with the Serverless Framework, offering monitoring and observability for AWS Lambda functions. It provides similar functionalities to @serverless/dashboard-plugin but focuses on New Relic's observability platform.

serverless-plugin-splunk

The serverless-plugin-splunk package integrates Splunk with the Serverless Framework, enabling logging and monitoring for serverless applications. It offers similar capabilities to @serverless/dashboard-plugin but leverages Splunk's logging and monitoring services.

README

Serverless Framework Dashboard Plugin

To enable the various features of the Serverless Framework Dashboard for a particular Service you must deploy or redeploy that Service, using Serverless Framework open-source CLI version 1.45.1 or later.

Upon deployment, the Serverless Framwork Enteprise Plugin will automatically wrap and instrument your functions to work with the Serverless Framework Dashboard dashboard.

Dev notes

Install dependencies and build SDK JS

npm i
cd sdk-js
npm i
npm run build
cd -

Test

npm t
cd sdk-js
npm t
cd -

Integration tests

For integration tests run you need an access to integration dashboard organization, and generated for it access key.

Then tests can be run as:

SERVERLESS_ACCESS_KEY=xxx npm run integration-test

Release process

• Create a PR updating version in package.json
• Create a draft release on github with a change log
• Have it approved & merge (Release is automatically published via CI)