a48e664537
Currently, alarm notification only has the alarm_id which can be used to identify an alarm. But in some use cases, user may want to use some customized information to mark the alarm. So this patch added the alarm_name field into the notification. The name of alarm is tenant unique and can be defined by user when alarm is created. When the alarm consumer (e.g. OS::Heat::ScalingPolicy) receives an alarm, it can now identify the alarm using the customized info stored in alarm_name field. Change-Id: If9ffcca3f0de8f45483f30bc30ded91dd9d40d77 Closes-Bug: #1399067
40 lines
1.4 KiB
Python
40 lines
1.4 KiB
Python
#
|
|
# Copyright 2013 eNovance <licensing@enovance.com>
|
|
#
|
|
# Author: Julien Danjou <julien@danjou.info>
|
|
#
|
|
# 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 abc
|
|
|
|
import six
|
|
|
|
|
|
@six.add_metaclass(abc.ABCMeta)
|
|
class AlarmNotifier(object):
|
|
"""Base class for alarm notifier plugins."""
|
|
|
|
@abc.abstractmethod
|
|
def notify(self, action, alarm_id, alarm_name, previous, current,
|
|
reason, reason_data):
|
|
"""Notify that an alarm has been triggered.
|
|
|
|
:param action: The action that is being attended, as a parsed URL.
|
|
:param alarm_id: The triggered alarm.
|
|
:param alarm_name: The name of triggered alarm.
|
|
:param previous: The previous state of the alarm.
|
|
:param current: The current state of the alarm.
|
|
:param reason: The reason the alarm changed its state.
|
|
:param reason_data: A dict representation of the reason.
|
|
"""
|