KpiDB.py

# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
from common.method_wrappers.Decorator import MetricsPool
from common.tools.database.GenericDatabase import Database
from common.method_wrappers.ServiceExceptions import OperationFailedException

LOGGER       = logging.getLogger(__name__)
METRICS_POOL = MetricsPool('KpiManager', 'Database')

class KpiDB(Database):
    def __init__(self, model) -> None:
        LOGGER.info('Init KpiManagerService')
        super().__init__(model)

    def select_with_filter(self, model, filter_object):
        """
        Generic method to create filters dynamically based on filter_object attributes.
        params:     model:         SQLAlchemy model class to query.
                    filter_object: Object that contains filtering criteria as attributes.
        return:     SQLAlchemy session, query and Model
        """
        session = self.Session()
        try:
            query = session.query(model)
            # Apply filters based on the filter_object
            if filter_object.kpi_id:
                query = query.filter(model.kpi_id.in_([k.kpi_id.uuid for k in filter_object.kpi_id]))

            if filter_object.kpi_sample_type:
                query = query.filter(model.kpi_sample_type.in_(filter_object.kpi_sample_type))

            if filter_object.device_id:
                query = query.filter(model.device_id.in_([d.device_uuid.uuid for d in filter_object.device_id]))

            if filter_object.endpoint_id:
                query = query.filter(model.endpoint_id.in_([e.endpoint_uuid.uuid for e in filter_object.endpoint_id]))

            if filter_object.service_id:
                query = query.filter(model.service_id.in_([s.service_uuid.uuid for s in filter_object.service_id]))

            if filter_object.slice_id:
                query = query.filter(model.slice_id.in_([s.slice_uuid.uuid for s in filter_object.slice_id]))

            if filter_object.connection_id:
                query = query.filter(model.connection_id.in_([c.connection_uuid.uuid for c in filter_object.connection_id]))

            if filter_object.link_id:
                query = query.filter(model.link_id.in_([l.link_uuid.uuid for l in filter_object.link_id]))
        except Exception as e:
            LOGGER.error(f"Error creating filter of {model.__name__} table. ERROR: {e}")
            raise OperationFailedException ("CreateKpiDescriptorFilter", extra_details=["unable to create the filter {:}".format(e)]) 
        
        return super().select_with_filter(query, session, model)