feat: expose Sysdig agent mode as configurable input variable

Add agent_mode variable to allow users to configure the operational mode
of the Sysdig agent. This addresses GitHub issue #263 where users need to
set the agent to 'troubleshooting' mode to access additional metrics.

The agent_mode variable accepts:
- 'monitor': Standard monitoring mode
- 'monitor_light': Lightweight monitoring mode
- 'troubleshooting': Enhanced mode with additional metrics like HTTP request
  metrics (sysdig_container_net_http_url_request_count,
  sysdig_container_net_http_url_request_time,
  sysdig_container_net_http_url_error_count)
- null: Use the agent's default mode (default value)

Changes:
- Add agent_mode string variable with validation in variables.tf
- Configure feature mode in agent.sysdig.settings in main.tf
- Add agent_mode to fully-configurable solution
- Update ibm_catalog.json with new variable entry
- Auto-generate documentation via pre-commit hooks

Fixes issue #263

Author: Jordan-Williams2

README.md

@@ -114,6 +114,7 @@ No modules.
 | <a name="input_agent_image_tag_digest"></a> [agent\_image\_tag\_digest](#input\_agent\_image\_tag\_digest) | The image tag or digest of agent image to use. If using digest, it must be in the format of `X.Y.Z@sha256:xxxxx`. | `string` | `"14.2.5@sha256:64b9d77bbd1bb22f97a74198144dcfea62bb5cee7629091252694e9040058035"` | no |
 | <a name="input_agent_limits_cpu"></a> [agent\_limits\_cpu](#input\_agent\_limits\_cpu) | Specify CPU resource limits for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1"` | no |
 | <a name="input_agent_limits_memory"></a> [agent\_limits\_memory](#input\_agent\_limits\_memory) | Specify memory resource limits for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1024Mi"` | no |
+| <a name="input_agent_mode"></a> [agent\_mode](#input\_agent\_mode) | The operational mode for the Sysdig agent. Valid values are 'monitor', 'monitor\_light', 'troubleshooting', or null. The 'troubleshooting' mode enables additional metrics that are useful for debugging, such as HTTP request metrics (sysdig\_container\_net\_http\_url\_request\_count, sysdig\_container\_net\_http\_url\_request\_time, sysdig\_container\_net\_http\_url\_error\_count). Set to null to use the agent's default mode. | `string` | `null` | no |
 | <a name="input_agent_requests_cpu"></a> [agent\_requests\_cpu](#input\_agent\_requests\_cpu) | Specify CPU resource requests for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1"` | no |
 | <a name="input_agent_requests_memory"></a> [agent\_requests\_memory](#input\_agent\_requests\_memory) | Specify memory resource requests for the agent. For more info, see https://cloud.ibm.com/docs/monitoring?topic=monitoring-resource_requirements | `string` | `"1024Mi"` | no |
 | <a name="input_agent_tags"></a> [agent\_tags](#input\_agent\_tags) | Map of tags to associate to the agent. For example, {"environment": "production"}. NOTE: Use the `add_cluster_name` boolean variable to add the cluster name as a tag. | `map(string)` | `{}` | no |

ibm_catalog.json

@@ -354,6 +354,9 @@
             {
               "key": "enable_jmx"
             },
+            {
+              "key": "agent_mode"
+            },
             {
               "key": "use_private_endpoint"
             },

main.tf

@@ -213,6 +213,10 @@ resource "helm_release" "cloud_monitoring_agent" {
       "app_checks_enabled": ${var.enable_app_checks}
       "jmx":
         "enabled": ${var.enable_jmx}
+%{if var.agent_mode != null~}
+      "feature":
+        "mode": ${var.agent_mode}
+%{endif~}
       "sysdig_api_endpoint": ${local.api_host}
       "blacklisted_ports":
 %{for port in var.blacklisted_ports~}

solutions/fully-configurable/main.tf

@@ -67,6 +67,7 @@ module "monitoring_agent" {
   enable_kspm_analyzer            = var.enable_kspm_analyzer
   enable_app_checks               = var.enable_app_checks
   enable_jmx                      = var.enable_jmx
+  agent_mode                      = var.agent_mode
   cluster_shield_deploy           = var.cluster_shield_deploy
   cluster_shield_image_tag_digest = var.cluster_shield_image_tag_digest
   cluster_shield_image_repository = var.cluster_shield_image_repository

solutions/fully-configurable/variables.tf

@@ -364,6 +364,16 @@ variable "enable_jmx" {
   default     = true
 }
 
+variable "agent_mode" {
+  type        = string
+  description = "The operational mode for the Sysdig agent. Valid values are 'monitor', 'monitor_light', 'troubleshooting', or null. The 'troubleshooting' mode enables additional metrics that are useful for debugging, such as HTTP request metrics (sysdig_container_net_http_url_request_count, sysdig_container_net_http_url_request_time, sysdig_container_net_http_url_error_count). Set to null to use the agent's default mode."
+  default     = null
+  validation {
+    condition     = var.agent_mode == null ? true : contains(["monitor", "monitor_light", "troubleshooting"], var.agent_mode)
+    error_message = "agent_mode must be one of 'monitor', 'monitor_light', 'troubleshooting', or null."
+  }
+}
+
 variable "cluster_shield_deploy" {
   type        = bool
   description = "Deploy the Cluster Shield component to provide runtime detection and policy enforcement for Kubernetes workloads. If enabled, a Kubernetes Deployment will be deployed to your cluster using helm."

variables.tf

@@ -369,6 +369,16 @@ variable "enable_jmx" {
   default     = true
 }
 
+variable "agent_mode" {
+  type        = string
+  description = "The operational mode for the Sysdig agent. Valid values are 'monitor', 'monitor_light', 'troubleshooting', or null. The 'troubleshooting' mode enables additional metrics that are useful for debugging, such as HTTP request metrics (sysdig_container_net_http_url_request_count, sysdig_container_net_http_url_request_time, sysdig_container_net_http_url_error_count). Set to null to use the agent's default mode."
+  default     = null
+  validation {
+    condition     = var.agent_mode == null ? true : contains(["monitor", "monitor_light", "troubleshooting"], var.agent_mode)
+    error_message = "agent_mode must be one of 'monitor', 'monitor_light', 'troubleshooting', or null."
+  }
+}
+
 variable "cluster_shield_deploy" {
   type        = bool
   description = "Deploy the Cluster Shield component to provide runtime detection and policy enforcement for Kubernetes workloads. If enabled, a Kubernetes Deployment will be deployed to your cluster using helm."