The ceilometer.alarm.storage.pymongo_base ModuleΒΆ

Common functions for MongoDB and DB2 backends

class ceilometer.alarm.storage.pymongo_base.Connection(url)[source]

Bases: ceilometer.alarm.storage.base.Connection

Base Alarm Connection class for MongoDB and DB2 drivers.

Connection.create_alarm(alarm)

Update alarm.

Connection.delete_alarm(alarm_id)[source]

Delete an alarm.

Connection.get_alarm_changes(alarm_id, on_behalf_of, user=None, project=None, type=None, start_timestamp=None, start_timestamp_op=None, end_timestamp=None, end_timestamp_op=None)[source]

Yields list of AlarmChanges describing alarm history

Changes are always sorted in reverse order of occurrence, given the importance of currency.

Segregation for non-administrative users is done on the basis of the on_behalf_of parameter. This allows such users to have visibility on both the changes initiated by themselves directly (generally creation, rule changes, or deletion) and also on those changes initiated on their behalf by the alarming service (state transitions after alarm thresholds are crossed).

Parameters:
  • alarm_id – ID of alarm to return changes for
  • on_behalf_of – ID of tenant to scope changes query (None for administrative user, indicating all projects)
  • user – Optional ID of user to return changes for
  • project – Optional ID of project to return changes for
  • start_timestamp – Optional modified timestamp start range
  • start_timestamp_op – Optional timestamp start range operation
  • end_timestamp – Optional modified timestamp end range
  • end_timestamp_op – Optional timestamp end range operation
Project type:

Optional change type

Connection.get_alarms(name=None, user=None, state=None, meter=None, project=None, enabled=None, alarm_id=None, pagination=None)[source]

Yields a lists of alarms that match filters

Parameters:
  • name – The Alarm name.
  • user – Optional ID for user that owns the resource.
  • state – Optional string for alarm state.
  • meter – Optional string for alarms associated with meter.
  • project – Optional ID for project that owns the resource.
  • enabled – Optional boolean to list disable alarm.
  • alarm_id – Optional alarm_id to return one alarm.
  • pagination – Optional pagination query.
Connection.query_alarm_history(filter_expr=None, orderby=None, limit=None)[source]

Return an iterable of model.AlarmChange objects.

Connection.query_alarms(filter_expr=None, orderby=None, limit=None)[source]

Return an iterable of model.Alarm objects.

Connection.record_alarm_change(alarm_change)[source]

Record alarm change event.

Connection.update_alarm(alarm)[source]

Update alarm.

Previous topic

The ceilometer.alarm.storage.impl_hbase Module

Next topic

The ceilometer.alarm.storage.impl_sqlalchemy Module

This Page