Add support for external API Gateway in the dashboards #215

README.md

@@ -490,6 +490,14 @@ dashboards:
     - default
 ```
 
+Using external API Gateway:
+```yaml
+alarms:
+  dashboards: true
+  dashboardConfig:
+    apiName: 'my-api-name-here'
+```
+
 ## License
 
 MIT © [A Cloud Guru](https://acloud.guru/)

src/dashboards/index.js

@@ -5,7 +5,14 @@ const dashboards = {
   vertical: require('./configs/vertical.json'),
 };
 
-const createDashboard = (service, stage, region, functions, name) => {
+const createDashboard = (
+  service,
+  stage,
+  region,
+  functions,
+  name,
+  dashboardConfig
+) => {
   const dashboard = dashboards[name];
 
   if (!dashboard) {
@@ -21,6 +28,7 @@ const createDashboard = (service, stage, region, functions, name) => {
       coordinates: w.coordinates,
       title: w.title,
       functions,
+      dashboardConfig,
     };
 
     return widget.createWidget(config);

src/dashboards/widgets/api-gw/latency/numbers.js

@@ -1,5 +1,7 @@
 const createWidget = (config) => {
-  const apiName = `${config.stage}-${config.service}`;
+  const apiName = config.dashboardConfig.apiName
+    ? config.dashboardConfig.apiName
+    : `${config.stage}-${config.service}`;
 
   const widget = {
     type: 'metric',

src/dashboards/widgets/api-gw/latency/time-series.js

@@ -1,5 +1,7 @@
 const createWidget = (config) => {
-  const apiName = `${config.stage}-${config.service}`;
+  const apiName = config.dashboardConfig.apiName
+    ? config.dashboardConfig.apiName
+    : `${config.stage}-${config.service}`;
 
   const widget = {
     type: 'metric',

src/dashboards/widgets/api-gw/requests/numbers.js

@@ -1,5 +1,7 @@
 const createWidget = (config) => {
-  const apiName = `${config.stage}-${config.service}`;
+  const apiName = config.dashboardConfig.apiName
+    ? config.dashboardConfig.apiName
+    : `${config.stage}-${config.service}`;
 
   const widget = {
     type: 'metric',

src/dashboards/widgets/api-gw/requests/time-series.js

@@ -1,5 +1,7 @@
 const createWidget = (config) => {
-  const apiName = `${config.stage}-${config.service}`;
+  const apiName = config.dashboardConfig.apiName
+    ? config.dashboardConfig.apiName
+    : `${config.stage}-${config.service}`;
 
   const widget = {
     type: 'metric',

src/index.js

@@ -482,6 +482,7 @@ class AlertsPlugin {
     const provider = service.provider;
     const stage = this.options.stage;
     const region = this.options.region || provider.region;
+    const config = this.getConfig();
     const dashboardTemplates = this.getDashboardTemplates(
       configDashboards,
       stage
@@ -497,7 +498,8 @@ class AlertsPlugin {
         stage,
         region,
         functions,
-        d
+        d,
+        config.dashboardConfig ? config.dashboardConfig : {}
       );
 
       const cfResource =