Class EventManagerBase

Sets up event database access and initializes the cache.

Parameters:

• id (string) - A unique id
• title (string) - A title
• hostname (string) - The hostname of the events database server
• username (string) - The name of a user with permissions to access the events database
• password (string) - The password of the user
• database (string) - The name of the events database
• port (int) - The port on which the database server is listening
• defaultWhere (string) - The default where clause to use when building queries
• defaultOrderby (string) - The default order by clause to use when building queries
• defaultResultFields (list) - DEPRECATED. Currently unused.

Overrides: ZenUtils.ObjectCache.ObjectCache.__init__

A wrapper for lookupManagedEntityResultFields accepting an object with an event_key attribute.

>>> class dummy(object):
...     event_key = 'Device'
...
>>> d = dummy()
>>> f = dmd.ZenEventManager.getEventResultFields(d)
>>> f==dmd.ZenEventManager.DeviceResultFields
True
>>> d.event_key = 'Robot'
>>> f = dmd.ZenEventManager.getEventResultFields(d)
>>> f==dmd.ZenEventManager.defaultResultFields
True

Parameters:

• context (ManagedEntity) - An object with an event_key attribute.

Returns: tuple

A sequence of strings representing columns in the database.

Queries the database for events on a managed entity.

Parameters:

• me (ManagedEntity) - The object for which to fetch events

Returns: list

ZEvent objects

Create SQL representing conditions that match passed filters and append it to a given where clause.

Expressions are built using various criteria, including the type of filter widget representing the column and factors specific to the column itself.

All textfield columns except count will be matched as regular expressions.

count may be passed as a comparison expression such as ">=2", "=8", "<10", etc., or an integer, in which case it will be evaluated as ">=n".

firstTime and lastTime are turned into seconds since the epoch, then evaluated as '>=n' and '<=n', respectively.

multiselectmenu columns (prodState, severity, eventState, priority) arrive as a list of values to match, and become 'and (field=v1 or field=v2...)' where field is the column and vn is the value.

Parameters:

• where (str) - The where clause to which to append further conditions
• filters (dict or JSON str representing dict) - Values for which to create filters (e.g., {'device':'^loc.*$', 'severity':[4, 5]})
• values (list) - Clause will be parameterized and the values list will be populated with the values for the query

Returns a batch of events based on criteria from checked rows on the event console.

The event console can show thousands of events, and we want to support a "Select All" feature; enter this method. It builds a query based on the select status from the console ("All", "None", "Acknowledged", "Unacknowledged") and any checkboxes that have been modified manually.

Parameters:

• me (ManagedEntity) - The managed entity for which to query events.
• resultFields (list) - The columns to return from the database.
• where (string) - The base where clause to modify.
• orderby (string) - The "ORDER BY" string governing sort order.
• severity (int) - The minimum severity for which to query.
• state (int) - The minimum state for which to query.
• startdate (string, DateTime) - The early date limit
• enddate (string, DateTime) - The late date limit
• offset (int) - The row at which to begin returning
• rows (int) - DEPRECATED The number of rows to return (ignored).
• getTotalCount (bool) - Whether or not to return a count of the total number of rows
• filter (string) - A glob by which to filter events
• goodevids (list) - Ids of events that specifically should be included
• badevids (list) - Ids of events that specifically should not be included

Returns: list

Ids of matching events

Returns a batch of events based on criteria from checked rows on the event console.

The event console can show thousands of events, and we want to support a "Select All" feature; enter this method. It builds a query based on the select status from the console ("All", "New", "Acknowledged", "Suppressed") and any checkboxes that have been modified manually.

Parameters:

• me (ManagedEntity) - The managed entity for which to query events.
• orderby (string) - The "ORDER BY" string governing sort order.
• filters (dict or JSON str representing dict) - Values for which to create filters (e.g., {'device':'^loc.*$', 'severity':[4, 5]})
• evids (list) - Ids of events that specifically should be included
• excludeIds (list) - Ids of events that specifically should not be included

Returns: set

Ids of matching events

Fetch a list of events from the database matching certain criteria.

Parameters:

• resultFields (list) - The columns to return from the database.
• where (string) - The base where clause to modify.
• orderby (string) - The "ORDER BY" string governing sort order.
• severity (int) - The minimum severity for which to query.
• state (int) - The minimum state for which to query.
• startdate (string, DateTime) - The early date limit
• enddate (string, DateTime) - The late date limit
• offset (int) - The row at which to begin returning
• rows (int) - The number of rows to return.
• getTotalCount (bool) - Whether or not to return a count of the total number of rows
• filter (string) - A glob by which to filter events

Returns: list

Matching events as ZEvents.

Return the CSS class, number of acknowledged events, and number of unacknowledged events, per severity, for a ManagedEntity.

Parameters:

• me (ManagedEntity) - The object of the inquiry.
• severity (int) - The minimum severity for which to retrieve events
• state (int) - The minimum state for which to retrieve events
• prodState (int) - The minimum production state for which to retrieve events

Returns: list

List of lists of the form [class, acked count, unacked count].

Return a list of tuples with number of events and the color of the severity that the number represents.

This method should not be called directly, but overridden by subclasses.

Parameters:

• where (string) - The base where clause to modify.
• severity (int) - The minimum severity for which to retrieve events
• state (int) - The minimum state for which to retrieve events
• prodState (int) - The minimum production state for which to retrieve events

Returns: list

List of lists of the form [class, acked count, unacked count].

Return an EventDetail object for a particular event.

Parameters:

• evid (string) - Event ID
• dedupid (string) - string used to determine duplicates
• better (boolean) - provide even more detail than normal?

Returns: EventDetail object

fields from the event

Return status based on a where clause defined for the me event_type. No fancy caching done this might be a little slow if there are a lot of events. Where clause is evaled

Return a list of userids that correspond to the events in where. select distinct ownerid from status where device="win2k.confmon.loc" and eventState > 2

Lookup and build where clause for managed entity.

Parameters:

• me (object) - managed entity

Returns: string

where clause

Lookup database field for managed entity default using event_key.

Parameters:

• event_key (string) - event

Returns: object

field for the managed entity

Gets the column names that should be requested in an event query for this entity type.

Returns a set of result fields predefined for this entity type. If none have been defined, returns the default result fields.

>>> f = dmd.ZenEventManager.lookupManagedEntityResultFields('Device')
>>> f==dmd.ZenEventManager.DeviceResultFields
True
>>> f = dmd.ZenEventManager.lookupManagedEntityResultFields('Robot')
>>> f==dmd.ZenEventManager.defaultResultFields
True

Parameters:

• event_key (string) - The event key of a managed entity.

Returns:

A tuple of strings representing columns in the database.

Send an event to the backend.

Parameters:

• event (event object) - event

Prepare string values for db by escaping special characters.

Parameters:

• value (string) - string

Load schema from database. If field is a date set value to true.

Delete historical events. If devices is given then only delete events for that device. If agedDays is given then only delete events that are older than that many days. devname and agedDays are mutually exclusive. No real reason for this other than there is no current need to use both in same call and I don't want to test the combination. This is an option during device deletion. It is also used by zenactions to keep history table clean.

NB: Device.deleteDevice() is not currently calling this when devices are deleted. See ticket #2996.

Need to handle editing of history event fields differently

Overrides: ZenModel.ZenModelBase.ZenModelBase.zmanage_editProperties

Add a new EventCommand

Parameters:

• id (string) - new command name
• REQUEST (Zope REQUEST object) - Zope REQUEST object

Delete an EventCommand

Parameters:

• ids (list of strings) - commands to delete
• REQUEST (Zope REQUEST object) - Zope REQUEST object

eventStateConversions

Value:

'New', 0, ('Acknowledged', 1), ('Suppressed', 2),

severityConversions

Value:

'Critical', 5, ('Error', 4), ('Warning', 3), ('Info', 2), ('Debug', 1) , ('Clear', 0),

priorityConversions

Value:

'None',-1, ('Emergency', 0), ('Alert', 1), ('Critical', 2), ('Error', 3), ('Warning', 4), ('Notice', 6), ('Info', 8), ('Debug', 10),

DeviceResultFields

Value:

"eventState", "severity", "component", "eventClass", "summary", "first Time", "lastTime", "count"

ComponentWhere

Value:

"\"(device = '%s' and component = '%s')\"" " % (me.device().getDmdKey( ), me.name())"

ComponentResultFields

Value:

"eventState", "severity", "eventClass", "summary", "firstTime", "lastT ime", "count"

EventClassInstWhere

Value:

"""\"eventClass = '%s' and eventClassKey = '%s'\" % (\ me.getEventClass(), me.eventClassKey)" ""

DeviceClassWhere

Value:

"\"(DeviceClass = '%s' or DeviceClass like '%s/%%') \" % \ ( me.getDmdKey(), me.getDmdKey() )"

DeviceGroupWhere

Value:

"\"DeviceGroups like '%%|%s%%'\" % me.getDmdKey()"

defaultResultFields

Value:

"eventState", "severity", "device", "component", "eventClass", "summar y", "firstTime", "lastTime", "count"

defaultEventId

Value:

'device', 'component', 'eventClass', 'eventKey', 'severity'

refreshConversionsForm

Value:

DTMLFile('dtml/refreshNcoProduct', globals())

factory_type_information

Value:

{'immediate_view': 'editEventManager', 'actions':({'id': 'edit', 'name ': 'Edit', 'action': 'editEventManager', 'permissions':("Manage DMD",) }, {'id': 'edit', 'name': 'Fields', 'action': 'editEventManagerFields' , 'permissions':("Manage DMD",)}, {'id': 'history_edit', 'name': 'Hist ory Fields', 'action': 'editEventManagerHistoryFields', 'permissions': ("Manage DMD",)}, {'id': 'commands', 'name': 'Commands', 'action': 'li stEventCommands', 'permissions':("Manage DMD",)}, {'id': 'changes', 'n ame': 'Modifications', 'action': 'viewNewHistory', 'permissions':(ZEN_ ...