MON-78: Readme

cloud/azure/stream-analytics/README.md

@@ -0,0 +1,39 @@
+Azure Stream Analytics DataDog monitors
+=======================================
+
+How to use this module
+----------------------
+
+```
+module "datadog-monitors-azure-redis" {
+  source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/azure/stream-analytics?ref={revision}"
+
+  message = "${module.datadog-message-alerting.alerting-message}"
+
+  environment = "${var.environment}"
+}
+```
+
+Inputs
+------
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| conversion_errors_threshold_critical |  | string | `10` | no |
+| conversion_errors_threshold_warning |  | string | `0` | no |
+| delay | Delay in seconds for the metric evaluation | string | `600` | no |
+| environment | Architecture environment | string | - | yes |
+| function_requests_threshold_critical |  | string | `10` | no |
+| function_requests_threshold_warning |  | string | `0` | no |
+| message | Message sent when a monitor is triggered | string | - | yes |
+| notify_no_data |  | string | `false` | no |
+| runtime_errors_threshold_critical |  | string | `10` | no |
+| runtime_errors_threshold_warning |  | string | `0` | no |
+| su_utilization_threshold_critical |  | string | `80` | no |
+| su_utilization_threshold_warning | Monitor specific | string | `60` | no |
+| use_filter_tags | Filter the data with service tags if true | string | `true` | no |
+
+Related documentation
+---------------------
+
+DataDog documentation: [https://docs.datadoghq.com/integrations/azure/](https://docs.datadoghq.com/integrations/azure/)

cloud/azure/stream-analytics/inputs.tf

@@ -1,19 +1,29 @@
-variable "message" {}
+# Global Terraform
+variable "environment" {
+  description = "Architecture environment"
+  type        = "string"
+}
 
-variable "environment" {}
+variable "message" {
+  description = "Message sent when a monitor is triggered"
+}
+
+# Global DataDog
+variable "use_filter_tags" {
+  description = "Filter the data with service tags if true"
+  default     = "true"
+}
 
 variable "notify_no_data" {
   default = "false"
 }
 
-variable "use_filter_tags" {
-  default = "true"
-}
-
 variable "delay" {
-  default = "600"
+  description = "Delay in seconds for the metric evaluation"
+  default     = 600
 }
 
+# Monitor specific
 variable "su_utilization_threshold_warning" {
   default = 60
 }