feat(template): Add base path api parameter (#46)

pietro-tota · pasqualedevita · web-flow · commit ccf66dfdc023 · 2023-09-12T13:52:37.000+02:00
Co-authored-by: Pasquale De Vita &lt;59291437+pasqualedevita@users.noreply.github.com&gt;
diff --git a/src/opex_dashboard/templates/api-management_queries/availability.kusto b/src/opex_dashboard/templates/api-management_queries/availability.kusto
@@ -1,7 +1,7 @@
-{% load stringify uri_to_regex %}
+{% load add_str stringify uri_to_regex %}
 let threshold = {{ threshold|default:"0.99" }};
 AzureDiagnostics
-| where url_s matches regex "{{ endpoint|uri_to_regex }}"
+| where url_s matches regex "{{ base_path|default:""|add_str:endpoint|uri_to_regex }}"
 | summarize
   Total=count(),
   Success=count(responseCode_d < 500) by bin(TimeGenerated, {{ timespan }})
diff --git a/src/opex_dashboard/templates/api-management_queries/response_codes.kusto b/src/opex_dashboard/templates/api-management_queries/response_codes.kusto
@@ -1,5 +1,5 @@
-{% load stringify uri_to_regex %}
-let api_url = "{{ endpoint|uri_to_regex }}";
+{% load add_str stringify uri_to_regex %}
+let api_url = "{{ base_path|default:""|add_str:endpoint|uri_to_regex }}";
 AzureDiagnostics
 | where url_s matches regex api_url
 | extend HTTPStatus = case(
diff --git a/src/opex_dashboard/templates/api-management_queries/response_time.kusto b/src/opex_dashboard/templates/api-management_queries/response_time.kusto
@@ -1,7 +1,7 @@
-{% load stringify uri_to_regex %}
+{% load add_str stringify uri_to_regex %}
 let threshold = {{ threshold|default:"1" }};
 AzureDiagnostics
-| where url_s matches regex "{{ endpoint|uri_to_regex }}"
+| where url_s matches regex "{{ base_path|default:""|add_str:endpoint|uri_to_regex }}"
 | summarize
     watermark=threshold,
     duration_percentile_95=percentiles(todouble(DurationMs)/1000, 95) by bin(TimeGenerated, {{ timespan }})
diff --git a/src/opex_dashboard/templates/app-gateway_queries/availability.kusto b/src/opex_dashboard/templates/app-gateway_queries/availability.kusto
@@ -1,9 +1,9 @@
-{% load stringify uri_to_regex %}
+{% load add_str stringify uri_to_regex %}
 let api_hosts = datatable (name: string) {{ hosts|stringify }};
 let threshold = {{ threshold|default:"0.99" }};
 AzureDiagnostics
 | where originalHost_s in (api_hosts)
-| where requestUri_s matches regex "{{ endpoint|uri_to_regex }}"
+| where requestUri_s matches regex "{{ base_path|default:""|add_str:endpoint|uri_to_regex }}"
 | summarize
   Total=count(),
   Success=count(httpStatus_d < 500) by bin(TimeGenerated, {{ timespan }})
diff --git a/src/opex_dashboard/templates/app-gateway_queries/response_codes.kusto b/src/opex_dashboard/templates/app-gateway_queries/response_codes.kusto
@@ -1,5 +1,5 @@
-{% load stringify uri_to_regex %}
-let api_url = "{{ endpoint|uri_to_regex }}";
+{% load add_str stringify uri_to_regex %}
+let api_url = "{{ base_path|default:""|add_str:endpoint|uri_to_regex }}";
 let api_hosts = datatable (name: string) {{ hosts|stringify }};
 AzureDiagnostics
 | where originalHost_s in (api_hosts)
diff --git a/src/opex_dashboard/templates/app-gateway_queries/response_time.kusto b/src/opex_dashboard/templates/app-gateway_queries/response_time.kusto
@@ -1,9 +1,9 @@
-{% load stringify uri_to_regex %}
+{% load add_str stringify uri_to_regex %}
 let api_hosts = datatable (name: string) {{ hosts|stringify }};
 let threshold = {{ threshold|default:"1" }};
 AzureDiagnostics
 | where originalHost_s in (api_hosts)
-| where requestUri_s matches regex "{{ endpoint|uri_to_regex }}"
+| where requestUri_s matches regex "{{ base_path|default:""|add_str:endpoint|uri_to_regex }}"
 | summarize
     watermark=threshold,
     duration_percentile_95=percentiles(timeTaken_d, 95) by bin(TimeGenerated, {{ timespan }})
diff --git a/src/opex_dashboard/templates/azure_dashboard_raw.json b/src/opex_dashboard/templates/azure_dashboard_raw.json
@@ -79,7 +79,7 @@
                 },
                 {
                   "name": "PartSubTitle",
-                  "value": "{{ endpoint }}",
+                  "value": "{{ base_path|default:""|add_str:endpoint }}",
                   "isOptional": true
                 },
                 {
@@ -202,7 +202,7 @@
                 },
                 {
                   "name": "PartSubTitle",
-                  "value": "{{ endpoint }}",
+                  "value": "{{ base_path|default:""|add_str:endpoint }}",
                   "isOptional": true
                 },
                 {
@@ -341,7 +341,7 @@
                 },
                 {
                   "name": "PartSubTitle",
-                  "value": "{{ endpoint }}",
+                  "value": "{{ base_path|default:""|add_str:endpoint }}",
                   "isOptional": true
                 },
                 {
diff --git a/src/opex_dashboard/templates/azure_dashboard_terraform.tf b/src/opex_dashboard/templates/azure_dashboard_terraform.tf
@@ -22,7 +22,7 @@ resource "azurerm_portal_dashboard" "this" {
 
 {% for endpoint,props in endpoints.items %}
 resource "azurerm_monitor_scheduled_query_rules_alert" "alarm_availability_{{ forloop.counter0 }}" {
-  name                = replace(join("_",split("/", "${local.name}-availability @ {{endpoint}}")), "/\\{|\\}/", "")
+  name                = replace(join("_",split("/", "${local.name}-availability @ {{base_path|default:""|add_str:endpoint}}")), "/\\{|\\}/", "")
   resource_group_name = data.azurerm_resource_group.this.name
   location            = data.azurerm_resource_group.this.location
 
@@ -31,7 +31,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "alarm_availability_{{ fo
   }
 
   data_source_id          = "{{ data_source_id }}"
-  description             = "Availability for {{endpoint}} is less than or equal to 99% - ${local.dashboard_base_addr}${azurerm_portal_dashboard.this.id}"
+  description             = "Availability for {{base_path|default:""|add_str:endpoint}} is less than or equal to 99% - ${local.dashboard_base_addr}${azurerm_portal_dashboard.this.id}"
   enabled                 = true
   auto_mitigation_enabled = false
 
@@ -53,7 +53,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "alarm_availability_{{ fo
 }
 
 resource "azurerm_monitor_scheduled_query_rules_alert" "alarm_time_{{ forloop.counter0 }}" {
-  name                = replace(join("_",split("/", "${local.name}-responsetime @ {{endpoint}}")), "/\\{|\\}/", "")
+  name                = replace(join("_",split("/", "${local.name}-responsetime @ {{base_path|default:""|add_str:endpoint}}")), "/\\{|\\}/", "")
   resource_group_name = data.azurerm_resource_group.this.name
   location            = data.azurerm_resource_group.this.location
 
@@ -62,7 +62,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "alarm_time_{{ forloop.co
   }
 
   data_source_id          = "{{ data_source_id }}"
-  description             = "Response time for {{endpoint}} is less than or equal to 1s - ${local.dashboard_base_addr}${azurerm_portal_dashboard.this.id}"
+  description             = "Response time for {{base_path|default:""|add_str:endpoint}} is less than or equal to 1s - ${local.dashboard_base_addr}${azurerm_portal_dashboard.this.id}"
   enabled                 = true
   auto_mitigation_enabled = false
 
diff --git a/test/snapshots/iobackend_light_overrides_base_path.txt b/test/snapshots/iobackend_light_overrides_base_path.txt
diff --git a/test/test_builder_azure_dashboard.py b/test/test_builder_azure_dashboard.py

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@`
`79`	`79`	`},`
`80`	`80`	`{`
`81`	`81`	`"name": "PartSubTitle",`
`82`		`- "value": "{{ endpoint }}",`
	`82`	`+ "value": "{{ base_path\|default:""\|add_str:endpoint }}",`
`83`	`83`	`"isOptional": true`
`84`	`84`	`},`
`85`	`85`	`{`
`@@ -202,7 +202,7 @@`
`202`	`202`	`},`
`203`	`203`	`{`
`204`	`204`	`"name": "PartSubTitle",`
`205`		`- "value": "{{ endpoint }}",`
	`205`	`+ "value": "{{ base_path\|default:""\|add_str:endpoint }}",`
`206`	`206`	`"isOptional": true`
`207`	`207`	`},`
`208`	`208`	`{`
`@@ -341,7 +341,7 @@`
`341`	`341`	`},`
`342`	`342`	`{`
`343`	`343`	`"name": "PartSubTitle",`
`344`		`- "value": "{{ endpoint }}",`
	`344`	`+ "value": "{{ base_path\|default:""\|add_str:endpoint }}",`
`345`	`345`	`"isOptional": true`
`346`	`346`	`},`
`347`	`347`	`{`