senlin/senlin/engine/event.py

225 lines
8.3 KiB
Python

# 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 datetime
import logging
from oslo_log import log
from senlin.common import exception
from senlin.common import i18n
from senlin.db import api as db_api
_LC = i18n._LC
_LE = i18n._LE
_LW = i18n._LW
_LI = i18n._LI
_ = i18n._
LOG = log.getLogger(__name__)
class Event(object):
'''Class capturing an interesting happening in Senlin.'''
def __init__(self, timestamp, level, entity=None, **kwargs):
self.timestamp = timestamp
self.level = level
self.id = kwargs.get('id', None)
self.user = kwargs.get('user', None)
self.project = kwargs.get('project', None)
self.action = kwargs.get('action', None)
self.status = kwargs.get('status', None)
self.status_reason = kwargs.get('status_reason', None)
self.deleted_time = kwargs.get('deleted_time', None)
# we deal with deserialization first
self.obj_id = kwargs.get('obj_id', None)
self.obj_type = kwargs.get('obj_type', None)
self.obj_name = kwargs.get('obj_name', None)
self.cluster_id = kwargs.get('cluster_id', None)
self.metadata = kwargs.get('metadata', {})
# entity not None implies an initial creation of event object,
# not a deserialization, so we try make an inference here
if entity is not None:
self._infer_entity_data(entity)
def _infer_entity_data(self, entity):
self.obj_id = entity.id
self.obj_name = entity.name
if self.status is None:
self.status = entity.status
if self.status_reason is None:
self.status_reason = entity.status_reason
entity_type = entity.__class__.__name__.upper()
self.obj_type = entity_type
if entity_type == 'CLUSTER':
self.cluster_id = entity.id
elif entity_type == 'NODE':
self.cluster_id = entity.cluster_id
@classmethod
def from_db_record(cls, record):
'''Construct an event object from a database record.'''
kwargs = {
'id': record.id,
'obj_id': record.obj_id,
'obj_type': record.obj_type,
'obj_name': record.obj_name,
'cluster_id': record.cluster_id,
'user': record.user,
'project': record.project,
'action': record.action,
'status': record.status,
'status_reason': record.status_reason,
'deleted_time': record.deleted_time,
'metadata': record.meta_data,
}
return cls(record.timestamp, record.level, **kwargs)
@classmethod
def load(cls, context, db_event=None, event_id=None):
'''Retrieve an event record from database.'''
if db_event is not None:
return cls.from_db_record(db_event)
record = db_api.event_get(context, event_id)
if record is None:
raise exception.EventNotFound(event=event_id)
return cls.from_db_record(record)
@classmethod
def load_all(cls, context, filters=None, limit=None, marker=None,
sort_keys=None, sort_dir=None, project_safe=True,
show_deleted=False):
'''Retrieve all events from database.'''
records = db_api.event_get_all(context, limit=limit, marker=marker,
sort_keys=sort_keys, sort_dir=sort_dir,
filters=filters,
project_safe=project_safe,
show_deleted=show_deleted)
for record in records:
yield cls.from_db_record(record)
def store(self, context):
'''Store the event into database and return its ID.'''
values = {
'level': self.level,
'timestamp': self.timestamp,
'obj_id': self.obj_id,
'obj_type': self.obj_type,
'obj_name': self.obj_name,
'cluster_id': self.cluster_id,
'user': self.user,
'project': self.project,
'action': self.action,
'status': self.status,
'status_reason': self.status_reason,
'deleted_time': self.deleted_time,
'meta_data': self.metadata,
}
event = db_api.event_create(context, values)
self.id = event.id
return self.id
@classmethod
def from_dict(cls, **kwargs):
return cls(kwargs)
def to_dict(self):
evt = {
'id': self.id,
'level': self.level,
'timestamp': self.timestamp,
'obj_type': self.obj_type,
'obj_id': self.obj_id,
'obj_name': self.obj_name,
'cluster_id': self.cluster_id,
'user': self.user,
'project': self.project,
'action': self.action,
'status': self.status,
'status_reason': self.status_reason,
'deleted_time': self.deleted_time,
'metadata': self.metadata,
}
return evt
def critical(context, entity, action, status=None, status_reason=None,
timestamp=None):
timestamp = timestamp or datetime.datetime.utcnow()
event = Event(timestamp, logging.CRITICAL, entity,
action=action, status=status, status_reason=status_reason,
user=context.user, project=context.project)
event.store(context)
LOG.critical(_LC('%(name)s[%(id)s] - %(status)s: %(reason)s') %
{'name': entity.name, 'id': entity.id, 'status': status,
'reason': status_reason})
def error(context, entity, action, status=None, status_reason=None,
timestamp=None):
timestamp = timestamp or datetime.datetime.utcnow()
event = Event(timestamp, logging.ERROR, entity,
action=action, status=status, status_reason=status_reason,
user=context.user, project=context.project)
event.store(context)
LOG.error(_LE('%(name)s[%(id)s] %(action)s - %(status)s: %(reason)s') %
{'name': entity.name, 'id': entity.id, 'action': action,
'status': status, 'reason': status_reason})
def warning(context, entity, action, status=None, status_reason=None,
timestamp=None):
timestamp = timestamp or datetime.datetime.utcnow()
event = Event(timestamp, logging.WARNING, entity,
action=action, status=status, status_reason=status_reason,
user=context.user, project=context.project)
event.store(context)
LOG.warning(_LW('%(name)s[%(id)s] %(action)s - %(status)s: %(reason)s') %
{'name': entity.name, 'id': entity.id, 'action': action,
'status': status, 'reason': status_reason})
def info(context, entity, action, status=None, status_reason=None,
timestamp=None):
timestamp = timestamp or datetime.datetime.utcnow()
event = Event(timestamp, logging.INFO, entity,
action=action, status=status, status_reason=status_reason,
user=context.user, project=context.project)
event.store(context)
LOG.info(_LI('%(name)s[%(id)s] %(action)s - %(status)s: %(reason)s') %
{'name': entity.name, 'id': entity.id, 'action': action,
'status': status, 'reason': status_reason})
def debug(context, entity, action, status=None, status_reason=None,
timestamp=None):
timestamp = timestamp or datetime.datetime.utcnow()
event = Event(timestamp, logging.DEBUG, entity,
action=action, status=status, status_reason=status_reason,
user=context.user, project=context.project)
event.store(context)
LOG.debug(_('%(name)s[%(id)s] %(action)s - %(status)s: %(reason)s') %
{'name': entity.name, 'id': entity.id, 'action': action,
'status': status, 'reason': status_reason})