Source code for osprofiler.notifier

# Copyright 2014 Mirantis Inc.
# All Rights Reserved.
#
#    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.

from collections.abc import Callable
import logging
from typing import Any

from osprofiler.drivers import base


LOG = logging.getLogger(__name__)


def _noop_notifier(info: dict[str, Any], context: Any = None) -> None:
    """Do nothing on notify()."""


# NOTE(boris-42): By default we are using noop notifier.
__notifier: Callable[..., None] = _noop_notifier
__notifier_cache: dict[
    str, Callable[..., None]
] = {}  # map: connection-string -> notifier




def notify(info: dict[str, Any]) -> None:
    """Passes the profiling info to the notifier callable.

    :param info: dictionary with profiling information
    """
    __notifier(info)





def get() -> Callable[..., None]:
    """Returns notifier callable."""
    return __notifier





def set(notifier: Callable[..., None]) -> None:
    """Service that are going to use profiler should set callable notifier.

    Callable notifier is instance of callable object, that accept exactly
    one argument "info". "info" - is dictionary of values that contains
    profiling information.
    """
    global __notifier
    __notifier = notifier





def create(
    connection_string: str, *args: Any, **kwargs: Any
) -> Callable[..., None]:
    """Create notifier based on specified plugin_name

    :param connection_string: connection string which specifies the storage
                              driver for notifier
    :param args: args that will be passed to the driver's __init__ method
    :param kwargs: kwargs that will be passed to the driver's __init__ method
    :returns: Callable notifier method
    """
    global __notifier_cache
    if connection_string not in __notifier_cache:
        try:
            driver = base.get_driver(connection_string, *args, **kwargs)
            __notifier_cache[connection_string] = driver.notify
            LOG.info(
                "osprofiler is enabled with connection string: %s",
                connection_string,
            )
        except Exception:
            LOG.exception(
                "Could not initialize driver for connection string "
                "%s, osprofiler is disabled",
                connection_string,
            )
            __notifier_cache[connection_string] = _noop_notifier

    return __notifier_cache[connection_string]





def clear_notifier_cache() -> None:
    __notifier_cache.clear()