feat: Make dashboard monitoring opt-out (#12138)

serverless · Sep 6, 2023 · 45cbd52 · 45cbd52
1 parent 66e3107
commit 45cbd52
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 6 deletions.
diff --git a/lib/config-schema.js b/lib/config-schema.js
@@ -15,7 +15,6 @@ const schema = {
      *  The default is `warn`, and will be set to `error` in v2
      */
     configValidationMode: { enum: ['error', 'warn', 'off'] },
-    monitor: { anyOf: [{ type: 'boolean' }] },
     // Deprecated
     console: { anyOf: [{ type: 'boolean' }, { type: 'object' }] },
     custom: {

diff --git a/lib/plugins/deploy.js b/lib/plugins/deploy.js
@@ -50,13 +50,21 @@ class Deploy {
           await this.serverless.pluginManager.spawn('package');
         }
 
-        if (this.serverless.configurationInput && this.serverless.configurationInput.org) {
+        if (
+          this.serverless.configurationInput &&
+          this.serverless.configurationInput.org &&
+          this.serverless.configurationInput.app
+        ) {
           await this.dashboard.configureIntegrationContext();
           await this.dashboard.ensureIntegrationIsConfigured();
         }
       },
       'after:deploy:deploy': async () => {
-        if (this.serverless.configurationInput && this.serverless.configurationInput.org) {
+        if (
+          this.serverless.configurationInput &&
+          this.serverless.configurationInput.org &&
+          this.serverless.configurationInput.app
+        ) {
           await this.dashboard.instrumentService();
         }
         return true;

diff --git a/lib/utils/serverless-dashboard.js b/lib/utils/serverless-dashboard.js
@@ -73,7 +73,8 @@ const DashboardService = (serverless, options) => {
     let startMessage = 'Disabling dashboard monitoring...';
     let successMessage = 'Dashboard monitoring is disabled';
     if (
-      serverless.configurationInput.monitor &&
+      serverless.configurationInput.org &&
+      serverless.configurationInput.app &&
       serverless.configurationInput.provider.name === 'aws'
     ) {
       mode = 'prod';
@@ -305,7 +306,13 @@ const DashboardService = (serverless, options) => {
    */
   const ensureIntegrationIsConfigured = async () => {
     // Do not run this if we have not generated context or we are not looking to set up the integration
-    if (Object.keys(context).length === 0 || !serverless.configurationInput.monitor) {
+    if (
+      Object.keys(context).length === 0 ||
+      !serverless.configurationInput.org ||
+      !serverless.configurationInput.app ||
+      (serverless.configurationInput.dashboard &&
+        serverless.configurationInput.dashboard.disableMonitoring)
+    ) {
       return false;
     } else if (
       context.integration &&
@@ -356,7 +363,7 @@ const DashboardService = (serverless, options) => {
       },
     });
     log.notice.success(
-      `Serverless Dashboard is integrating with your AWS account (one-time set-up).\n  An email will be sent upon completion, or view progress within the Dashboard:\n  ${dashboardFrontend}/${context.org.orgName}/settings`
+      `Serverless Dashboard is integrating with your AWS account (one-time set-up).\n  An email will be sent upon completion, or view progress within the Dashboard:\n  ${dashboardFrontend}/${context.org.orgName}/settings/integrations`
     );
     integrationSetupProgress.remove();
     context.integration.integrationInProgress = true;