The aodh.storage.impl_sqlalchemy Module

The aodh.storage.impl_sqlalchemy Module

SQLAlchemy storage backend.

class aodh.storage.impl_sqlalchemy.Connection(conf, url)[source]

Bases: aodh.storage.base.Connection

Put the data into a SQLAlchemy database.

clear()[source]
clear_expired_alarm_history_data(alarm_history_ttl)[source]

Clear expired alarm history data from the backend storage system.

Clearing occurs according to the time-to-live.

Parameters:alarm_history_ttl – Number of seconds to keep alarm history records for.
create_alarm(alarm)[source]

Create an alarm.

Parameters:alarm – The alarm to create.
delete_alarm(alarm_id)[source]

Delete an alarm and its history data.

Parameters:alarm_id – ID of the alarm to delete
disconnect()[source]
static dress_url(url)[source]
get_alarm_changes(alarm_id, on_behalf_of, user=None, project=None, alarm_type=None, severity=None, start_timestamp=None, start_timestamp_op=None, end_timestamp=None, end_timestamp_op=None, pagination=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
  • alarm_type – Optional change type
  • severity – Optional alarm severity
  • 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
  • pagination – Pagination query parameters.
get_alarms(name=None, user=None, state=None, meter=None, project=None, enabled=None, alarm_id=None, alarm_type=None, severity=None, exclude=None, pagination=None)[source]

Yields a lists of alarms that match filters.

Parameters:
  • name – Optional name for alarm.
  • 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.
  • alarm_type – Optional alarm type.
  • severity – Optional alarm severity.
  • exclude – Optional dict for inequality constraint.
  • pagination – Pagination query parameters.
query_alarm_history(filter_expr=None, orderby=None, limit=None)[source]

Return an iterable of model.AlarmChange objects.

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

Yields a lists of alarms that match filter.

record_alarm_change(alarm_change)[source]

Record alarm change event.

update_alarm(alarm)[source]

Update an alarm.

Parameters:alarm – the new Alarm to update
upgrade(nocreate=False)[source]
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.