Add initialization health event to MySQL (DataDog#21867)

* Add initialization health event to MySQL

* Changelog

* Bump base version

* Base check

* Tags

* Lint

* Sanitize pass

Author: sethsamuel

mysql/changelog.d/21867.added

@@ -0,0 +1 @@
+Add DBM agent health events to MySQL. Events include basic initialization check, unhandled error, and missed collection.

mysql/datadog_checks/mysql/config.py

@@ -1,6 +1,8 @@
 # (C) Datadog, Inc. 2020-present
 # All rights reserved
 # Licensed under Simplified BSD License (see LICENSE)
+import copy
+
 from datadog_checks.base import ConfigurationError, is_affirmative
 from datadog_checks.base.log import get_check_logger
 from datadog_checks.base.utils.aws import rds_parse_tags_from_endpoint
@@ -164,3 +166,11 @@ def _should_propagate_agent_tags(instance, init_config) -> bool:
             return init_config_propagate_agent_tags
         # if neither the instance nor the init_config has set the value, return False
         return False
+
+
+def sanitize(config: dict) -> dict:
+    sanitized = copy.deepcopy(config)
+    sanitized['pass'] = '***' if sanitized.get('pass') else None
+    sanitized['password'] = '***' if sanitized.get('password') else None
+
+    return sanitized

mysql/datadog_checks/mysql/health.py

@@ -0,0 +1,64 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from datadog_checks.mysql import MySql
+
+from enum import Enum
+
+from datadog_checks.base.utils.db.health import Health, HealthEvent, HealthStatus
+
+
+class MySqlHealthEvent(Enum):
+    """
+    Enum representing the health events for MySql monitoring.
+    """
+
+    EXPLAIN_PLAN_ERROR = 'explain_plan_error'
+
+
+class MySqlHealth(Health):
+    def __init__(self, check: MySql):
+        # type: (MySql) -> None
+        """
+        Initialize the MySqlHealth instance.
+
+        :param check: MySql
+            The check instance that will be used to submit health events.
+        """
+        super().__init__(check)
+        self.check = check
+
+    def submit_health_event(
+        self,
+        name: HealthEvent | MySqlHealthEvent,
+        status: HealthStatus,
+        tags: list[str] = None,
+        data: dict = None,
+        **kwargs,
+    ):
+        """
+        Submit a health event to the aggregator.
+
+        :param name: MySqlHealthEvent
+            The name of the health event.
+        :param status: HealthStatus
+            The health status to submit.
+        :param data: A dictionary to be submitted as `data`. Must be JSON serializable.
+        """
+        super().submit_health_event(
+            name=name,
+            status=status,
+            # If we have an error parsing the config we may not have tags yet
+            tags=(self.check.tags if hasattr(self.check, 'tags') else []) + (tags or []),
+            data={
+                "database_instance": self.check.database_identifier,
+                "ddagenthostname": self.check.agent_hostname,
+                **(data or {}),
+            },
+            **kwargs,
+        )

mysql/datadog_checks/mysql/mysql.py

@@ -15,8 +15,9 @@
 import pymysql
 from cachetools import TTLCache
 
-from datadog_checks.base import AgentCheck, is_affirmative
+from datadog_checks.base import AgentCheck, DatabaseCheck, is_affirmative
 from datadog_checks.base.utils.db import QueryExecutor, QueryManager
+from datadog_checks.base.utils.db.health import HealthEvent, HealthStatus
 from datadog_checks.base.utils.db.utils import (
     TagManager,
     default_json_event_encoding,
@@ -28,11 +29,12 @@
 from datadog_checks.base.utils.serialization import json
 from datadog_checks.mysql import aws
 from datadog_checks.mysql.cursor import CommenterCursor, CommenterDictCursor, CommenterSSCursor
+from datadog_checks.mysql.health import MySqlHealth
 
 from .__about__ import __version__
 from .activity import MySQLActivity
 from .collection_utils import collect_all_scalars, collect_scalar, collect_string, collect_type
-from .config import MySQLConfig
+from .config import MySQLConfig, sanitize
 from .const import (
     AWS_RDS_HOSTNAME_SUFFIX,
     AZURE_DEPLOYMENT_TYPE_TO_RESOURCE_TYPE,
@@ -95,12 +97,12 @@
     PSUTIL_AVAILABLE = False
 
 try:
-    import datadog_agent
+    import datadog_agent  # type: ignore
 except ImportError:
     from datadog_checks.base.stubs import datadog_agent
 
 
-class MySql(AgentCheck):
+class MySql(DatabaseCheck):
     SERVICE_CHECK_NAME = 'mysql.can_connect'
     SLAVE_SERVICE_CHECK_NAME = 'mysql.replication.slave_running'
     REPLICA_SERVICE_CHECK_NAME = 'mysql.replication.replica_running'
@@ -110,6 +112,7 @@ class MySql(AgentCheck):
 
     def __init__(self, name, init_config, instances):
         super(MySql, self).__init__(name, init_config, instances)
+        self.health = MySqlHealth(self)
         self.qcache_stats = {}
         self.version = None
         self.is_mariadb = None
@@ -122,6 +125,7 @@ def __init__(self, name, init_config, instances):
         self._events_wait_current_enabled = None
         self._group_replication_active = None
         self._replication_role = None
+        self._initialized_at = int(time.time() * 1000)
         self._config = MySQLConfig(self.instance, init_config)
         self.tag_manager = TagManager()
         self.tag_manager.set_tags_from_list(self._config.tags, replace=True)  # Initialize from static config tags
@@ -167,6 +171,21 @@ def __init__(self, name, init_config, instances):
         self.set_resource_tags()
         self._is_innodb_engine_enabled_cached = None
 
+        self._submit_initialization_health_event()
+
+    def _submit_initialization_health_event(self):
+        try:
+            # Handle the config validation result after we've set tags so those tags are included in the health event
+            # TODO: validate the config once it is refactored similar to Postgres, and then send the computed config
+            self.health.submit_health_event(
+                name=HealthEvent.INITIALIZATION,
+                status=HealthStatus.OK,
+                cooldown_time=60 * 60 * 6,  # 6 hours
+                data={"initialized_at": self._initialized_at, "instance": sanitize(self.instance)},
+            )
+        except Exception as e:
+            self.log.error("Error submitting health event for initialization: %s", e)
+
     def execute_query_raw(self, query):
         with closing(self._conn.cursor(CommenterSSCursor)) as cursor:
             cursor.execute(query)
@@ -179,6 +198,10 @@ def _send_metadata(self):
         self.set_metadata('flavor', self.version.flavor)
         self.set_metadata('resolved_hostname', self.resolved_hostname)
 
+    @property
+    def tags(self):
+        return self.tag_manager.get_tags()
+
     @property
     def reported_hostname(self):
         # type: () -> str
@@ -352,6 +375,8 @@ def get_library_versions(cls):
         return {'pymysql': pymysql.__version__}
 
     def check(self, _):
+        self._submit_initialization_health_event()
+
         if self.instance.get('user'):
             self._log_deprecation('_config_renamed', 'user', 'username')
 

mysql/pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
     "Private :: Do Not Upload",
 ]
 dependencies = [
-    "datadog-checks-base>=37.21.0",
+    "datadog-checks-base>=37.22.1",
 ]
 dynamic = [
     "version",