392 lines
12 KiB
Python
392 lines
12 KiB
Python
#
|
|
# Author: John Tran <jhtran@att.com>
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
SQLAlchemy models for Ceilometer data.
|
|
"""
|
|
|
|
import json
|
|
|
|
from oslo.utils import timeutils
|
|
import six
|
|
from sqlalchemy import (Column, Integer, String, ForeignKey, Index,
|
|
UniqueConstraint, BigInteger, join)
|
|
from sqlalchemy import Float, Boolean, Text, DateTime
|
|
from sqlalchemy.dialects.mysql import DECIMAL
|
|
from sqlalchemy.ext.declarative import declarative_base
|
|
from sqlalchemy.orm import backref
|
|
from sqlalchemy.orm import column_property
|
|
from sqlalchemy.orm import relationship
|
|
from sqlalchemy.types import TypeDecorator
|
|
|
|
from ceilometer.storage import models as api_models
|
|
from ceilometer import utils
|
|
|
|
|
|
class JSONEncodedDict(TypeDecorator):
|
|
"""Represents an immutable structure as a json-encoded string."""
|
|
|
|
impl = String
|
|
|
|
def process_bind_param(self, value, dialect):
|
|
if value is not None:
|
|
value = json.dumps(value)
|
|
return value
|
|
|
|
def process_result_value(self, value, dialect):
|
|
if value is not None:
|
|
value = json.loads(value)
|
|
return value
|
|
|
|
|
|
class PreciseTimestamp(TypeDecorator):
|
|
"""Represents a timestamp precise to the microsecond."""
|
|
|
|
impl = DateTime
|
|
|
|
def load_dialect_impl(self, dialect):
|
|
if dialect.name == 'mysql':
|
|
return dialect.type_descriptor(DECIMAL(precision=20,
|
|
scale=6,
|
|
asdecimal=True))
|
|
return self.impl
|
|
|
|
def process_bind_param(self, value, dialect):
|
|
if value is None:
|
|
return value
|
|
elif dialect.name == 'mysql':
|
|
return utils.dt_to_decimal(value)
|
|
return value
|
|
|
|
def process_result_value(self, value, dialect):
|
|
if value is None:
|
|
return value
|
|
elif dialect.name == 'mysql':
|
|
return utils.decimal_to_dt(value)
|
|
return value
|
|
|
|
|
|
class CeilometerBase(object):
|
|
"""Base class for Ceilometer Models."""
|
|
__table_args__ = {'mysql_charset': "utf8",
|
|
'mysql_engine': "InnoDB"}
|
|
__table_initialized__ = False
|
|
|
|
def __setitem__(self, key, value):
|
|
setattr(self, key, value)
|
|
|
|
def __getitem__(self, key):
|
|
return getattr(self, key)
|
|
|
|
def update(self, values):
|
|
"""Make the model object behave like a dict."""
|
|
for k, v in six.iteritems(values):
|
|
setattr(self, k, v)
|
|
|
|
|
|
Base = declarative_base(cls=CeilometerBase)
|
|
|
|
|
|
class MetaText(Base):
|
|
"""Metering text metadata."""
|
|
|
|
__tablename__ = 'metadata_text'
|
|
__table_args__ = (
|
|
Index('ix_meta_text_key', 'meta_key'),
|
|
)
|
|
id = Column(Integer, ForeignKey('sample.id'), primary_key=True)
|
|
meta_key = Column(String(255), primary_key=True)
|
|
value = Column(Text)
|
|
|
|
|
|
class MetaBool(Base):
|
|
"""Metering boolean metadata."""
|
|
|
|
__tablename__ = 'metadata_bool'
|
|
__table_args__ = (
|
|
Index('ix_meta_bool_key', 'meta_key'),
|
|
)
|
|
id = Column(Integer, ForeignKey('sample.id'), primary_key=True)
|
|
meta_key = Column(String(255), primary_key=True)
|
|
value = Column(Boolean)
|
|
|
|
|
|
class MetaBigInt(Base):
|
|
"""Metering integer metadata."""
|
|
|
|
__tablename__ = 'metadata_int'
|
|
__table_args__ = (
|
|
Index('ix_meta_int_key', 'meta_key'),
|
|
)
|
|
id = Column(Integer, ForeignKey('sample.id'), primary_key=True)
|
|
meta_key = Column(String(255), primary_key=True)
|
|
value = Column(BigInteger, default=False)
|
|
|
|
|
|
class MetaFloat(Base):
|
|
"""Metering float metadata."""
|
|
|
|
__tablename__ = 'metadata_float'
|
|
__table_args__ = (
|
|
Index('ix_meta_float_key', 'meta_key'),
|
|
)
|
|
id = Column(Integer, ForeignKey('sample.id'), primary_key=True)
|
|
meta_key = Column(String(255), primary_key=True)
|
|
value = Column(Float(53), default=False)
|
|
|
|
|
|
class Meter(Base):
|
|
"""Meter definition data."""
|
|
|
|
__tablename__ = 'meter'
|
|
__table_args__ = (
|
|
UniqueConstraint('name', 'type', 'unit', name='def_unique'),
|
|
Index('ix_meter_name', 'name')
|
|
)
|
|
id = Column(Integer, primary_key=True)
|
|
name = Column(String(255), nullable=False)
|
|
type = Column(String(255))
|
|
unit = Column(String(255))
|
|
samples = relationship("Sample", backref="meter")
|
|
|
|
|
|
class Sample(Base):
|
|
"""Metering data."""
|
|
|
|
__tablename__ = 'sample'
|
|
__table_args__ = (
|
|
Index('ix_sample_timestamp', 'timestamp'),
|
|
Index('ix_sample_user_id', 'user_id'),
|
|
Index('ix_sample_project_id', 'project_id'),
|
|
Index('ix_sample_meter_id', 'meter_id')
|
|
)
|
|
id = Column(Integer, primary_key=True)
|
|
meter_id = Column(Integer, ForeignKey('meter.id'))
|
|
user_id = Column(String(255))
|
|
project_id = Column(String(255))
|
|
resource_id = Column(String(255))
|
|
resource_metadata = Column(JSONEncodedDict())
|
|
volume = Column(Float(53))
|
|
timestamp = Column(PreciseTimestamp(), default=lambda: timeutils.utcnow())
|
|
recorded_at = Column(PreciseTimestamp(),
|
|
default=lambda: timeutils.utcnow())
|
|
message_signature = Column(String(1000))
|
|
message_id = Column(String(1000))
|
|
source_id = Column(String(255))
|
|
meta_text = relationship("MetaText", backref="sample",
|
|
cascade="all, delete-orphan")
|
|
meta_float = relationship("MetaFloat", backref="sample",
|
|
cascade="all, delete-orphan")
|
|
meta_int = relationship("MetaBigInt", backref="sample",
|
|
cascade="all, delete-orphan")
|
|
meta_bool = relationship("MetaBool", backref="sample",
|
|
cascade="all, delete-orphan")
|
|
|
|
|
|
class MeterSample(Base):
|
|
"""Helper model.
|
|
|
|
It's needed as many of the filters work against Sample data joined with
|
|
Meter data.
|
|
"""
|
|
meter = Meter.__table__
|
|
sample = Sample.__table__
|
|
__table__ = join(meter, sample)
|
|
|
|
id = column_property(sample.c.id)
|
|
meter_id = column_property(meter.c.id, sample.c.meter_id)
|
|
counter_name = column_property(meter.c.name)
|
|
counter_type = column_property(meter.c.type)
|
|
counter_unit = column_property(meter.c.unit)
|
|
counter_volume = column_property(sample.c.volume)
|
|
|
|
|
|
class Alarm(Base):
|
|
"""Define Alarm data."""
|
|
__tablename__ = 'alarm'
|
|
__table_args__ = (
|
|
Index('ix_alarm_user_id', 'user_id'),
|
|
Index('ix_alarm_project_id', 'project_id'),
|
|
)
|
|
alarm_id = Column(String(255), primary_key=True)
|
|
enabled = Column(Boolean)
|
|
name = Column(Text)
|
|
type = Column(String(50))
|
|
description = Column(Text)
|
|
timestamp = Column(PreciseTimestamp, default=lambda: timeutils.utcnow())
|
|
|
|
user_id = Column(String(255))
|
|
project_id = Column(String(255))
|
|
|
|
state = Column(String(255))
|
|
state_timestamp = Column(PreciseTimestamp,
|
|
default=lambda: timeutils.utcnow())
|
|
|
|
ok_actions = Column(JSONEncodedDict)
|
|
alarm_actions = Column(JSONEncodedDict)
|
|
insufficient_data_actions = Column(JSONEncodedDict)
|
|
repeat_actions = Column(Boolean)
|
|
|
|
rule = Column(JSONEncodedDict)
|
|
time_constraints = Column(JSONEncodedDict)
|
|
|
|
|
|
class AlarmChange(Base):
|
|
"""Define AlarmChange data."""
|
|
__tablename__ = 'alarm_history'
|
|
__table_args__ = (
|
|
Index('ix_alarm_history_alarm_id', 'alarm_id'),
|
|
)
|
|
event_id = Column(String(255), primary_key=True)
|
|
alarm_id = Column(String(255))
|
|
on_behalf_of = Column(String(255))
|
|
project_id = Column(String(255))
|
|
user_id = Column(String(255))
|
|
type = Column(String(20))
|
|
detail = Column(Text)
|
|
timestamp = Column(PreciseTimestamp, default=lambda: timeutils.utcnow())
|
|
|
|
|
|
class EventType(Base):
|
|
"""Types of event records."""
|
|
__tablename__ = 'event_type'
|
|
|
|
id = Column(Integer, primary_key=True)
|
|
desc = Column(String(255), unique=True)
|
|
|
|
def __init__(self, event_type):
|
|
self.desc = event_type
|
|
|
|
def __repr__(self):
|
|
return "<EventType: %s>" % self.desc
|
|
|
|
|
|
class Event(Base):
|
|
__tablename__ = 'event'
|
|
__table_args__ = (
|
|
Index('ix_event_message_id', 'message_id'),
|
|
Index('ix_event_type_id', 'event_type_id'),
|
|
Index('ix_event_generated', 'generated')
|
|
)
|
|
id = Column(Integer, primary_key=True)
|
|
message_id = Column(String(50), unique=True)
|
|
generated = Column(PreciseTimestamp())
|
|
|
|
event_type_id = Column(Integer, ForeignKey('event_type.id'))
|
|
event_type = relationship("EventType", backref='events')
|
|
|
|
def __init__(self, message_id, event_type, generated):
|
|
self.message_id = message_id
|
|
self.event_type = event_type
|
|
self.generated = generated
|
|
|
|
def __repr__(self):
|
|
return "<Event %d('Event: %s %s, Generated: %s')>" % (self.id,
|
|
self.message_id,
|
|
self.event_type,
|
|
self.generated)
|
|
|
|
|
|
class TraitType(Base):
|
|
"""Types of event traits.
|
|
|
|
A trait type includes a description and a data type. Uniqueness is
|
|
enforced compositely on the data_type and desc fields. This is to
|
|
accommodate cases, such as 'generated', which, depending on the
|
|
corresponding event, could be a date, a boolean, or a float.
|
|
"""
|
|
__tablename__ = 'trait_type'
|
|
__table_args__ = (
|
|
UniqueConstraint('desc', 'data_type', name='tt_unique'),
|
|
Index('ix_trait_type', 'desc')
|
|
)
|
|
|
|
id = Column(Integer, primary_key=True)
|
|
desc = Column(String(255))
|
|
data_type = Column(Integer)
|
|
|
|
def __init__(self, desc, data_type):
|
|
self.desc = desc
|
|
self.data_type = data_type
|
|
|
|
def __repr__(self):
|
|
return "<TraitType: %s:%d>" % (self.desc, self.data_type)
|
|
|
|
|
|
class Trait(Base):
|
|
__tablename__ = 'trait'
|
|
__table_args__ = (
|
|
Index('ix_trait_t_int', 't_int'),
|
|
Index('ix_trait_t_string', 't_string'),
|
|
Index('ix_trait_t_datetime', 't_datetime'),
|
|
Index('ix_trait_t_float', 't_float'),
|
|
)
|
|
id = Column(Integer, primary_key=True)
|
|
|
|
trait_type_id = Column(Integer, ForeignKey('trait_type.id'))
|
|
trait_type = relationship("TraitType", backref='traits')
|
|
|
|
t_string = Column(String(255), nullable=True, default=None)
|
|
t_float = Column(Float(53), nullable=True, default=None)
|
|
t_int = Column(Integer, nullable=True, default=None)
|
|
t_datetime = Column(PreciseTimestamp(), nullable=True, default=None)
|
|
|
|
event_id = Column(Integer, ForeignKey('event.id'))
|
|
event = relationship("Event", backref=backref('traits', order_by=id))
|
|
|
|
_value_map = {api_models.Trait.TEXT_TYPE: 't_string',
|
|
api_models.Trait.FLOAT_TYPE: 't_float',
|
|
api_models.Trait.INT_TYPE: 't_int',
|
|
api_models.Trait.DATETIME_TYPE: 't_datetime'}
|
|
|
|
def __init__(self, trait_type, event, t_string=None,
|
|
t_float=None, t_int=None, t_datetime=None):
|
|
self.trait_type = trait_type
|
|
self.t_string = t_string
|
|
self.t_float = t_float
|
|
self.t_int = t_int
|
|
self.t_datetime = t_datetime
|
|
self.event = event
|
|
|
|
def get_value(self):
|
|
if self.trait_type is None:
|
|
dtype = None
|
|
else:
|
|
dtype = self.trait_type.data_type
|
|
|
|
if dtype == api_models.Trait.INT_TYPE:
|
|
return self.t_int
|
|
if dtype == api_models.Trait.FLOAT_TYPE:
|
|
return self.t_float
|
|
if dtype == api_models.Trait.DATETIME_TYPE:
|
|
return self.t_datetime
|
|
if dtype == api_models.Trait.TEXT_TYPE:
|
|
return self.t_string
|
|
|
|
return None
|
|
|
|
def __repr__(self):
|
|
name = self.trait_type.desc if self.trait_type else None
|
|
data_type = (self.trait_type.data_type if self.trait_type else
|
|
api_models.Trait.NONE_TYPE)
|
|
|
|
return "<Trait(%s) %d=%s/%s/%s/%s on %s>" % (name,
|
|
data_type,
|
|
self.t_string,
|
|
self.t_float,
|
|
self.t_int,
|
|
self.t_datetime,
|
|
self.event)
|