Source code for monasca_events_api.app.model.envelope

# Copyright 2018 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 monasca_common.rest import utils as rest_utils
from oslo_utils import encodeutils
from oslo_utils import timeutils


[docs]def serialize_envelope(envelope): """Returns json representation of an envelope. :return: json object of envelope :rtype: json or a bytestring `encoding` encoded representation of it. """ json = rest_utils.as_json(envelope, ensure_ascii=False) return encodeutils.safe_decode(json, 'utf-8')
[docs]class EventEnvelopeException(Exception): pass
[docs]class Envelope(dict): def __init__(self, event, meta): if not event: error_msg = 'Envelope cannot be created without event' raise EventEnvelopeException(error_msg) if 'project_id' not in meta or not meta.get('project_id'): error_msg = 'Envelope cannot be created without project_id' raise EventEnvelopeException(error_msg) creation_time = self._get_creation_time() super(Envelope, self).__init__( event=rest_utils.from_json(event), creation_time=creation_time, meta=meta ) @staticmethod def _get_creation_time(): return timeutils.utcnow_ts()
[docs] @classmethod def new_envelope(cls, event, project_id): """Creates new event envelope Event envelope is combined of of following properties * event - dict * creation_time - timestamp * meta - meta block Example output json would be like this: .. code-block:: json { "event": { "message": "Some message", "dimensions": { "hostname": "devstack" } }, "creation_time": 1447834886, "meta": { "project_id": "e4bd29509eda473092d32aadfee3e7b1", } } :param dict event: original event element :param str project_id: project id to be put in meta field """ event_meta = { 'project_id': project_id } return cls(event, event_meta)
@property def event(self): return self.get('event', None) @property def creation_time(self): return self.get('creation_time', None) @property def meta(self): return self.get('meta', None)