Merge pull request #5 from sourcefuse/feature/signoz-external-values

Feature/signoz external values

Author: vijay-stephen

docs/arc-iac-docs/modules/terraform-aws-ref-arch-observability-stack/README.md

@@ -238,8 +238,8 @@ No resources.
 | <a name="input_namespace"></a> [namespace](#input\_namespace) | Namespace for the resources. | `string` | n/a | yes |
 | <a name="input_prometheus_config"></a> [prometheus\_config](#input\_prometheus\_config) | Configuration settings for deploying Prometheus | <pre>object({<br>    name = optional(string, "prometheus")<br>    k8s_namespace = object({<br>      name   = optional(string, "metrics")<br>      create = optional(bool, true)<br>    })<br>    log_level                 = optional(string, "info")<br>    replica_count             = optional(number, 1)<br>    storage                   = optional(string, "8Gi")<br>    storage_class             = optional(string, "gp2")<br>    enable_kube_state_metrics = optional(bool, true)<br>    enable_node_exporter      = optional(bool, true)<br>    cpu_limit                 = optional(string, "100m")<br>    memory_limit              = optional(string, "512Mi")<br>    cpu_request               = optional(string, "100m")<br>    memory_request            = optional(string, "128Mi")<br>    retention_period          = optional(string, "15d")<br><br>    grafana_config = object({<br>      name                = optional(string, "grafana")<br>      replica_count       = optional(number, 1)<br>      ingress_enabled     = optional(bool, false)<br>      lb_visibility       = optional(string, "internet-facing") # Options: "internal" or "internet-facing"<br>      aws_certificate_arn = optional(string, "")<br>      ingress_host        = optional(string, "")<br>      admin_user          = optional(string, "admin")<br>      cpu_limit           = optional(string, "100m")<br>      memory_limit        = optional(string, "128Mi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "128Mi")<br>      dashboard_list = optional(list(object({<br>        name = string<br>        json = string<br>      })), [])<br>    })<br><br>    blackbox_exporter_config = object({<br>      name           = optional(string, "blackbox-exporter")<br>      replica_count  = optional(number, 1)<br>      cpu_limit      = optional(string, "100m")<br>      memory_limit   = optional(string, "500Mi")<br>      cpu_request    = optional(string, "100m")<br>      memory_request = optional(string, "50Mi")<br>      monitoring_targets = list(object({<br>        name                     = string                         # Target name (e.g., google)<br>        url                      = string                         # URL to monitor (e.g., https://google.com)<br>        scrape_interval          = optional(string, "60s")        # Scrape interval (e.g., 60s)<br>        scrape_timeout           = optional(string, "60s")        # Scrape timeout (e.g., 60s)<br>        status_code_pattern_list = optional(string, "[http_2xx]") # Blackbox module to use (e.g., http_2xx)<br>      }))<br>    })<br><br>    alertmanager_config = object({<br>      name                        = optional(string, "alertmanager")<br>      replica_count               = optional(number, 1)<br>      cpu_limit                   = optional(string, "100m")<br>      memory_limit                = optional(string, "128Mi")<br>      cpu_request                 = optional(string, "10m")<br>      memory_request              = optional(string, "32Mi")<br>      custom_alerts               = optional(string, "")<br>      alert_notification_settings = optional(string, "")<br>    })<br>  })</pre> | <pre>{<br>  "alertmanager_config": {<br>    "name": "alertmanager"<br>  },<br>  "blackbox_exporter_config": {<br>    "monitoring_targets": [],<br>    "name": "blackbox-exporter"<br>  },<br>  "enable_kube_state_metrics": true,<br>  "enable_node_exporter": true,<br>  "grafana_config": {<br>    "admin_user": "admin",<br>    "ingress_enabled": false,<br>    "lb_visibility": "internet-facing",<br>    "prometheus_endpoint": "prometheus"<br>  },<br>  "k8s_namespace": {<br>    "create": true,<br>    "name": "metrics"<br>  },<br>  "log_level": "info",<br>  "replica_count": 1,<br>  "resources": {<br>    "cpu_limit": "100m",<br>    "cpu_request": "100m",<br>    "memory_limit": "512Mi",<br>    "memory_request": "128Mi"<br>  },<br>  "retention_period": "15d",<br>  "storage": "8Gi"<br>}</pre> | no |
 | <a name="input_search_engine"></a> [search\_engine](#input\_search\_engine) | (optional) Search engine for logs | `string` | `null` | no |
-| <a name="input_signoz_config"></a> [signoz\_config](#input\_signoz\_config) | Configuration for observability components in the monitoring stack. This variable encapsulates<br>settings for the following components:<br><br>- ClickHouse:<br>  Used as the backend storage engine for observability data (like traces and metrics).<br>  Includes credentials and resource limits/requests for tuning performance.<br><br>- SigNoz:<br>  Provides the UI and analytics for monitoring and tracing applications.<br>  Includes ingress setup and compute resource configuration.<br><br>- Alertmanager:<br>  Handles alerting rules and notifications for monitoring data.<br>  Includes configuration for storage, scaling, and ingress settings.<br><br>- OTEL Collector:<br>  Collects telemetry data (logs, metrics, traces) from the applications and<br>  routes it to appropriate backends.<br>  Includes resource definitions and optional ingress configuration.<br><br>This structure enables centralized management of observability stack deployment in Kubernetes<br>via Terraform. | <pre>object({<br>    k8s_namespace = object({<br>      name   = optional(string, "signoz")<br>      create = optional(bool, false)<br>    })<br>    name          = optional(string, "signoz")<br>    storage_class = optional(string, "gp3")<br>    cluster_name  = string<br>    clickhouse = optional(object({<br>      user           = optional(string, "admin")<br>      cpu_limit      = optional(string, "2000m")<br>      memory_limit   = optional(string, "4Gi")<br>      cpu_request    = optional(string, "100m")<br>      memory_request = optional(string, "200Mi")<br>      storage        = optional(string, "20Gi")<br>    }))<br><br>    signoz_bin = optional(object({<br>      replica_count       = optional(number, 1)<br>      cpu_limit           = optional(string, "750m")<br>      memory_limit        = optional(string, "1000Mi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "200Mi")<br>      ingress_enabled     = optional(bool, false)<br>      aws_certificate_arn = optional(string, null)<br>      domain              = string<br>      root_domain         = optional(string, null)              // if root domain is provided, it creates DNS record<br>      lb_visibility       = optional(string, "internet-facing") # Options: "internal" or "internet-facing"<br>    }))<br><br>    alertmanager = optional(object({<br>      enable              = optional(bool, false)<br>      replica_count       = optional(number, 1)<br>      cpu_limit           = optional(string, "750m")<br>      memory_limit        = optional(string, "1000Mi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "200Mi")<br>      storage             = optional(string, "100Mi")<br>      enable_ingress      = optional(bool, false)<br>      aws_certificate_arn = optional(string, null)<br>      domain              = optional(string, "signoz.example.com")<br>    }))<br><br>    otel_collector = optional(object({<br>      cpu_limit           = optional(string, "1")<br>      memory_limit        = optional(string, "2Gi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "200Mi")<br>      storage             = optional(string, "100Mi")<br>      enable_ingress      = optional(bool, false)<br>      aws_certificate_arn = optional(string, null)<br>      domain              = optional(string, "signoz.example.com")<br>    }))<br>  })</pre> | <pre>{<br>  "cluster_name": null,<br>  "k8s_namespace": {<br>    "create": true,<br>    "name": "signoz"<br>  },<br>  "name": null<br>}</pre> | no |
-| <a name="input_signoz_infra_monitor_config"></a> [signoz\_infra\_monitor\_config](#input\_signoz\_infra\_monitor\_config) | Configuration object for deploying SigNoz infrastructure monitoring components.<br><br>Attributes:<br>- name: A name identifier for the monitoring deployment (used in naming resources).<br>- storage\_class: (Optional) The Kubernetes storage class to be used for persistent volumes. Defaults to "gp3".<br>- cluster\_name: The name of the Kubernetes cluster where SigNoz is being deployed.<br>- otel\_collector\_endpoint: The endpoint URL for the OpenTelemetry Collector to which metrics, logs, and traces will be exported.<br>- metric\_collection\_interval: (Optional) The interval at which metrics are collected. Defaults to "30s".<br>- if any one ofr the values enable\_log\_collection,enable\_metrics\_collection is true, then helm chart gets installed<br><br>This variable is used to centralize configuration related to monitoring infrastructure via SigNoz. | <pre>object({<br>    k8s_namespace = optional(object({<br>      name   = optional(string, "signoz")<br>      create = optional(bool, false)<br>    }))<br>    name                       = string<br>    storage_class              = optional(string, "gp3")<br>    cluster_name               = string<br>    enable_log_collection      = optional(bool, false)<br>    enable_metrics_collection  = optional(bool, false)<br>    otel_collector_endpoint    = optional(string, null)<br>    metric_collection_interval = optional(string, "30s")<br>  })</pre> | <pre>{<br>  "cluster_name": null,<br>  "name": null<br>}</pre> | no |
+| <a name="input_signoz_config"></a> [signoz\_config](#input\_signoz\_config) | Configuration for observability components in the monitoring stack. This variable encapsulates<br>settings for the following components:<br><br>- ClickHouse:<br>  Used as the backend storage engine for observability data (like traces and metrics).<br>  Includes credentials and resource limits/requests for tuning performance.<br><br>- SigNoz:<br>  Provides the UI and analytics for monitoring and tracing applications.<br>  Includes ingress setup and compute resource configuration.<br><br>- Alertmanager:<br>  Handles alerting rules and notifications for monitoring data.<br>  Includes configuration for storage, scaling, and ingress settings.<br><br>- OTEL Collector:<br>  Collects telemetry data (logs, metrics, traces) from the applications and<br>  routes it to appropriate backends.<br>  Includes resource definitions and optional ingress configuration.<br><br>This structure enables centralized management of observability stack deployment in Kubernetes<br>via Terraform. | <pre>object({<br>    k8s_namespace = object({<br>      name   = optional(string, "signoz")<br>      create = optional(bool, false)<br>    })<br>    name          = optional(string, "signoz")<br>    storage_class = optional(string, "gp3")<br>    chart_version = optional(string, "0.78.0")<br>    chart_values  = optional(list(string), [])<br>    cluster_name  = string<br>    clickhouse = optional(object({<br>      user           = optional(string, "admin")<br>      cpu_limit      = optional(string, "2000m")<br>      memory_limit   = optional(string, "4Gi")<br>      cpu_request    = optional(string, "100m")<br>      memory_request = optional(string, "200Mi")<br>      storage        = optional(string, "20Gi")<br>    }))<br><br>    signoz_bin = optional(object({<br>      replica_count       = optional(number, 1)<br>      cpu_limit           = optional(string, "750m")<br>      memory_limit        = optional(string, "1000Mi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "200Mi")<br>      ingress_enabled     = optional(bool, false)<br>      aws_certificate_arn = optional(string, null)<br>      domain              = string<br>      root_domain         = optional(string, null)              // if root domain is provided, it creates DNS record<br>      lb_visibility       = optional(string, "internet-facing") # Options: "internal" or "internet-facing"<br>    }))<br><br>    alertmanager = optional(object({<br>      enable              = optional(bool, false)<br>      replica_count       = optional(number, 1)<br>      cpu_limit           = optional(string, "750m")<br>      memory_limit        = optional(string, "1000Mi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "200Mi")<br>      storage             = optional(string, "100Mi")<br>      enable_ingress      = optional(bool, false)<br>      aws_certificate_arn = optional(string, null)<br>      domain              = optional(string, "signoz.example.com")<br>    }))<br><br>    otel_collector = optional(object({<br>      cpu_limit           = optional(string, "1")<br>      memory_limit        = optional(string, "2Gi")<br>      cpu_request         = optional(string, "100m")<br>      memory_request      = optional(string, "200Mi")<br>      storage             = optional(string, "100Mi")<br>      enable_ingress      = optional(bool, false)<br>      aws_certificate_arn = optional(string, null)<br>      domain              = optional(string, "signoz.example.com")<br>    }))<br>  })</pre> | <pre>{<br>  "cluster_name": null,<br>  "k8s_namespace": {<br>    "create": true,<br>    "name": "signoz"<br>  },<br>  "name": null<br>}</pre> | no |
+| <a name="input_signoz_infra_monitor_config"></a> [signoz\_infra\_monitor\_config](#input\_signoz\_infra\_monitor\_config) | Configuration object for deploying SigNoz infrastructure monitoring components.<br><br>Attributes:<br>- name: A name identifier for the monitoring deployment (used in naming resources).<br>- storage\_class: (Optional) The Kubernetes storage class to be used for persistent volumes. Defaults to "gp3".<br>- cluster\_name: The name of the Kubernetes cluster where SigNoz is being deployed.<br>- otel\_collector\_endpoint: The endpoint URL for the OpenTelemetry Collector to which metrics, logs, and traces will be exported.<br>- metric\_collection\_interval: (Optional) The interval at which metrics are collected. Defaults to "30s".<br>- if any one ofr the values enable\_log\_collection,enable\_metrics\_collection is true, then helm chart gets installed<br><br>This variable is used to centralize configuration related to monitoring infrastructure via SigNoz. | <pre>object({<br>    k8s_namespace = optional(object({<br>      name   = optional(string, "signoz")<br>      create = optional(bool, false)<br>    }))<br>    name                       = string<br>    storage_class              = optional(string, "gp3")<br>    chart_version              = optional(string, "0.12.1")<br>    chart_values               = optional(list(string), [])<br>    cluster_name               = string<br>    enable_log_collection      = optional(bool, false)<br>    enable_metrics_collection  = optional(bool, false)<br>    otel_collector_endpoint    = optional(string, null)<br>    metric_collection_interval = optional(string, "30s")<br>  })</pre> | <pre>{<br>  "cluster_name": null,<br>  "name": null<br>}</pre> | no |
 | <a name="input_tags"></a> [tags](#input\_tags) | (optional) Tags for AWS resources | `map(string)` | `{}` | no |
 | <a name="input_tracing_stack"></a> [tracing\_stack](#input\_tracing\_stack) | (optional) Distributed tracing stack | `string` | `null` | no |