Source code for monasca_log_api.reference.common.model

# Copyright 2016 FUJITSU LIMITED
#
# 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 oslo_utils import timeutils


class LogEnvelopeException(Exception):
    pass


class Envelope(dict):
    def __init__(self, log, meta):
        if not log:
            error_msg = 'Envelope cannot be created without log'
            raise LogEnvelopeException(error_msg)
        if 'tenantId' not in meta or not meta.get('tenantId'):
            error_msg = 'Envelope cannot be created without tenant'
            raise LogEnvelopeException(error_msg)

        creation_time = self._get_creation_time()
        super(Envelope, self).__init__(
            log=log,
            creation_time=creation_time,
            meta=meta
        )

    @staticmethod
    def _get_creation_time():
        return timeutils.utcnow_ts()

    @classmethod
    def new_envelope(cls, log, tenant_id, region, dimensions=None):
        """Creates new log envelope

        Log envelope is combined ouf of following properties

        * log - dict
        * creation_time - timestamp
        * meta - meta block

        Example output json would like this:

        .. code-block:: json

            {
                "log": {
                  "message": "Some message",
                  "dimensions": {
                    "hostname": "devstack"
                  }
                },
                "creation_time": 1447834886,
                "meta": {
                  "tenantId": "e4bd29509eda473092d32aadfee3e7b1",
                  "region": "pl"
                }
            }

        :param dict log: original log element (containing message and other
                         params
        :param str tenant_id: tenant id to be put in meta field
        :param str region: region to be put in meta field
        :param dict dimensions: additional dimensions to be appended to log
                                object dimensions

        """
        if dimensions:
            log['dimensions'].update(dimensions)

        log_meta = {
            'region': region,
            'tenantId': tenant_id
        }

        return cls(log, log_meta)

    @property
    def log(self):
        return self.get('log', None)

    @property
    def creation_time(self):
        return self.get('creation_time', None)

    @property
    def meta(self):
        return self.get('meta', None)