Integration gcp detectors firebase

docs/severity.md

@@ -73,6 +73,7 @@
 - [integration_gcp-cloud-sql-mysql](#integration_gcp-cloud-sql-mysql)
 - [integration_gcp-cloud-sql-postgresql](#integration_gcp-cloud-sql-postgresql)
 - [integration_gcp-compute-engine](#integration_gcp-compute-engine)
+- [integration_gcp-firebase](#integration_gcp-firebase)
 - [integration_gcp-load-balancing](#integration_gcp-load-balancing)
 - [integration_gcp-memorystore-redis](#integration_gcp-memorystore-redis)
 - [integration_gcp-pubsub-subscription](#integration_gcp-pubsub-subscription)
@@ -805,6 +806,15 @@
 |GCP GCE Instance disk throttled ops|X|X|-|-|-|
 
 
+## integration_gcp-firebase
+
+|Detector|Critical|Major|Minor|Warning|Info|
+|---|---|---|---|---|---|
+|Webcheck heartbeat|X|-|-|-|-|
+|GCP Firebase database firebase database load|X|X|-|-|-|
+|GCP Firebase database firebase database io utilization|X|X|-|-|-|
+
+
 ## integration_gcp-load-balancing
 
 |Detector|Critical|Major|Minor|Warning|Info|

modules/integration_gcp-firebase/README.md

@@ -0,0 +1,112 @@
+# GCP-FIREBASE 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-gcp-firebase" {
+  source = "github.com/claranet/terraform-signalfx-detectors.git//modules/integration_gcp-firebase?ref={revision}"
+
+  environment    = var.environment
+  notifications  = local.notifications
+  gcp_project_id = "fillme"
+}
+```
+
+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 along 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.tf](variables.tf) and [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 detailed 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|
+|---|---|---|---|---|---|
+|Webcheck heartbeat|X|-|-|-|-|
+|GCP Firebase database firebase database load|X|X|-|-|-|
+|GCP Firebase database firebase database io utilization|X|X|-|-|-|
+
+## How to collect required metrics?
+
+This module deploys detectors using metrics reported by the
+[GCP integration](https://docs.splunk.com/observability/en/gdi/get-data-in/connect/gcp/gcp-metrics.html) configurable
+with [this Terraform module](https://github.com/claranet/terraform-signalfx-integrations/tree/master/cloud/gcp).
+
+
+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.
+
+* `io/database_load`
+* `io/utilization`
+* `network/active_connections`
+
+
+
+
+## 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)
+* [Stackdriver metrics for Firebase](https://cloud.google.com/monitoring/api/metrics_gcp#gcp-firebasedatabase)
+* [Splunk Observability metrics](https://docs.splunk.com/observability/en/gdi/get-data-in/connect/gcp/gcp.html)

modules/integration_gcp-firebase/common-locals.tf

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

modules/integration_gcp-firebase/common-modules.tf

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

modules/integration_gcp-firebase/common-variables.tf

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

modules/integration_gcp-firebase/common-versions.tf

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

modules/integration_gcp-firebase/conf/00-heatbeat.yaml

@@ -0,0 +1,12 @@
+## Example
+module: webcheck
+name: heartbeat
+
+transformation: false
+aggregation: true
+
+signals:
+  signal:
+    metric: "network/active_connections"
+rules:
+  critical:

modules/integration_gcp-firebase/conf/01-database_load.yaml

@@ -0,0 +1,18 @@
+module: "GCP Firebase database"
+name: "Firebase database load"
+
+transformation: ".min(over='30m')"
+
+signals:
+  signal:
+    metric: "io/database_load"
+
+rules:
+  critical:
+    threshold: 10
+    comparator: ">"
+
+  major:
+    threshold: 5
+    comparator: ">"
+    dependency: "critical"

modules/integration_gcp-firebase/conf/02-io_utilization.yaml

@@ -0,0 +1,18 @@
+module: "GCP Firebase database"
+name: "Firebase database IO utilization"
+
+transformation: ".min(over='30m')"
+
+signals:
+  signal:
+    metric: "io/utilization"
+
+rules:
+  critical:
+    threshold: 10
+    comparator: ">"
+
+  major:
+    threshold: 5
+    comparator: ">"
+    dependency: "critical"

modules/integration_gcp-firebase/conf/readme.yaml

@@ -0,0 +1,5 @@
+documentations:
+  - name: Stackdriver metrics for Firebase
+    url: https://cloud.google.com/monitoring/api/metrics_gcp#gcp-firebasedatabase
+  - name: Splunk Observability metrics
+    url: https://docs.splunk.com/observability/en/gdi/get-data-in/connect/gcp/gcp.html

modules/integration_gcp-firebase/detectors-gen.tf

@@ -0,0 +1,108 @@
+resource "signalfx_detector" "heartbeat" {
+  name = format("%s %s", local.detector_name_prefix, "Webcheck heartbeat")
+
+  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
+    from signalfx.detectors.not_reporting import not_reporting
+    signal = data('network/active_connections', filter=${module.filtering.signalflow})${var.heartbeat_aggregation_function}.publish('signal')
+    not_reporting.detector(stream=signal, resource_identifier=None, duration='${var.heartbeat_timeframe}', auto_resolve_after='${local.heartbeat_auto_resolve_after}').publish('CRIT')
+EOF
+
+  rule {
+    description           = "has not reported in ${var.heartbeat_timeframe}"
+    severity              = "Critical"
+    detect_label          = "CRIT"
+    disabled              = coalesce(var.heartbeat_disabled, var.detectors_disabled)
+    notifications         = try(coalescelist(lookup(var.heartbeat_notifications, "critical", []), var.notifications.critical), null)
+    runbook_url           = try(coalesce(var.heartbeat_runbook_url, var.runbook_url), "")
+    tip                   = var.heartbeat_tip
+    parameterized_subject = var.message_subject == "" ? local.rule_subject_novalue : var.message_subject
+    parameterized_body    = var.message_body == "" ? local.rule_body : var.message_body
+  }
+
+  max_delay = var.heartbeat_max_delay
+}
+
+resource "signalfx_detector" "firebase_database_load" {
+  name = format("%s %s", local.detector_name_prefix, "GCP Firebase database firebase database load")
+
+  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
+    signal = data('io/database_load', filter=${module.filtering.signalflow})${var.firebase_database_load_aggregation_function}${var.firebase_database_load_transformation_function}.publish('signal')
+    detect(when(signal > ${var.firebase_database_load_threshold_critical}%{if var.firebase_database_load_lasting_duration_critical != null}, lasting='${var.firebase_database_load_lasting_duration_critical}', at_least=${var.firebase_database_load_at_least_percentage_critical}%{endif})).publish('CRIT')
+    detect(when(signal > ${var.firebase_database_load_threshold_major}%{if var.firebase_database_load_lasting_duration_major != null}, lasting='${var.firebase_database_load_lasting_duration_major}', at_least=${var.firebase_database_load_at_least_percentage_major}%{endif}) and (not when(signal > ${var.firebase_database_load_threshold_critical}%{if var.firebase_database_load_lasting_duration_critical != null}, lasting='${var.firebase_database_load_lasting_duration_critical}', at_least=${var.firebase_database_load_at_least_percentage_critical}%{endif}))).publish('MAJOR')
+EOF
+
+  rule {
+    description           = "is too high > ${var.firebase_database_load_threshold_critical}"
+    severity              = "Critical"
+    detect_label          = "CRIT"
+    disabled              = coalesce(var.firebase_database_load_disabled_critical, var.firebase_database_load_disabled, var.detectors_disabled)
+    notifications         = try(coalescelist(lookup(var.firebase_database_load_notifications, "critical", []), var.notifications.critical), null)
+    runbook_url           = try(coalesce(var.firebase_database_load_runbook_url, var.runbook_url), "")
+    tip                   = var.firebase_database_load_tip
+    parameterized_subject = var.message_subject == "" ? local.rule_subject : var.message_subject
+    parameterized_body    = var.message_body == "" ? local.rule_body : var.message_body
+  }
+
+  rule {
+    description           = "is too high > ${var.firebase_database_load_threshold_major}"
+    severity              = "Major"
+    detect_label          = "MAJOR"
+    disabled              = coalesce(var.firebase_database_load_disabled_major, var.firebase_database_load_disabled, var.detectors_disabled)
+    notifications         = try(coalescelist(lookup(var.firebase_database_load_notifications, "major", []), var.notifications.major), null)
+    runbook_url           = try(coalesce(var.firebase_database_load_runbook_url, var.runbook_url), "")
+    tip                   = var.firebase_database_load_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.firebase_database_load_max_delay
+}
+
+resource "signalfx_detector" "firebase_database_io_utilization" {
+  name = format("%s %s", local.detector_name_prefix, "GCP Firebase database firebase database io utilization")
+
+  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
+    signal = data('io/utilization', filter=${module.filtering.signalflow})${var.firebase_database_io_utilization_aggregation_function}${var.firebase_database_io_utilization_transformation_function}.publish('signal')
+    detect(when(signal > ${var.firebase_database_io_utilization_threshold_critical}%{if var.firebase_database_io_utilization_lasting_duration_critical != null}, lasting='${var.firebase_database_io_utilization_lasting_duration_critical}', at_least=${var.firebase_database_io_utilization_at_least_percentage_critical}%{endif})).publish('CRIT')
+    detect(when(signal > ${var.firebase_database_io_utilization_threshold_major}%{if var.firebase_database_io_utilization_lasting_duration_major != null}, lasting='${var.firebase_database_io_utilization_lasting_duration_major}', at_least=${var.firebase_database_io_utilization_at_least_percentage_major}%{endif}) and (not when(signal > ${var.firebase_database_io_utilization_threshold_critical}%{if var.firebase_database_io_utilization_lasting_duration_critical != null}, lasting='${var.firebase_database_io_utilization_lasting_duration_critical}', at_least=${var.firebase_database_io_utilization_at_least_percentage_critical}%{endif}))).publish('MAJOR')
+EOF
+
+  rule {
+    description           = "is too high > ${var.firebase_database_io_utilization_threshold_critical}"
+    severity              = "Critical"
+    detect_label          = "CRIT"
+    disabled              = coalesce(var.firebase_database_io_utilization_disabled_critical, var.firebase_database_io_utilization_disabled, var.detectors_disabled)
+    notifications         = try(coalescelist(lookup(var.firebase_database_io_utilization_notifications, "critical", []), var.notifications.critical), null)
+    runbook_url           = try(coalesce(var.firebase_database_io_utilization_runbook_url, var.runbook_url), "")
+    tip                   = var.firebase_database_io_utilization_tip
+    parameterized_subject = var.message_subject == "" ? local.rule_subject : var.message_subject
+    parameterized_body    = var.message_body == "" ? local.rule_body : var.message_body
+  }
+
+  rule {
+    description           = "is too high > ${var.firebase_database_io_utilization_threshold_major}"
+    severity              = "Major"
+    detect_label          = "MAJOR"
+    disabled              = coalesce(var.firebase_database_io_utilization_disabled_major, var.firebase_database_io_utilization_disabled, var.detectors_disabled)
+    notifications         = try(coalescelist(lookup(var.firebase_database_io_utilization_notifications, "major", []), var.notifications.major), null)
+    runbook_url           = try(coalesce(var.firebase_database_io_utilization_runbook_url, var.runbook_url), "")
+    tip                   = var.firebase_database_io_utilization_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.firebase_database_io_utilization_max_delay
+}
+

modules/integration_gcp-firebase/filters.tf

@@ -0,0 +1,3 @@
+locals {
+  filters = "filter('project_id', '${var.gcp_project_id}')"
+}

modules/integration_gcp-firebase/outputs.tf

@@ -0,0 +1,15 @@
+output "firebase_database_io_utilization" {
+  description = "Detector resource for firebase_database_io_utilization"
+  value       = signalfx_detector.firebase_database_io_utilization
+}
+
+output "firebase_database_load" {
+  description = "Detector resource for firebase_database_load"
+  value       = signalfx_detector.firebase_database_load
+}
+
+output "heartbeat" {
+  description = "Detector resource for heartbeat"
+  value       = signalfx_detector.heartbeat
+}
+

modules/integration_gcp-firebase/tags.tf

@@ -0,0 +1,4 @@
+locals {
+  tags = ["integration", "gcp-firebase"]
+}
+