update read me for detector firebase database

claranet · Dec 16, 2024 · 1a9ec69 · 1a9ec69
1 parent 0d61cfe
commit 1a9ec69
Show file tree

Hide file tree

Showing 2 changed files with 109 additions and 0 deletions.
diff --git a/modules/integration_gcp-firebase/README.md b/modules/integration_gcp-firebase/README.md
@@ -8,6 +8,10 @@
 - [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)
+- [Notes](#notes)
+  - [Metadata configuration for default filtering](#metadata-configuration-for-default-filtering)
+  - [Database load](#database-load)
+  - [Database IO](#database-io)
 - [Related documentation](#related-documentation)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -101,6 +105,59 @@ Here is the list of required metrics for detectors in this module.
 * `network/active_connections`
 
 
+## Notes
+
+
+### Metadata configuration for default filtering
+
+label to use : 
+
+sfx_env = true
+sfx_monitored = true
+
+### Database load
+
+Monitoring the CPU utilization helps in understanding the system's capability and efficiency.
+
+```hcl
+module "signalfx-detectors-integration_gcp-cloud-run" {
+  source = "github.com/claranet/terraform-signalfx-detectors.git//modules/integration_gcp-firebase"
+
+  environment    = var.environment
+  gcp_project_id = var.project_id
+  notifications  = local.notifications
+
+  # We keep default filtering policy here, we just want to append additional filter to it
+  filtering_append = true
+  # We define the additional filter
+  filtering_custom = "filter('service_name', '*service-name*')"
+  # We can configure the thresholds of the probes
+  firebase_database_load_threshold_critical = 5
+  firebase_database_load_threshold_major    = 3
+}
+```
+
+### Database IO
+
+Monitoring the IO of the database helps in understanding the system's capability and efficiency.
+
+```hcl                                                                                                                                                                                                                                                                                                              
+module "signalfx-detectors-integration_gcp-cloud-run" {                                                                                                                                                                                                                                                             
+  source = "github.com/claranet/terraform-signalfx-detectors.git//modules/integration_gcp-firebase"                                                                                                                                                                                                                 
+                                                                                                                                                                                                                                                                                                                    
+  environment    = var.environment                                                                                                                                                                                                                                                                                  
+  gcp_project_id = var.project_id                                                                                                                                                                                                                                                                                   
+  notifications  = local.notifications                                                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                                                                                    
+  # We keep default filtering policy here, we just want to append additional filter to it                                                                                                                                                                                                                           
+  filtering_append = true                                                                                                                                                                                                                                                                                           
+  # We define the additional filter                                                                                                                                                                                                                                                                                 
+  filtering_custom = "filter('service_name', '*service-name*')"                                                                                                                                                                                                                                                     
+  # We can configure the thresholds of the probes                                                                                                                                                                                                                                                                   
+  firebase_database_io_utilization_threshold_critical = 5                                                                                                                                                                                                                                                                     
+  firebase_database_io_utilization_threshold_major    = 3                                                                                                                                                                                                                                                                     
+}                                                                                                                                                                                                                                                                                                                   
+```  
 
 
 ## Related documentation

diff --git a/modules/integration_gcp-firebase/conf/readme.yaml b/modules/integration_gcp-firebase/conf/readme.yaml
@@ -3,3 +3,55 @@ documentations:
     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
+notes: |
+
+  ### Metadata configuration for default filtering
+
+  label to use : 
+
+  sfx_env = true
+  sfx_monitored = true
+
+  ### Database load
+
+  Monitoring the CPU utilization helps in understanding the system's capability and efficiency.
+
+  ```hcl
+  module "signalfx-detectors-integration_gcp-cloud-run" {
+    source = "github.com/claranet/terraform-signalfx-detectors.git//modules/integration_gcp-firebase"
+
+    environment    = var.environment
+    gcp_project_id = var.project_id
+    notifications  = local.notifications
+
+    # We keep default filtering policy here, we just want to append additional filter to it
+    filtering_append = true
+    # We define the additional filter
+    filtering_custom = "filter('service_name', '*service-name*')"
+    # We can configure the thresholds of the probes
+    firebase_database_load_threshold_critical = 5
+    firebase_database_load_threshold_major    = 3
+  }
+  ```
+
+  ### Database IO
+
+  Monitoring the IO of the database helps in understanding the system's capability and efficiency.
+
+  ```hcl                                                                                                                                                                                                                                                                                                              
+  module "signalfx-detectors-integration_gcp-cloud-run" {                                                                                                                                                                                                                                                             
+    source = "github.com/claranet/terraform-signalfx-detectors.git//modules/integration_gcp-firebase"                                                                                                                                                                                                                 
+                                                                                                                                                                                                                                                                                                                      
+    environment    = var.environment                                                                                                                                                                                                                                                                                  
+    gcp_project_id = var.project_id                                                                                                                                                                                                                                                                                   
+    notifications  = local.notifications                                                                                                                                                                                                                                                                              
+                                                                                                                                                                                                                                                                                                                      
+    # We keep default filtering policy here, we just want to append additional filter to it                                                                                                                                                                                                                           
+    filtering_append = true                                                                                                                                                                                                                                                                                           
+    # We define the additional filter                                                                                                                                                                                                                                                                                 
+    filtering_custom = "filter('service_name', '*service-name*')"                                                                                                                                                                                                                                                     
+    # We can configure the thresholds of the probes                                                                                                                                                                                                                                                                   
+    firebase_database_io_utilization_threshold_critical = 5                                                                                                                                                                                                                                                                     
+    firebase_database_io_utilization_threshold_major    = 3                                                                                                                                                                                                                                                                     
+  }                                                                                                                                                                                                                                                                                                                   
+  ```