integration_azure-automation-account

docs/severity.md

@@ -31,6 +31,7 @@
 - [integration_azure-app-service-plan](#integration_azure-app-service-plan)
 - [integration_azure-app-service](#integration_azure-app-service)
 - [integration_azure-application-gateway](#integration_azure-application-gateway)
+- [integration_azure-automation-account](#integration_azure-automation-account)
 - [integration_azure-azure-search](#integration_azure-azure-search)
 - [integration_azure-container-instance](#integration_azure-container-instance)
 - [integration_azure-cosmos-db](#integration_azure-cosmos-db)
@@ -380,6 +381,13 @@
 |Azure Application Gateway capacity units|-|X|-|-|-|
 
 
+## integration_azure-automation-account
+
+|Detector|Critical|Major|Minor|Warning|Info|
+|---|---|---|---|---|---|
+|Azure Automation Account failed jobs|X|-|-|-|-|
+
+
 ## integration_azure-azure-search
 
 |Detector|Critical|Major|Minor|Warning|Info|

modules/integration_azure-automation-account/README.md

@@ -0,0 +1,106 @@
+# AZURE-AUTOMATION-ACCOUNT SignalFx detectors
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+:link: **Contents**
+
+- [How to use this module?](#how-to-use-this-module)
+- [What are the available detectors in this module?](#what-are-the-available-detectors-in-this-module)
+- [How to collect required metrics?](#how-to-collect-required-metrics)
+  - [Metrics](#metrics)
+- [Related documentation](#related-documentation)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## How to use this module?
+
+This directory defines a [Terraform](https://www.terraform.io/)
+[module](https://www.terraform.io/language/modules/syntax) you can use in your
+existing [stack](https://github.com/claranet/terraform-signalfx-detectors/wiki/Getting-started#stack) by adding a
+`module` configuration and setting its `source` parameter to URL of this folder:
+
+```hcl
+module "signalfx-detectors-integration-azure-automation-account" {
+  source = "github.com/claranet/terraform-signalfx-detectors.git//modules/integration_azure-automation-account?ref={revision}"
+
+  environment   = var.environment
+  notifications = local.notifications
+}
+```
+
+Note the following parameters:
+
+* `source`: Use this parameter to specify the URL of the module. The double slash (`//`) is intentional  and required.
+  Terraform uses it to specify subfolders within a Git repo (see [module
+  sources](https://www.terraform.io/language/modules/sources)). The `ref` parameter specifies a specific Git tag in
+  this repository. It is recommended to use the latest "pinned" version in place of `{revision}`. Avoid using a branch
+  like `master` except for testing purpose. Note that every modules in this repository are available on the Terraform
+  [registry](https://registry.terraform.io/modules/claranet/detectors/signalfx) and we recommend using it as source
+  instead of `git` which is more flexible but less future-proof.
+
+* `environment`: Use this parameter to specify the
+  [environment](https://github.com/claranet/terraform-signalfx-detectors/wiki/Getting-started#environment) used by this
+  instance of the module.
+  Its value will be added to the `prefixes` list at the start of the [detector
+  name](https://github.com/claranet/terraform-signalfx-detectors/wiki/Templating#example).
+  In general, it will also be used in the `filtering` internal sub-module to [apply
+  filters](https://github.com/claranet/terraform-signalfx-detectors/wiki/Guidance#filtering) based on our default
+  [tagging convention](https://github.com/claranet/terraform-signalfx-detectors/wiki/Tagging-convention) by default.
+
+* `notifications`: Use this parameter to define where alerts should be sent depending on their severity. It consists
+  of a Terraform [object](https://www.terraform.io/language/expressions/type-constraints#object) where each key represents an available
+  [detector rule severity](https://docs.splunk.com/observability/alerts-detectors-notifications/create-detectors-for-alerts.html#severity)
+  and its value is a list of recipients. Every recipients must respect the [detector notification
+  format](https://registry.terraform.io/providers/splunk-terraform/signalfx/latest/docs/resources/detector#notification-format).
+  Check the [notification binding](https://github.com/claranet/terraform-signalfx-detectors/wiki/Notifications-binding)
+  documentation to understand the recommended role of each severity.
+
+These 3 parameters alongs with all variables defined in [common-variables.tf](common-variables.tf) are common to all
+[modules](../) in this repository. Other variables, specific to this module, are available in
+[variables-gen.tf](variables-gen.tf).
+In general, the default configuration "works" but all of these Terraform
+[variables](https://www.terraform.io/language/values/variables) make it possible to
+customize the detectors behavior to better fit your needs.
+
+Most of them represent usual tips and rules detailled in the
+[guidance](https://github.com/claranet/terraform-signalfx-detectors/wiki/Guidance) documentation and listed in the
+common [variables](https://github.com/claranet/terraform-signalfx-detectors/wiki/Variables) dedicated documentation.
+
+Feel free to explore the [wiki](https://github.com/claranet/terraform-signalfx-detectors/wiki) for more information about
+general usage of this repository.
+
+## What are the available detectors in this module?
+
+This module creates the following SignalFx detectors which could contain one or multiple alerting rules:
+
+|Detector|Critical|Major|Minor|Warning|Info|
+|---|---|---|---|---|---|
+|Azure Automation Account failed jobs|X|-|-|-|-|
+
+## How to collect required metrics?
+
+This module deploys detectors using metrics reported by the
+[Azure integration](https://docs.splunk.com/Observability/gdi/get-data-in/connect/azure/azure.html) configurable
+with [this Terraform module](https://github.com/claranet/terraform-signalfx-integrations/tree/master/cloud/azure).
+
+
+Check the [Related documentation](#related-documentation) section for more detailed and specific information about this module dependencies.
+
+
+
+### Metrics
+
+
+Here is the list of required metrics for detectors in this module.
+
+* `TotalJob`
+
+
+
+
+## Related documentation
+
+* [Terraform SignalFx provider](https://registry.terraform.io/providers/splunk-terraform/signalfx/latest/docs)
+* [Terraform SignalFx detector](https://registry.terraform.io/providers/splunk-terraform/signalfx/latest/docs/resources/detector)
+* [Splunk Observability integrations](https://docs.splunk.com/Observability/gdi/get-data-in/integrations.html)
+* [Azure Monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported#microsoftautomationautomationaccounts)

modules/integration_azure-automation-account/common-filters.tf

@@ -0,0 +1 @@
+../../common/module/filters-integration-azure.tf

modules/integration_azure-automation-account/common-locals.tf

@@ -0,0 +1 @@
+../../common/module/locals.tf

modules/integration_azure-automation-account/common-modules.tf

@@ -0,0 +1 @@
+../../common/module/modules.tf

modules/integration_azure-automation-account/common-variables.tf

@@ -0,0 +1 @@
+../../common/module/variables.tf

modules/integration_azure-automation-account/common-versions.tf

@@ -0,0 +1 @@
+../../common/module/versions.tf

modules/integration_azure-automation-account/conf/01-jobs.yaml

@@ -0,0 +1,22 @@
+## Example
+module: Azure Automation Account
+name: "failed jobs"
+
+transformation: ".max(over='1h')"
+aggregation: ".mean(by=['runbook'])"
+
+filtering: "filter('resource_type', 'Microsoft.Automation/automationAccounts') and filter('primary_aggregation_type', 'true')"
+
+signals:
+  success:
+    metric: "TotalJob"
+    filter: "filter('status', 'Completed')"
+  failed:
+    metric: "TotalJob"
+    filter: "filter('status', 'Failed')"
+  signal:
+    formula: (failed.fill(0) - success.fill(0))
+rules:
+  critical:
+    threshold: 0
+    comparator: ">"

modules/integration_azure-automation-account/conf/readme.yaml

@@ -0,0 +1,4 @@
+documentations:
+    - name: 'Azure Monitor'
+      url: 'https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported#microsoftautomationautomationaccounts'
+source_doc:

modules/integration_azure-automation-account/detectors-gen.tf

@@ -0,0 +1,30 @@
+resource "signalfx_detector" "failed_jobs" {
+  name = format("%s %s", local.detector_name_prefix, "Azure Automation Account failed jobs")
+
+  authorized_writer_teams = var.authorized_writer_teams
+  teams                   = try(coalescelist(var.teams, var.authorized_writer_teams), null)
+  tags                    = compact(concat(local.common_tags, local.tags, var.extra_tags))
+
+  program_text = <<-EOF
+    base_filtering = filter('resource_type', 'Microsoft.Automation/automationAccounts') and filter('primary_aggregation_type', 'true')
+    success = data('TotalJob', filter=base_filtering and filter('status', 'Completed') and ${module.filtering.signalflow})${var.failed_jobs_aggregation_function}${var.failed_jobs_transformation_function}
+    failed = data('TotalJob', filter=base_filtering and filter('status', 'Failed') and ${module.filtering.signalflow})${var.failed_jobs_aggregation_function}${var.failed_jobs_transformation_function}
+    signal = (failed.fill(0) - success.fill(0)).publish('signal')
+    detect(when(signal > ${var.failed_jobs_threshold_critical}, lasting=%{if var.failed_jobs_lasting_duration_critical == null}None%{else}'${var.failed_jobs_lasting_duration_critical}'%{endif}, at_least=${var.failed_jobs_at_least_percentage_critical})).publish('CRIT')
+EOF
+
+  rule {
+    description           = "is too high > ${var.failed_jobs_threshold_critical}"
+    severity              = "Critical"
+    detect_label          = "CRIT"
+    disabled              = coalesce(var.failed_jobs_disabled, var.detectors_disabled)
+    notifications         = try(coalescelist(lookup(var.failed_jobs_notifications, "critical", []), var.notifications.critical), null)
+    runbook_url           = try(coalesce(var.failed_jobs_runbook_url, var.runbook_url), "")
+    tip                   = var.failed_jobs_tip
+    parameterized_subject = var.message_subject == "" ? local.rule_subject : var.message_subject
+    parameterized_body    = var.message_body == "" ? local.rule_body : var.message_body
+  }
+
+  max_delay = var.failed_jobs_max_delay
+}
+

modules/integration_azure-automation-account/outputs.tf

@@ -0,0 +1,5 @@
+output "failed_jobs" {
+  description = "Detector resource for failed_jobs"
+  value       = signalfx_detector.failed_jobs
+}
+

modules/integration_azure-automation-account/tags.tf

@@ -0,0 +1,4 @@
+locals {
+  tags = ["integration", "azure-automation-account"]
+}
+

modules/integration_azure-automation-account/variables-gen.tf

@@ -0,0 +1,61 @@
+# failed_jobs detector
+
+variable "failed_jobs_notifications" {
+  description = "Notification recipients list per severity overridden for failed_jobs detector"
+  type        = map(list(string))
+  default     = {}
+}
+
+variable "failed_jobs_aggregation_function" {
+  description = "Aggregation function and group by for failed_jobs detector (i.e. \".mean(by=['host'])\")"
+  type        = string
+  default     = ".mean(by=['runbook'])"
+}
+
+variable "failed_jobs_transformation_function" {
+  description = "Transformation function for failed_jobs detector (i.e. \".mean(over='5m')\")"
+  type        = string
+  default     = ".max(over='1h')"
+}
+
+variable "failed_jobs_max_delay" {
+  description = "Enforce max delay for failed_jobs detector (use \"0\" or \"null\" for \"Auto\")"
+  type        = number
+  default     = null
+}
+
+variable "failed_jobs_tip" {
+  description = "Suggested first course of action or any note useful for incident handling"
+  type        = string
+  default     = ""
+}
+
+variable "failed_jobs_runbook_url" {
+  description = "URL like SignalFx dashboard or wiki page which can help to troubleshoot the incident cause"
+  type        = string
+  default     = ""
+}
+
+variable "failed_jobs_disabled" {
+  description = "Disable all alerting rules for failed_jobs detector"
+  type        = bool
+  default     = null
+}
+
+variable "failed_jobs_threshold_critical" {
+  description = "Critical threshold for failed_jobs detector"
+  type        = number
+  default     = 0
+}
+
+variable "failed_jobs_lasting_duration_critical" {
+  description = "Minimum duration that conditions must be true before raising alert"
+  type        = string
+  default     = null
+}
+
+variable "failed_jobs_at_least_percentage_critical" {
+  description = "Percentage of lasting that conditions must be true before raising alert (>= 0.0 and <= 1.0)"
+  type        = number
+  default     = 1
+}