aodh/ceilometer/counter.py
Julien Danjou 00531f9de0 Unify Counter generation from notifications
This will make sure we don't lose any metadata information from
notifications into the Counter/samples we publish.

This is part of fixing bug #1187833 and bug #1187843

Change-Id: I315581907be1dcec33f43a5d5fd7b7876a7889f6
Signed-off-by: Julien Danjou <julien@danjou.info>
2013-07-05 13:40:25 +02:00

91 lines
2.9 KiB
Python

# -*- encoding: utf-8 -*-
#
# Copyright © 2012 New Dream Network, LLC (DreamHost)
#
# Author: Doug Hellmann <doug.hellmann@dreamhost.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.
"""Counter class for holding data about a metering event.
A Counter 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 collections
import copy
from oslo.config import cfg
OPTS = [
cfg.StrOpt('counter_source',
default='openstack',
help='Source for counters emited on this instance'),
]
cfg.CONF.register_opts(OPTS)
# Fields explanation:
#
# Name: the name of the counter, must be unique
# Type: the type of the counter, 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 counter
# Volume: the counter value
# User ID: the user ID
# Project ID: the project ID
# Resource ID: the resource ID
# Timestamp: when the counter has been read
# Resource metadata: various metadata
Counter = collections.namedtuple('Counter',
' '.join([
'name',
'type',
'unit',
'volume',
'user_id',
'project_id',
'resource_id',
'timestamp',
'resource_metadata',
]))
TYPE_GAUGE = 'gauge'
TYPE_DELTA = 'delta'
TYPE_CUMULATIVE = 'cumulative'
def from_notification(cls, name, type, volume, unit,
user_id, project_id, resource_id,
message):
metadata = copy.copy(message['payload'])
metadata['event_type'] = message['event_type']
metadata['host'] = message['publisher_id']
return cls(name=name,
type=type,
volume=volume,
unit=unit,
user_id=user_id,
project_id=project_id,
resource_id=resource_id,
timestamp=message['timestamp'],
resource_metadata=metadata)
Counter.from_notification = classmethod(from_notification)