@hiiretail/gcp-infra-cli 0.75.2 → 0.76.0

package/generators/resources/monitoring/index.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const yaml = require('js-yaml');
 const BaseGenerator = require('../../../src/BaseGenerator');
 const { required } = require('../../../src/validators');
-const helper = require('./validate');
+const validator = require('./validate');
 const handleSlosFile = require('./handle-slos');
 const handleUptimeFile = require('./handle-uptime');
 const handleAlerts = require('./handle-alerts');
@@ -33,14 +33,14 @@ module.exports = class extends BaseGenerator {
         choices: (answers) => Object.keys(alertTemplates[`${answers.alertResource}`]),
       },
       {
-        when: (response) => response.monitoringResource === ('alerts' || 'slos' || 'uptime-checks'),
+        when: (response) => ['alerts', 'slos', 'uptime-checks'].includes(response.monitoringResource),
         type: 'input',
         name: 'systemName',
-        message: 'Please provide three-letter system name as defined in Styra',
-        validate: required && helper.validSystemName,
+        message: 'Please provide three-letter system name as defined in Styra (example: sre, ptf, sda, che, pnp, iam...)',
+        validate: required && validator.systemName,
       },
       {
-        when: (response) => response.monitoringResource === ('slos' || 'uptime-checks') || response.alertResource === 'cloud_run',
+        when: (response) => ['slos', 'uptime-checks'].includes(response.monitoringResource) || response.alertResource === 'cloud_run',
         type: 'input',
         name: 'serviceName',
         message: 'Please provide the namespace where the service resides',
@@ -51,7 +51,7 @@ module.exports = class extends BaseGenerator {
         type: 'input',
         name: 'runbookLink',
         message: 'Please provide the full URL to your runbook in confluence (Leave empty if none)',
-        validate: required && helper.validUrl,
+        validate: required && validator.url,
       },
       {
         when: (response) => response.alertResource === 'cloud_scheduler',
@@ -65,34 +65,35 @@ module.exports = class extends BaseGenerator {
         type: 'input',
         name: 'databaseId',
         message: 'Please provide the "database id"',
-        validate: required,
+        validate: required && validator.databaseId,
       },
       {
         when: (response) => response.alertResource === 'memorystore',
         type: 'input',
         name: 'instanceId',
         message: 'Please provide the "instance id"',
-        validate: required,
+        validate: required && validator.instanceID,
       },
       {
         when: (response) => response.alertResource === 'pub_sub',
         type: 'input',
         name: 'subscriptionId',
         message: 'Please provide the "subscription id"',
-        validate: required,
+        validate: required && validator.pubSubSubscription,
       },
       {
         when: (response) => response.monitoringResource === 'uptime-checks',
         type: 'input',
         name: 'hostname',
         message: 'Please provide the base hostname of the service (example: my-service.retailsvc.com)',
-        validate: required && helper.validHostname,
+        validate: required && validator.validHostname,
       },
       {
         when: (response) => response.monitoringResource === 'uptime-checks',
         type: 'input',
         name: 'path',
-        message: 'Please provide the path to the page to run the check against. (example: /health)',
+        message: 'Please provide the path/endpoint to run the check against',
+        default: '/health',
         validate: required,
       },
       {
@@ -106,7 +107,7 @@ module.exports = class extends BaseGenerator {
         when: (response) => response.monitoringResource === 'slos',
         type: 'list',
         name: 'burnRateAlerts',
-        message: 'Please select yes if you want to create burn rate alert for the SLI',
+        message: 'Please select yes if you want to have burn-rate alerts included',
         default: 'yes',
         choices: ['yes', 'no'],
       },
@@ -114,7 +115,7 @@ module.exports = class extends BaseGenerator {
         when: (response) => response.monitoringResource === 'slos' && response.sli === 'availability',
         type: 'confirm',
         name: 'info',
-        message: 'WARNING: Make sure that an uptime check has been created before applying availability SLI',
+        message: 'WARNING: Make sure an uptime check has been created BEFORE continuing with the creation of this SLO.',
       },
     ]);
   }

package/generators/resources/monitoring/templates/alerts/alerts.yaml

@@ -1,37 +1,4 @@
 cloud_run:
-  error_count:
-    display_name: "[P3] <%-systemName%>.<%-serviceName%> | 5xx Error Request Count above 1"
-    conditions:
-      - display_name: Cloud Run Anthos - 5xx error Request Count above 1
-        condition_threshold:
-          filter: |
-            resource.type="knative_revision"
-            resource.labels.service_name="<%-serviceName%>"
-            metric.type="knative.dev/serving/revision/request_count"
-            metric.labels.response_code_class="5xx"
-          threshold_value: 1
-          aggregations:
-            - alignment_period: 60s
-              cross_series_reducer: REDUCE_SUM
-              group_by_fields:
-                - metric.label.response_code_class
-              per_series_aligner: ALIGN_DELTA
-    documentation:
-      content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
-  error_rate:
-    display_name: "[P3] <%-systemName%>.<%-serviceName%> | High 5xx Error Rate"
-    conditions:
-      - display_name: Cloud Run Anthos - 3% of all requests during 10min are 5xx
-        condition_monitoring_query_language:
-          query: |
-            fetch knative_revision::knative.dev/serving/revision/request_count
-              | filter service_name = "store-data-resolver"
-              | align int_mean_aligner(10m)
-              | group_by [],    sum(if(metric.response_code_class == '5xx', val(), 0)) / sum(val())
-              | condition val() > 0.03
-              | every 10m
-    documentation:
-      content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   request_latency:
     display_name: "[P3] <%-systemName%>.<%-serviceName%> | High Request Latency"
     conditions:
@@ -45,7 +12,6 @@ cloud_run:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_PERCENTILE_95
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
@@ -63,13 +29,12 @@ cloud_scheduler:
           threshold_value: 1
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_COUNT
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
 cloud_sql:
   cpu_over_65:
-    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId%> - CPU over 65%"
+    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId.substring(databaseId.lastIndexOf(':') + 1)%> - CPU over 65%"
     conditions:
       - display_name: Cloud SQL Database - CPU utilization above 65% over 5 min
         condition_threshold:
@@ -81,12 +46,11 @@ cloud_sql:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MAX
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   cpu_over_85:
-    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId%> - CPU over 85%"
+    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId.substring(databaseId.lastIndexOf(':') + 1)%> - CPU over 85%"
     conditions:
       - display_name: "Cloud SQL Database - CPU-usage above 85% over 1 min"
         condition_threshold:
@@ -98,12 +62,11 @@ cloud_sql:
           duration: 60s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MAX
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   cpu_over_90:
-    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId%> - CPU over 90%"
+    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId.substring(databaseId.lastIndexOf(':') + 1)%> - CPU over 90%"
     conditions:
       - display_name: Cloud SQL Database - CPU-usage above 90%
         condition_threshold:
@@ -114,63 +77,11 @@ cloud_sql:
           threshold_value: 0.9
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MAX
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
-  memory_over_50:
-    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId%> - Memory over 50%"
-    conditions:
-    - display_name: Cloud SQL Database - Memory utilization above 50% over 5 min
-      condition_threshold:
-        filter: |
-          resource.type="cloudsql_database"
-          resource.labels.database_id="<%-databaseId%>"
-          metric.type="cloudsql.googleapis.com/database/memory/utilization"
-        threshold_value: 50
-        duration: 300s
-        aggregations:
-        - alignment_period: 60s
-          cross_series_reducer: REDUCE_NONE
-          per_series_aligner: ALIGN_MAX
-    documentation:
-      content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
-  memory_over_75:
-    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId%> - Memory over 75%"
-    conditions:
-    - display_name: Cloud SQL Database - Memory utilization above 75% over 5 min
-      condition_threshold:
-        filter: |
-          resource.type="cloudsql_database"
-          resource.labels.database_id="<%-databaseId%>"
-          metric.type="cloudsql.googleapis.com/database/memory/utilization"
-        threshold_value: 75
-        duration: 300s
-        aggregations:
-        - alignment_period: 60s
-          cross_series_reducer: REDUCE_NONE
-          per_series_aligner: ALIGN_MAX
-    documentation:
-      content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
-  memory_over_90:
-    display_name: "[P3] <%-systemName%> - CloudSQL | <%-databaseId%> - Memory over 90%"
-    conditions:
-    - display_name: Cloud SQL Database - Memory utilization above 90%
-      condition_threshold:
-        filter: |
-          resource.type="cloudsql_database"
-          resource.labels.database_id="<%-databaseId%>"
-          metric.type="cloudsql.googleapis.com/database/memory/utilization"
-        threshold_value: 90
-        duration: 60s
-        aggregations:
-        - alignment_period: 60s
-          cross_series_reducer: REDUCE_NONE
-          per_series_aligner: ALIGN_MAX
-    documentation:
-      content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   query_over_1s:
-    display_name: "[P4] <%-systemName%> - CloudSQL | <%-databaseId%> - Query resolve time"
+    display_name: "[P4] <%-systemName%> - CloudSQL | <%-databaseId.substring(databaseId.lastIndexOf(':') + 1)%> - Query resolve time"
     conditions:
       - display_name: Cloud SQL Instance Database - Per query execution times above 1000 ms
         condition_threshold:
@@ -181,13 +92,12 @@ cloud_sql:
           threshold_value: 1000000
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_DELTA
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
 memorystore:
   memory_over_50:
-    display_name: "[P4] <%-systemName%> - Memorystore | <%-instanceId%> - Memory over 50%"
+    display_name: "[P4] <%-systemName%> - Memorystore | <%-instanceId.substring(instanceId.lastIndexOf('/') + 1)%> - Memory over 50%"
     conditions:
       - display_name: Memorystore Redis Instance - Memory Usage above 50% over 5 min
         condition_threshold:
@@ -199,12 +109,11 @@ memorystore:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MAX
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   memory_over_75:
-    display_name: "[P4] <%-systemName%> - Memorystore | <%-instanceId%> - Memory over 75%"
+    display_name: "[P4] <%-systemName%> - Memorystore | <%-instanceId.substring(instanceId.lastIndexOf('/') + 1)%> - Memory over 75%"
     conditions:
       - display_name: Memorystore Redis Instance - Memory Usage above 75% for 5min
         condition_threshold:
@@ -216,12 +125,11 @@ memorystore:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MAX
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
   memory_over_90:
-    display_name: "[P2] <%-systemName%> - Memorystore | <%-instanceId%> - Memory over 90%"
+    display_name: "[P2] <%-systemName%> - Memorystore | <%-instanceId.substring(instanceId.lastIndexOf('/') + 1)%> - Memory over 90%"
     conditions:
       - display_name: Memorystore Redis Instance - Memory Usage above 90%
         condition_threshold:
@@ -233,13 +141,12 @@ memorystore:
           duration: 60s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MAX
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>
 pub_sub:
   unacknowledged_messages:
-    display_name: "[P4] <%-systemName%> - Pub/Sub | <%-subscriptionId%> - Undelivered message(s)"
+    display_name: "[P4] <%-systemName%> - Pub/Sub | <%-subscriptionId.substring(subscriptionId.lastIndexOf('/') + 1)%> - Undelivered message(s)"
     conditions:
       - display_name: Cloud Pub/Sub Subscription - Undelivered messages above 1 for 5 min
         condition_threshold:
@@ -251,7 +158,6 @@ pub_sub:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              cross_series_reducer: REDUCE_NONE
               per_series_aligner: ALIGN_MEAN
     documentation:
       content: <% if (runbookLink) { %>[Runbook](<%-runbookLink%>)<%} else { %> <% } %>

package/generators/resources/monitoring/validate.js

@@ -1,6 +1,6 @@
-const helper = {};
+const validator = {};
 
-helper.validHostname = (input) => {
+validator.hostName = (input) => {
   const regex = new RegExp(/^(?:[a-z-]+\.){1,3}[a-z-]+$/g);
   if (input.match(regex)) {
     return true;
@@ -8,18 +8,33 @@ helper.validHostname = (input) => {
   return 'Hostname must not include path to the page to run the check against or spaces';
 };
 
-helper.validSystemName = (input) => {
+validator.systemName = (input) => {
   if (input.replace(/\s/g, '').length === 3) {
     return true;
   }
   return 'System name must be 3 characters';
 };
 
-helper.validUrl = (input) => {
+validator.url = (input) => {
   // eslint-disable-next-line no-useless-escape
   const regex = new RegExp(/^https:\/\/[a-zA-Z]*.[a-zA-Z]*.[a-zA-Z]*\/[a-zA-Z\/+_-]*.$/g);
   if (regex.test(input) || input === '') return true;
-  return 'Enter a valid URL';
+  return 'You must enter a valid URL';
 };
 
-module.exports = helper;
+validator.instanceID = (input) => {
+  if (input.split('/').length === 6) return true;
+  return 'You must enter the full instance path (example: projects/example/locations/europe-west1/instances/instanceID)';
+};
+
+validator.databaseId = (input) => {
+  if (input.split(':').length === 2) return true;
+  return 'You must enter the full database path (example: my-project:databaseID)';
+};
+
+validator.pubSubSubscription = (input) => {
+  if (input.split('/').length === 4) return true;
+  return 'You must enter the full subscription path (example: projects/example/subscriptions/subscriptionId)';
+};
+
+module.exports = validator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hiiretail/gcp-infra-cli",
-  "version": "0.75.2",
+  "version": "0.76.0",
   "description": "Infrastructure as code generator for GCP.",
   "main": "src/cli.js",
   "bin": {