feat: added new input variables sysdig_agent_tags and sysdig_add_cluster_name (#217)

Author: dishankkalra23

README.md

@@ -131,6 +131,8 @@ No modules.
 | <a name="input_logdna_instance_name"></a> [logdna\_instance\_name](#input\_logdna\_instance\_name) | IBM Cloud Logging instance to use. Required if LogDNA is enabled | `string` | `null` | no |
 | <a name="input_logdna_resource_group_id"></a> [logdna\_resource\_group\_id](#input\_logdna\_resource\_group\_id) | Resource group the IBM Cloud Logging instance is in. Defaults to Clusters group | `string` | `null` | no |
 | <a name="input_sysdig_access_key"></a> [sysdig\_access\_key](#input\_sysdig\_access\_key) | Access key used by the IBM Cloud Monitoring agent to communicate with the instance | `string` | `null` | no |
+| <a name="input_sysdig_add_cluster_name"></a> [sysdig\_add\_cluster\_name](#input\_sysdig\_add\_cluster\_name) | If true, configure the sysdig agent to attach a tag containing the cluster name to all metric data. | `bool` | `true` | no |
+| <a name="input_sysdig_agent_tags"></a> [sysdig\_agent\_tags](#input\_sysdig\_agent\_tags) | array of tags to group the host metrics pushed by the sysdig agent | `list(string)` | `[]` | no |
 | <a name="input_sysdig_agent_version"></a> [sysdig\_agent\_version](#input\_sysdig\_agent\_version) | IBM Cloud Monitoring Agent Version. To lookup version run: `ibmcloud cr images --restrict ext/sysdig/agent`. If null, the default value is used. | `string` | `"12.17.1"` | no |
 | <a name="input_sysdig_enabled"></a> [sysdig\_enabled](#input\_sysdig\_enabled) | Deploy IBM Cloud Monitoring agent | `bool` | `true` | no |
 | <a name="input_sysdig_instance_name"></a> [sysdig\_instance\_name](#input\_sysdig\_instance\_name) | The name of the IBM Cloud Monitoring instance to use. Required if Sysdig is enabled | `string` | `null` | no |

examples/basic/main.tf

@@ -110,8 +110,9 @@ module "observability_agents" {
   logdna_ingestion_key      = module.observability_instances.log_analysis_ingestion_key
   sysdig_instance_name      = module.observability_instances.cloud_monitoring_name
   sysdig_access_key         = module.observability_instances.cloud_monitoring_access_key
-  logdna_agent_tags         = var.logdna_agent_tags
+  logdna_agent_tags         = var.resource_tags
   logdna_add_cluster_name   = true
   # example of how to include / exclude metrics - more info https://cloud.ibm.com/docs/monitoring?topic=monitoring-change_kube_agent#change_kube_agent_log_metrics
   sysdig_metrics_filter = [{ type = "exclude", name = "metricA.*" }, { type = "include", name = "metricB.*" }]
+  sysdig_agent_tags     = var.resource_tags
 }

examples/basic/variables.tf

@@ -27,9 +27,3 @@ variable "region" {
   description = "Region where resources are created"
   default     = "ca-tor"
 }
-
-variable "logdna_agent_tags" {
-  type        = list(string)
-  description = "Array of string of tags for logdna agent"
-  default     = []
-}

main.tf

@@ -61,6 +61,7 @@ locals {
   sysdig_key_validate_msg       = "Values for 'sysdig_access_key' variables must be passed when 'sysdig_enabled = true'"
   # tflint-ignore: terraform_unused_declarations
   sysdig_key_validate_check = regex("^${local.sysdig_key_validate_msg}$", (!local.sysdig_key_validate_condition ? local.sysdig_key_validate_msg : ""))
+  sysdig_agent_tags         = var.sysdig_add_cluster_name ? concat([local.cluster_name], var.sysdig_agent_tags) : var.sysdig_agent_tags
 }
 
 /** LogDNA Configuration Start **/
@@ -158,6 +159,12 @@ resource "helm_release" "sysdig_agent" {
     value = var.sysdig_access_key
   }
 
+  set {
+    name  = "agent.tags"
+    type  = "string"
+    value = join("\\,", local.sysdig_agent_tags)
+  }
+
   values = [yamlencode({
     metrics_filter = var.sysdig_metrics_filter
   })]

tests/pr_test.go

@@ -21,8 +21,6 @@ var ignoreUpdates = []string{
 
 var sharedInfoSvc *cloudinfo.CloudInfoService
 
-var logDNATagsList = []string{"tag1", "tag2"}
-
 // TestMain will be run before any parallel tests, used to set up a shared InfoService object to track region usage
 // for multiple tests
 func TestMain(m *testing.M) {
@@ -37,9 +35,6 @@ func setupOptions(t *testing.T, prefix string, terraformDir string) *testhelper.
 		TerraformDir:  terraformDir,
 		Prefix:        prefix,
 		ResourceGroup: resourceGroup,
-		TerraformVars: map[string]interface{}{
-			"logdna_agent_tags": logDNATagsList,
-		},
 		IgnoreUpdates: testhelper.Exemptions{
 			List: ignoreUpdates,
 		},

variables.tf

@@ -105,4 +105,17 @@ variable "sysdig_metrics_filter" {
   }
 }
 
+variable "sysdig_agent_tags" {
+  type        = list(string)
+  description = "array of tags to group the host metrics pushed by the sysdig agent"
+  default     = []
+  nullable    = false
+}
+
+variable "sysdig_add_cluster_name" {
+  type        = bool
+  description = "If true, configure the sysdig agent to attach a tag containing the cluster name to all metric data."
+  default     = true
+}
+
 ##############################################################################