Source code for ceilometer.sample

# Copyright 2012 New Dream Network, LLC (DreamHost)
# Copyright 2013 eNovance
# 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
# 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.
"""Sample class for holding data about a metering event.

A Sample doesn't really do anything, but we need a way to
ensure that all of the appropriate fields have been filled
in by the plugins that create them.

import copy
import uuid

from oslo_config import cfg
from oslo_utils import timeutils

OPTS = [
               help='Source for samples emitted on this instance.'),


# Fields explanation:
# Source: the source of this sample
# Name: the name of the meter, must be unique
# Type: the type of the meter, must be either:
#       - cumulative: the value is incremented and never reset to 0
#       - delta: the value is reset to 0 each time it is sent
#       - gauge: the value is an absolute value and is not a counter
# Unit: the unit of the meter
# Volume: the sample value
# User ID: the user ID
# Project ID: the project ID
# Resource ID: the resource ID
# Timestamp: when the sample has been read
# Resource metadata: various metadata
# id: an uuid of a sample, can be taken from API  when post sample via API
[docs]class Sample(object): def __init__(self, name, type, unit, volume, user_id, project_id, resource_id, timestamp=None, resource_metadata=None, source=None, id=None, monotonic_time=None): = name self.type = type self.unit = unit self.volume = volume self.user_id = user_id self.project_id = project_id self.resource_id = resource_id self.timestamp = timestamp self.resource_metadata = resource_metadata or {} self.source = source or cfg.CONF.sample_source = id or str(uuid.uuid1()) self.monotonic_time = monotonic_time
[docs] def as_dict(self): return copy.copy(self.__dict__)
def __repr__(self): return '<name: %s, volume: %s, resource_id: %s, timestamp: %s>' % (, self.volume, self.resource_id, self.timestamp) @classmethod
[docs] def from_notification(cls, name, type, volume, unit, user_id, project_id, resource_id, message, timestamp=None, metadata=None, source=None): if not metadata: metadata = (copy.copy(message['payload']) if isinstance(message['payload'], dict) else {}) metadata['event_type'] = message['event_type'] metadata['host'] = message['publisher_id'] ts = timestamp if timestamp else message['timestamp'] return cls(name=name, type=type, volume=volume, unit=unit, user_id=user_id, project_id=project_id, resource_id=resource_id, timestamp=ts, resource_metadata=metadata, source=source)
[docs] def set_timestamp(self, timestamp): self.timestamp = timestamp
[docs] def get_iso_timestamp(self): return timeutils.parse_isotime(self.timestamp)

Project Source