@hiiretail/gcp-infra-cli 0.72.0 → 0.73.0

package/generators/resources/monitoring/append.js

@@ -10,57 +10,68 @@ const appendIncludeConfigSlo = async (fileContent, originalContentYaml, slosFile
 
   const newPullArray = [];
 
+  const availabilityConf = {
+    display_name: 'Month - Availability',
+    slo_id: 'month-availability',
+    goal: 0.998,
+    calendar_period: 'MONTH',
+    type: 'windows_based_sli',
+    method: 'boolean_filter',
+    window_period: '60s',
+  };
+
   if (inputs.sli === 'availability') {
-    newPullArray.push(
-      {
-        display_name: 'Month - Availability',
-        slo_id: 'month-availability',
-        goal: 0.998,
-        calendar_period: 'MONTH',
-        type: 'windows_based_sli',
-        method: 'boolean_filter',
-        window_period: '60s',
-      },
-    );
+    if (inputs.burnRateAlerts === 'no') {
+      availabilityConf.alert = {};
+    }
+    newPullArray.push(availabilityConf);
   }
-  if (inputs.sli === 'error-rate') {
-    newPullArray.push(
-      {
-        display_name: 'Month - Error rate',
-        slo_id: 'month-error-rate',
-        goal: 0.999,
-        calendar_period: 'MONTH',
-        type: 'request_based_sli',
-        method: 'good_total_ratio',
-        bad_service_filter:
+
+  const errorRateConf = {
+    display_name: 'Month - Error rate',
+    slo_id: 'month-error-rate',
+    goal: 0.999,
+    calendar_period: 'MONTH',
+    type: 'request_based_sli',
+    method: 'good_total_ratio',
+    bad_service_filter:
 `metric.type="knative.dev/serving/revision/request_count"
 resource.type="knative_revision"
 metric.labels.response_code_class="5xx"
 resource.labels.service_name="${inputs.serviceName}"`,
-        total_service_filter:
+    total_service_filter:
 `metric.type="knative.dev/serving/revision/request_count"
 resource.type="knative_revision"
 resource.labels.service_name=${inputs.serviceName}"`,
-      },
-    );
+  };
+
+  if (inputs.sli === 'error-rate') {
+    if (inputs.burnRateAlerts === 'no') {
+      errorRateConf.alert = {};
+    }
+    newPullArray.push(errorRateConf);
   }
-  if (inputs.sli === 'latency') {
-    newPullArray.push(
-      {
-        display_name: 'Month - Latency',
-        slo_id: 'month-latency',
-        goal: 0.95,
-        calendar_period: 'MONTH',
-        type: 'request_based_sli',
-        method: 'distribution_cut',
-        metric_filter:
+
+  const latencyConf = {
+    display_name: 'Month - Latency',
+    slo_id: 'month-latency',
+    goal: 0.95,
+    calendar_period: 'MONTH',
+    type: 'request_based_sli',
+    method: 'distribution_cut',
+    metric_filter:
 `metric.type="knative.dev/serving/revision/request_latencies"
 resource.type="knative_revision"
 resource.labels.service_name="${inputs.serviceName}"`,
-        range_min: 0,
-        range_max: 100,
-      },
-    );
+    range_min: 0,
+    range_max: 100,
+  };
+
+  if (inputs.sli === 'latency') {
+    if (inputs.burnRateAlerts === 'no') {
+      latencyConf.alert = {};
+    }
+    newPullArray.push(latencyConf);
   }
 
   const finalYamlPullArray = yaml.dump(newPullArray);

package/generators/resources/monitoring/handle-slos.js

@@ -7,6 +7,7 @@ const handleSlosFile = async (answers, slosFilePath) => {
     serviceName,
     sli,
     systemName,
+    burnRateAlerts,
   } = answers;
 
   const sloFileContent = fs.readFileSync(slosFilePath, 'utf8');
@@ -16,6 +17,7 @@ const handleSlosFile = async (answers, slosFilePath) => {
     serviceName,
     sli,
     systemName,
+    burnRateAlerts,
   };
 
   const originalContentYaml = yaml.load(sloFileContent);

package/generators/resources/monitoring/index.js

@@ -53,6 +53,14 @@ module.exports = class extends BaseGenerator {
         default: 'availability',
         choices: ['availability', 'error-rate', 'latency'],
       },
+      {
+        when: (response) => response.monitoringResource === 'slos',
+        type: 'list',
+        name: 'burnRateAlerts',
+        message: 'Please select yes if you want to create burn rate alert for the SLI',
+        default: 'yes',
+        choices: ['yes', 'no'],
+      },
       {
         when: (response) => response.monitoringResource === 'slos' && response.sli === 'availability',
         type: 'confirm',
@@ -73,6 +81,7 @@ module.exports = class extends BaseGenerator {
       hostname,
       sli,
       systemName,
+      burnRateAlerts,
     } = this.answers;
 
     const serviceFolderName = serviceName.replace(/ /g, '-').toLowerCase();
@@ -122,6 +131,7 @@ module.exports = class extends BaseGenerator {
               monitoringResource,
               serviceName,
               systemName,
+              burnRateAlerts,
             },
           );
         }
@@ -134,6 +144,7 @@ module.exports = class extends BaseGenerator {
             monitoringResource,
             serviceName,
             systemName,
+            burnRateAlerts,
           },
         );
       }
@@ -149,6 +160,7 @@ module.exports = class extends BaseGenerator {
             serviceName,
             systemName,
             sli,
+            burnRateAlerts,
           },
         );
       } else {

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

@@ -9,13 +9,15 @@
     resource.type="knative_revision"
     resource.labels.service_name="<%-serviceName%>"
   range_min: 0
-  range_max: 100<% } %><% if (sli === 'availability') { %>- display_name: Month - Availability
+  range_max: 100<% if (burnRateAlerts === 'no') { %>
+  alert: {}<% } %><% } %><% if (sli === 'availability') { %>- display_name: Month - Availability
   slo_id: month-availability
   goal: 0.998
   calendar_period: MONTH
   type: windows_based_sli
   method: boolean_filter
-  window_period: 60s<% } %><% if (sli === 'error-rate') { %>- display_name: Month - Error rate
+  window_period: 60s<% if (burnRateAlerts === 'no') { %>
+  alert: {}<% } %><% } %><% if (sli === 'error-rate') { %>- display_name: Month - Error rate
   slo_id: month-error-rate
   goal: 0.999
   calendar_period: MONTH
@@ -29,4 +31,5 @@
   total_service_filter: |-
     metric.type="knative.dev/serving/revision/request_count"
     resource.type="knative_revision"
-    resource.labels.service_name="<%-serviceName%>"<% } %>
+    resource.labels.service_name="<%-serviceName%>"<% if (burnRateAlerts === 'no') { %>
+  alert: {}<% } %><% } %>

package/generators/resources/monitoring/templates/slos/terragrunt.hcl

@@ -24,8 +24,9 @@ locals {
 inputs = merge(
   local.project_vars.locals,
   {
-    service_name          = "<%-systemName%>.<%-serviceName%>"
-    slos                  = yamldecode(file("${get_terragrunt_dir()}/slos.yaml")),
+    service_name            = "<%-systemName%>.<%-serviceName%>"
+    slos                    = yamldecode(file("${get_terragrunt_dir()}/slos.yaml")),
+    telemetry_resource_name = "//container.googleapis.com/projects/${local.project_vars.locals.monitoring_project_id}/locations/europe-west1/clusters/k8s-cluster/k8s/namespaces/<%-serviceName%>"
     <% if (sli === 'availability') { %>
     metric_filter = {
       "metric.type"            = "monitoring.googleapis.com/uptime_check/check_passed"

package/package.json

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