[Model Monitoring] Add MySQL support for saving and querying metrics (#…

…5641)

mlrun/common/schemas/model_monitoring/constants.py

@@ -193,6 +193,7 @@ class FileTargetKind:
     APPS_PARQUET = "apps_parquet"
     LOG_STREAM = "log_stream"
     APP_RESULTS = "app_results"
+    APP_METRICS = "app_metrics"
     MONITORING_SCHEDULES = "monitoring_schedules"
     MONITORING_APPLICATION = "monitoring_application"
 

mlrun/model_monitoring/db/stores/__init__.py

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# flake8: noqa  - this is until we take care of the F401 violations with respect to __all__ & sphinx
-
 import enum
 import typing
 import warnings

mlrun/model_monitoring/db/stores/base/store.py

@@ -125,7 +125,6 @@ def write_application_event(
                       object.
         :param kind: The type of the event, can be either "result" or "metric".
         """
-        pass
 
     @abstractmethod
     def get_last_analyzed(self, endpoint_id: str, application_name: str) -> int:
@@ -168,5 +167,5 @@ def get_model_endpoint_metrics(
         :param: endpoint_id: The model endpoint identifier.
         :param: type:        The type of the requested metrics ("result" or "metric").
 
-        :return:            A list of the available metrics.
+        :return:             A list of the available metrics.
         """

mlrun/model_monitoring/db/stores/sqldb/models/__init__.py

@@ -15,9 +15,11 @@
 from functools import partial
 from typing import Optional, TypeVar, Union
 
+from .mysql import ApplicationMetricsTable as MySQLApplicationMetricsTable
 from .mysql import ApplicationResultTable as MySQLApplicationResultTable
 from .mysql import ModelEndpointsTable as MySQLModelEndpointsTable
 from .mysql import MonitoringSchedulesTable as MySQLMonitoringSchedulesTable
+from .sqlite import ApplicationMetricsTable as SQLiteApplicationMetricsTable
 from .sqlite import ApplicationResultTable as SQLiteApplicationResultTable
 from .sqlite import ModelEndpointsTable as SQLiteModelEndpointsTable
 from .sqlite import MonitoringSchedulesTable as SQLiteMonitoringSchedulesTable
@@ -56,6 +58,12 @@ def _get_sql_table(
     sqlite_table=SQLiteApplicationResultTable,
 )
 
+_get_application_metrics_table = partial(
+    _get_sql_table,
+    mysql_table=MySQLApplicationMetricsTable,
+    sqlite_table=SQLiteApplicationMetricsTable,
+)
+
 _get_monitoring_schedules_table = partial(
     _get_sql_table,
     mysql_table=MySQLMonitoringSchedulesTable,

mlrun/model_monitoring/db/stores/sqldb/models/base.py

@@ -24,6 +24,7 @@
 from mlrun.common.schemas.model_monitoring import (
     EventFieldType,
     FileTargetKind,
+    MetricData,
     ResultData,
     SchedulingKeys,
     WriterEvent,
@@ -89,11 +90,11 @@ class ModelEndpointsBaseTable(BaseModel):
     metrics = Column(EventFieldType.METRICS, Text)
     first_request = Column(
         EventFieldType.FIRST_REQUEST,
-        TIMESTAMP,
+        TIMESTAMP(timezone=True),
     )
     last_request = Column(
         EventFieldType.LAST_REQUEST,
-        TIMESTAMP,
+        TIMESTAMP(timezone=True),
     )
 
 
@@ -135,6 +136,35 @@ class ApplicationResultBaseTable(BaseModel):
     current_stats = Column(ResultData.CURRENT_STATS, Text)
 
 
+class ApplicationMetricsBaseTable(BaseModel):
+    __tablename__ = FileTargetKind.APP_METRICS
+
+    uid = Column(EventFieldType.UID, String(120), primary_key=True)
+    application_name = Column(
+        WriterEvent.APPLICATION_NAME,
+        String(40),
+        nullable=True,
+    )
+    endpoint_id = Column(
+        WriterEvent.ENDPOINT_ID,
+        String(40),
+        nullable=True,
+    )
+    start_infer_time = Column(
+        WriterEvent.START_INFER_TIME,
+        TIMESTAMP(timezone=True),
+    )
+    end_infer_time = Column(
+        WriterEvent.END_INFER_TIME,
+        TIMESTAMP(timezone=True),
+    )
+    metric_name = Column(
+        MetricData.METRIC_NAME,
+        String(40),
+    )
+    metric_value = Column(MetricData.METRIC_VALUE, Float)
+
+
 class MonitoringSchedulesBaseTable(BaseModel):
     __tablename__ = FileTargetKind.MONITORING_SCHEDULES
 

mlrun/model_monitoring/db/stores/sqldb/models/mysql.py

@@ -22,6 +22,7 @@
 )
 
 from .base import (
+    ApplicationMetricsBaseTable,
     ApplicationResultBaseTable,
     ModelEndpointsBaseTable,
     MonitoringSchedulesBaseTable,
@@ -33,22 +34,29 @@
 class ModelEndpointsTable(Base, ModelEndpointsBaseTable):
     first_request = Column(
         EventFieldType.FIRST_REQUEST,
-        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3),
+        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3, timezone=True),
     )
     last_request = Column(
         EventFieldType.LAST_REQUEST,
-        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3),
+        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3, timezone=True),
     )
 
 
-class ApplicationResultTable(Base, ApplicationResultBaseTable):
+class _ApplicationResultOrMetric:
+    """
+    This class sets common columns of `ApplicationResultTable` and `ApplicationMetricsTable`
+    to the correct values in MySQL.
+    Note: This class must come before the base tables in the inheritance order to override
+    the relevant columns.
+    """
+
     start_infer_time = Column(
         WriterEvent.START_INFER_TIME,
-        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3),
+        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3, timezone=True),
     )
     end_infer_time = Column(
         WriterEvent.END_INFER_TIME,
-        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3),
+        sqlalchemy.dialects.mysql.TIMESTAMP(fsp=3, timezone=True),
     )
 
     @declared_attr
@@ -59,6 +67,18 @@ def endpoint_id(cls):
         )
 
 
+class ApplicationResultTable(
+    Base, _ApplicationResultOrMetric, ApplicationResultBaseTable
+):
+    pass
+
+
+class ApplicationMetricsTable(
+    Base, _ApplicationResultOrMetric, ApplicationMetricsBaseTable
+):
+    pass
+
+
 class MonitoringSchedulesTable(Base, MonitoringSchedulesBaseTable):
     @declared_attr
     def endpoint_id(cls):

mlrun/model_monitoring/db/stores/sqldb/models/sqlite.py

@@ -15,6 +15,7 @@
 from sqlalchemy.ext.declarative import declarative_base
 
 from .base import (
+    ApplicationMetricsBaseTable,
     ApplicationResultBaseTable,
     ModelEndpointsBaseTable,
     MonitoringSchedulesBaseTable,
@@ -31,5 +32,9 @@ class ApplicationResultTable(Base, ApplicationResultBaseTable):
     pass
 
 
+class ApplicationMetricsTable(Base, ApplicationMetricsBaseTable):
+    pass
+
+
 class MonitoringSchedulesTable(Base, MonitoringSchedulesBaseTable):
     pass