DOCSP-43340 Monitoring and Alerts doc (#16)

kanchana-mongodb · fmenezes · web-flow · commit ea2a0c7f2d57 · 2024-11-01T12:17:45.000-07:00
* DOCSP-43340 Monitoring and Alerts doc * DOCSP-43340 updates for SS' feedback * Update source/includes/examples/cli-example-metrics-disk.rst Co-authored-by: Filipe Constantinov Menezes <fcmenezes87@gmail.com> * DOCSP-43340 updates for FM's feedback * DOCSP-43340 updates for EA's feedback * DOCSP-43340 updates for EA's feedback --------- Co-authored-by: Filipe Constantinov Menezes <fcmenezes87@gmail.com>
diff --git a/source/includes/examples/cli-example-alerts-connection-storms-stagingprod.rst b/source/includes/examples/cli-example-alerts-connection-storms-stagingprod.rst
@@ -0,0 +1,17 @@
+.. code-block::
+   :copyable: true
+
+   atlas alerts settings create \ 
+     --enabled \
+     --event "OUTSIDE_METRIC_THRESHOLD" \ 
+     --metricName CONNECTIONS \ 
+     --metricOperator LESS_THAN \ 
+     --metricThreshold 1 \ 
+     --metricUnits RAW \ 
+     --notificationType GROUP \ 
+     --notificationRole "GROUP_DATA_ACCESS_READ_ONLY","GROUP_CLUSTER_MANAGER","GROUP_DATA_ACCESS_ADMIN" \
+     --notificationEmailEnabled \ 
+     --notificationEmailAddress "user@example.com" \
+     --notificationIntervalMin 5 \ 
+     --projectId 6698000acf48197e089e4085 
+   
diff --git a/source/includes/examples/cli-example-alerts-no-primary-devtest.rst b/source/includes/examples/cli-example-alerts-no-primary-devtest.rst
@@ -0,0 +1,14 @@
+.. code-block::
+   :copyable: true
+
+   atlas alerts settings create \
+     --enabled \
+     --event "NO_PRIMARY" \
+     --matcherFieldName CLUSTER_NAME \
+     --matcherOperator EQUALS \
+     --matcherValue ftsTest \
+     --notificationType EMAIL \
+     --notificationEmailEnabled \
+     --notificationEmailAddress "myName@example.com" \
+     --notificationIntervalMin 5 \
+     --projectId 6698000acf48197e089e4085
diff --git a/source/includes/examples/cli-example-download-logs.rst b/source/includes/examples/cli-example-download-logs.rst
@@ -0,0 +1,5 @@
+.. code-block::
+   :copyable: true
+
+   atlas logs download atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net mongodb.gz --projectId 56fd11f25f23b33ef4c2a331 
+   
diff --git a/source/includes/examples/cli-example-metrics-disk-devtest.rst b/source/includes/examples/cli-example-metrics-disk-devtest.rst
@@ -0,0 +1,8 @@
+.. code-block:: 
+   :copyable: true
+
+   atlas metrics disks describe atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 data \
+     --granularity P1D \ 
+     --period P1D \
+     --type DISK_PARTITION_SPACE_FREE,DISK_PARTITION_SPACE_USED \
+     --projectId 6698000acf48197e089e4085 \
diff --git a/source/includes/examples/cli-example-metrics-disks.rst b/source/includes/examples/cli-example-metrics-disks.rst
@@ -0,0 +1,4 @@
+.. code-block::
+   :copyable: true
+
+   atlas metrics disks list atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 --projectId 56fd11f25f23b33ef4c2a331 
diff --git a/source/includes/examples/cli-example-metrics-processes-stagingprod.rst b/source/includes/examples/cli-example-metrics-processes-stagingprod.rst
@@ -0,0 +1,10 @@
+.. code-block::
+   :copyable: true
+
+   atlas metrics processes atlas-lnmtkm-shard-00-00.ajlj3.mongodb.net:27017 \ 
+     --projectId 56fd11f25f23b33ef4c2a331 \ 
+     --granularity PT1H \ 
+     --period P7D \ 
+     --type
+     CONNECTIONS,OPCOUNTER_DELETE,OPCOUNTER_INSERT,OPCOUNTER_QUERY,OPCOUNTER_UPDATE,TICKETS_AVAILABLE_READS,TICKETS_AVAILABLE_WRITE,CONNECTIONS,QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED,QUERY_TARGETING_SCANNED_PER_RETURNED,SYSTEM_CPU_GUEST,SYSTEM_CPU_IOWAIT,SYSTEM_CPU_IRQ,SYSTEM_CPU_KERNEL,SYSTEM_CPU_NICE,SYSTEM_CPU_SOFTIRQ,SYSTEM_CPU_STEAL,SYSTEM_CPU_USER \ 
+     --output json
diff --git a/source/includes/examples/cli-example-performance-advisor-enable-devtest.rst b/source/includes/examples/cli-example-performance-advisor-enable-devtest.rst
@@ -0,0 +1,5 @@
+.. code-block::
+   :copyable: true
+
+   atlas performanceAdvisor slowOperationThreshold enable --projectId 56fd11f25f23b33ef4c2a331 
+   
diff --git a/source/includes/examples/cli-example-return-suggested-indexes-stagingprod.rst b/source/includes/examples/cli-example-return-suggested-indexes-stagingprod.rst
@@ -0,0 +1,6 @@
+.. code-block::
+   :copyable: true
+
+   atlas performanceAdvisor suggestedIndexes list \
+     --projectId 56fd11f25f23b33ef4c2a331 \ 
+     --processName atlas-zqva9t-shard-00-02.2rnul.mongodb.net:27017
diff --git a/source/includes/examples/tf-example-alerts-no-primary-stagingprod.rst b/source/includes/examples/tf-example-alerts-no-primary-stagingprod.rst
@@ -0,0 +1,30 @@
+.. code-block:: 
+   :copyable: true
+
+   resource "mongodbatlas_alert_configuration" "test_alert_notification" {
+     project_id = var.atlas_project_id
+     event_type = "NO_PRIMARY"
+     enabled    = true
+
+     notification {
+       type_name     = "PROMETHEUS"
+       integration_id = mongodbatlas_third_party_integration.test_datadog.id # ID of the Atlas Prometheus integration
+     }
+
+     notification {
+       type_name     = "DATADOG"
+       integration_id = mongodbatlas_third_party_integration.test_prometheus.id # ID of the Atlas Datadog integration
+     }
+
+     matcher {
+       field_name = "REPLICA_SET_NAME"
+       operator   = "EQUALS"
+      value      = "myReplSet"
+     }
+
+     threshold_config {
+       operator    = "GREATER_THAN"
+       threshold   = 24
+       units       = "HOURS"
+     }
+   }
diff --git a/source/includes/examples/tf-example-alerts-replication-lag-devtest.rst b/source/includes/examples/tf-example-alerts-replication-lag-devtest.rst
@@ -0,0 +1,29 @@
+.. code-block::
+   :copyable: true
+
+   resource "mongodbatlas_alert_configuration" "test" {
+     project_id = var.atlas_project_id
+     event_type = "REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
+     enabled    = true
+
+     notification {
+       type_name     = "GROUP"
+       interval_min  = 5
+       delay_min     = 0
+       sms_enabled   = false
+       email_enabled = true
+       roles         = ["GROUP_CLUSTER_MANAGER"]
+     }
+
+     matcher {
+       field_name = "CLUSTER_NAME"
+       operator   = "EQUALS"
+       value      = "myCluster"
+     }
+
+     threshold_config {
+       operator    = "LESS_THAN"
+       threshold   = 1
+       units       = "HOURS"
+     }
+   }
diff --git a/source/includes/examples/tf-example-alerts-replication-lag-stagingprod.rst b/source/includes/examples/tf-example-alerts-replication-lag-stagingprod.rst
@@ -0,0 +1,30 @@
+.. code-block::
+   :copyable: true
+
+   resource "mongodbatlas_alert_configuration" "test_replication_lag_alert" {
+     project_id = var.atlas_project_id
+     event_type = "OUTSIDE_METRIC_THRESHOLD"
+     enabled    = true
+
+     notification {
+       type_name     = "GROUP"
+       interval_min  = 5
+       delay_min     = 0
+       sms_enabled   = false
+       email_enabled = true
+       roles         = ["GROUP_CLUSTER_MANAGER"]
+     }
+
+     matcher {
+       field_name = "CLUSTER_NAME"
+       operator   = "EQUALS"
+       value      = "myCluster"
+     }
+
+     metric_threshold_config {
+       metric_name = "OPLOG_SLAVE_LAG_MASTER_TIME"
+       operator    = "GREATER_THAN"
+       threshold   = 1
+       units       = "HOURS"
+     }
+   }
diff --git a/source/includes/examples/tf-example-monitoring-tfvars-devtest.rst b/source/includes/examples/tf-example-monitoring-tfvars-devtest.rst
@@ -0,0 +1,7 @@
+.. code-block:: 
+   :copyable: true
+
+   atlas_org_id = "32b6e34b3d91647abb20e7b8"
+   atlas_project_name = "Customer Portal - Prod"
+   atlas_project_id = "67212db237c5766221eb6ad9"
+   atlas_cluster_name = "myCluster"
diff --git a/source/includes/examples/tf-example-monitoring-tfvars-stagingprod.rst b/source/includes/examples/tf-example-monitoring-tfvars-stagingprod.rst
@@ -0,0 +1,11 @@
+.. code-block:: 
+   :copyable: true
+
+   atlas_org_id = "32b6e34b3d91647abb20e7b8"
+   atlas_project_name = "Customer Portal - Prod"
+   atlas_project_id = "67212db237c5766221eb6ad9"
+   atlas_cluster_name = "myCluster"
+   datadog_api_key = "1234567890abcdef1234567890abcdef"
+   datadog_region = "US5"
+   prometheus_user_name = "prometheus_user"
+   prometheus_password = "secure_prometheus_password"
diff --git a/source/includes/examples/tf-example-monitoring-variables-devtest.rst b/source/includes/examples/tf-example-monitoring-variables-devtest.rst
@@ -0,0 +1,20 @@
+.. code-block::
+   :copyable: true
+
+   variable "atlas_org_id" {
+     type        = string
+     description = "MongoDB Atlas Organization ID"
+   }
+   variable "atlas_project_name" {
+     type        = string
+     description = "The MongoDB Atlas Project Name"
+   }
+   variable "atlas_project_id" {
+     description = "MongoDB Atlas project id"
+     type        = string
+   }
+   variable "atlas_cluster_name" {
+     description = "MongoDB Atlas Cluster Name"
+     default     = "datadog-test-cluster"
+     type        = string
+   }
diff --git a/source/includes/examples/tf-example-monitoring-variables-stagingprod.rst b/source/includes/examples/tf-example-monitoring-variables-stagingprod.rst
@@ -0,0 +1,39 @@
+.. code-block::
+   :copyable: true
+
+   variable "atlas_org_id" {
+     type        = string
+     description = "MongoDB Atlas Organization ID"
+   }
+   variable "atlas_project_name" {
+     type        = string
+     description = "The MongoDB Atlas Project Name"
+   }
+   variable "atlas_project_id" {
+     description = "MongoDB Atlas project id"
+     type        = string
+   }
+   variable "atlas_cluster_name" {
+     description = "MongoDB Atlas Cluster Name"
+     default     = "datadog-test-cluster"
+     type        = string
+   }
+   variable "datadog_api_key" {
+     description = "Datadog api key"
+    type        = string
+   }
+   variable "datadog_region" {
+     description = "Datadog region"
+     default     = "US5"
+     type        = string
+   }
+   variable "prometheus_user_name" {
+     type        = string
+     description = "The Prometheus User Name"
+     default     = "puser"
+   }
+   variable "prometheus_password" {
+     type        = string
+     description = "The Prometheus Password"
+    default     = "ppassword"
+   }
diff --git a/source/includes/examples/tf-example-third-party-integration-stagingprod.rst b/source/includes/examples/tf-example-third-party-integration-stagingprod.rst
@@ -0,0 +1,21 @@
+.. code-block:: shell 
+   :copyable: true 
+
+   resource "mongodbatlas_third_party_integration" "test_datadog" {
+     project_id = var.atlas_project_id
+     type = "DATADOG"
+     api_key = var.datadog_api_key
+     region = var.datadog_region
+   }
+
+   resource "mongodbatlas_third_party_integration" "test_prometheus" {
+     project_id        = var.atlas_project_id
+     type              = "PROMETHEUS"
+     user_name         = var.prometheus_user_name
+     password          = var.prometheus_password
+     service_discovery = "http"
+     enabled           = true
+   }
+
+   output "datadog.id" { value = mongodbatlas_third_party_integration.test_datadog.id }  
+   output "prometheus.id" { value = mongodbatlas_third_party_integration.test_prometheus.id }
diff --git a/source/monitoring-alerts.txt b/source/monitoring-alerts.txt
