summaryrefslogtreecommitdiff
path: root/ceilometer/cache_utils.py
blob: f3fbd1873b27d91b440f33127e28af4af6b1881e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
#
# Copyright 2022 Red Hat, Inc
#
# 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.

"""Simple wrapper for oslo_cache."""
import uuid

from ceilometer import keystone_client
from keystoneauth1 import exceptions as ka_exceptions
from oslo_cache import core as cache
from oslo_cache import exception
from oslo_log import log
from oslo_utils.secretutils import md5

# Default cache expiration period
CACHE_DURATION = 86400

NAME_ENCODED = __name__.encode('utf-8')
CACHE_NAMESPACE = uuid.UUID(
    bytes=md5(NAME_ENCODED, usedforsecurity=False).digest()
)

LOG = log.getLogger(__name__)


class CacheClient(object):
    def __init__(self, region):
        self.region = region

    def get(self, key):
        value = self.region.get(key)
        if value == cache.NO_VALUE:
            return None
        return value

    def set(self, key, value):
        return self.region.set(key, value)

    def delete(self, key):
        return self.region.delete(key)


def get_client(conf):
    cache.configure(conf)
    if 'cache' in conf.keys() and conf.cache.enabled:
        region = get_cache_region(conf)
        if region:
            return CacheClient(region)


def get_cache_region(conf):
    # Set expiration time to default CACHE_DURATION if missing in conf
    if not conf.cache.expiration_time:
        conf.cache.expiration_time = CACHE_DURATION

    try:
        region = cache.create_region()
        cache.configure_cache_region(conf, region)
        cache.key_mangler = cache_key_mangler
        return region
    except exception.ConfigurationError as e:
        LOG.error("failed to configure oslo_cache. %s", str(e))
        LOG.warning("using keystone to identify names from polled samples")


def cache_key_mangler(key):
    """Construct an opaque cache key."""

    return uuid.uuid5(CACHE_NAMESPACE, key).hex


def resolve_uuid_from_cache(conf, attr, uuid):
    # empty cache_client means either caching is not enabled or
    # there was an error configuring cache
    cache_client = get_client(conf)
    if cache_client:
        resource_name = cache_client.get(uuid)
        if resource_name:
            return resource_name

    # Retrieve project and user names from Keystone only
    # if ceilometer doesn't have a caching backend
    resource_name = resolve_uuid_from_keystone(conf, attr, uuid)
    if cache_client:
        cache_client.set(uuid, resource_name)
    return resource_name


def resolve_uuid_from_keystone(conf, attr, uuid):
    try:
        return getattr(keystone_client.get_client(conf), attr).get(uuid).name
    except AttributeError as e:
        LOG.warning("Found '%s' while resolving uuid %s to name", e, uuid)
    except ka_exceptions.NotFound as e:
        LOG.warning(e.message)