Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@serverless/dashboard-plugin

serverless3.6mMIT7.2.3

The Serverless Dashboard plugin

readme

Serverless Framework Dashboard Plugin

Build Status npm version codecov

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)

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

7.2.3 (2024-03-01)

Bug Fixes

  • Need to check custom.enterprise for disableMonitoringSetup (#746) (ae5a64e)

7.2.2 (2024-02-29)

Features

Bug Fixes

7.2.1 (2024-02-28)

Features

7.2.0 (2023-11-16)

Bug Fixes

  • Bump platform-client version for axios (#737) (a0700f9)

7.1.0 (2023-10-20)

Features

  • Remove stackman dependency to enable use of the native Node solution (#734) (1b62a2a)

7.0.5 (2023-09-27)

Bug Fixes

  • Use clearer error message for credential resolution (#732) (1a17de3)

7.0.4 (2023-09-25)

Bug Fixes

  • Remove wrapped error logic that was breaking Dashboard V2 error reporting (#730) (4ae5260)

7.0.3 (2023-09-19)

7.0.2 (2023-09-16)

Bug Fixes

7.0.1 (2023-09-15)

Bug Fixes

  • Only setup monitoringIntegrationService when logged into dashboard (#723) (f0ad3ba)

7.0.0 (2023-09-15)

Features

  • Move dashboard onboarding into plugin (#720) (647b217)

Bug Fixes

  • MonitoringIntegrationService must be configured last in init (#721) (be2567f)

6.4.0 (2023-09-14)

Features

6.3.0 (2023-09-13)

Features

  • Add support to disable wrapping manually, automatically disable or ESM projects, and for python projects with 3.11 (#712) (287875f)

6.2.3 (2023-01-26)

Maintenance Improvements

6.2.2 (2022-04-20)

Maintenance Improvements

6.2.1 (2022-04-01)

Maintenance Improvements

6.2.0 (2022-03-24)

Features

Maintenance Improvements

6.1.6 (2022-03-18)

Bug Fixes

6.1.5 (2022-03-02)

Maintenance Improvements

6.1.4 (2022-03-01)

Maintenance Improvements

6.1.3 (2022-03-01)

Maintenance Improvements

6.1.2 (2022-02-25)

Bug Fixes

6.1.1 (2022-02-25)

Bug Fixes

Maintenance Improvements

6.1.0 (2022-02-18)

Features

Bug Fixes

Maintenance Improvements

6.0.0 (2022-01-27)

⚠ BREAKING CHANGES

  • Old Framework variables resolver is no longer supported
  • Deployment profile based params are no longer resolved
  • tenant will no longer be recognized. Use org instead
  • studio command is removed
  • Internal setup of dashboard related interactive CLI steps is removed
  • Node.js version 12 or later is required (dropped support for v10)

Features

Maintenance Improvements

5.5.4 (2022-01-19)

Maintenance Improvements

5.5.3 (2022-01-03)

Bug Fixes

5.5.2 (2021-12-27)

Bug Fixes

Maintenance Improvements

5.5.1 (2021-11-03)

Maintenance Improvements

5.5.0 (2021-10-19)

Features

Maintenance Improvements

5.4.8 (2021-10-15)

Maintenance Improvements

5.4.7 (2021-10-13)

Maintenance Improvements

5.4.6 (2021-10-08)

Maintenance Improvements

5.4.5 (2021-09-29)

Maintenance Improvements

5.4.4 (2021-08-25)

Bug Fixes

5.4.3 (2021-06-29)

Maintenance Improvements

5.4.2 (2021-06-23)

Maintenance Improvements

5.4.1 (2021-06-21)

Maintenance Improvements

5.4.0 (2021-06-16)

Features

Maintenance Improvements

  • Fix logging output for login/register interactive step (a294a6e)
  • Use confirm prompt in login/register question (f786583)

5.3.0 (2021-06-08)

Maintenance Improvements

5.2.0 (2021-06-02)

Features

Maintenance Improvements

5.1.4 (2021-05-27)

Maintenance Improvements

5.1.3 (2021-05-20)

Maintenance Improvements

5.1.2 (2021-05-19)

Bug Fixes

Maintenance Improvements

  • Pass through original error (caf4a7d)

5.1.1 (2021-05-19)

Bug Fixes

  • Ensure compatibility by always allowing to skip during org selection if context.history missing in interactive flow (#580) (9f3cc44) (Piotr Grzesik)

5.1.0 (2021-05-17)

Features

Maintenance Improvements

5.0.0 (2021-05-11)

⚠ BREAKING CHANGES

  • Rename from @serverless/enterprise-plugin to @serverless/dashboard-plugin
  • Unconditionally depend on serviceDir and configurationFilename as exposed by the Framework
  • Internals now depend unconditionally on CLI commands schemas configured in context of serverless package
  • CLI: Interactive CLI setup steps are not longer configured into lifecycle engine, but exposed as a standalone utils to be required directly by the Framework

Features

Bug Fixes

Maintenance Improvements

4.6.0 (2021-05-11)

Features

Bug Fixes

4.5.3 (2021-03-30)

Maintenance Improvements

4.5.2 (2021-03-19)

Maintenance Improvements

  • Recognize user_uid during login and register command and persist it in local config file (#555) (1fdf9ba) (Piotr Grzesik)

4.5.1 (2021-03-15)

Bug Fixes

Maintenance Improvements

4.5.0 (2021-03-04)

Features

Bug fixes

Maintenance

  • Drop dependency on @serverless/platform-sdk by replacing it with corresponding @serverless/platform-client methods (#546) (924360f) (Piotr Grzesik)

4.4.3 (2021-02-09)

Maintenance

4.4.2 (2021-01-07)

Bug Fixes

  • Update dependency on @serverless/platform-client to avoid security vulnerability of axios (#528) (d7b6ac8) (pgrzesik)

4.4.1 (2020-12-30)

Bug Fixes

4.4.0 (2020-12-30)

Features

Bug Fixes

4.3.0 (2020-12-15)

Bug Fixes

4.2.0 (2020-12-04)

Features

4.1.2 (2020-11-06)

Bug Fixes

4.1.1 (2020-10-15)

Bug Fixes

4.1.0 (2020-10-13)

Features

Bug Fixes

4.0.4 (2020-09-17)

Bug Fixes

4.0.3 (2020-09-16)

Bug Fixes

4.0.2 (2020-09-09)

Bug Fixes

4.0.1 (2020-09-03)

Bug Fixes

Maintanance improvements

4.0.0 (2020-08-28)

⚠ BREAKING CHANGES

  • At least Node.js v10 is required (dropped support for v6 and v8)
  • Safeguards validation functionality has been removed from the core.Use @serverless/safeguards plugin instead
  • dev command was removed (Use studio instead)

Features

Bug Fixes

3.8.4 (2020-09-09)

Bug Fixes

3.8.3 (2020-09-03)

Maintanance improvements

3.8.2 (2020-09-01)

Bug Fixes

3.8.1 (2020-08-28)

Bug Fixes

3.8.0 (2020-08-27)

Features

Bug Fixes

3.7.1 (2020-08-19)

Bug Fixes

3.7.0 (2020-08-03)

Features

3.6.18 (2020-07-27)

Bug Fixes

3.6.17 (2020-07-23)

Bug Fixes

  • Replace dependencies resolver with Node.js dedidated version (previous choice bundled various transpilers which attributed to significant increase in size of standalone bundle) (#453) (50d63a7) (Mariusz Nowak)

3.6.16 (2020-07-15)

Bug Fixes

  • Hide and deprecate dev command (53d68a6)
  • Upgrade @serverles/platform-client to v1 (6e78d23), which fixes issues with websocket connection handling when using sls studio

3.6.15 (2020-06-30)

Minor improvements

Bug fixes