Package ZenEvents :: Module EventManagerBase :: Class EventManagerBase

Class EventManagerBase

                                                                 object --+        
                                                                          |        
                                Products.ZenModel.ZenModelBase.ZenModelBase --+    
                                                                              |    
                                                 object --+                   |    
                                                          |                   |    
                                        ExtensionClass.Base --+               |    
                                                              |               |    
                                  OFS.CopySupport.CopyContainer --+           |    
                                                                  |           |    
              Products.ZenRelations.RelCopySupport.RelCopyContainer --+       |    
                                                                      |       |    
                                                 object --+           |       |    
                                                          |           |       |    
                                        ExtensionClass.Base --+       |       |    
                                                              |       |       |    
                                  OFS.CopySupport.CopyContainer --+   |       |    
                                                                  |   |       |    
                                                 object --+       |   |       |    
                                                          |       |   |       |    
                                        ExtensionClass.Base --+   |   |       |    
                                                              |   |   |       |    
                                      App.Management.Navigation --+   |       |    
                                                                  |   |       |    
                                                 object --+       |   |       |    
                                                          |       |   |       |    
                                        ExtensionClass.Base --+   |   |       |    
                                                              |   |   |       |    
                                            App.Management.Tabs --+   |       |    
                                                                  |   |       |    
                                                 object --+       |   |       |    
                                                          |       |   |       |    
                                        ExtensionClass.Base --+   |   |       |    
                                                              |   |   |       |    
                                           EventDetail.Implicit --+   |       |    
                                                                  |   |       |    
                                                 object --+       |   |       |    
                                                          |       |   |       |    
                                      persistent.Persistent --+   |   |       |    
                                                              |   |   |       |    
                                                 object --+   |   |   |       |    
                                                          |   |   |   |       |    
                                        ExtensionClass.Base --+   |   |       |    
                                                              |   |   |       |    
                                         Persistence.Persistent --+   |       |    
                                                                  |   |       |    
                                             object --+           |   |       |    
                                                      |           |   |       |    
                                    ExtensionClass.Base --+       |   |       |    
                                                          |       |   |       |    
                     webdav.EtagSupport.EtagSupport --+   |       |   |       |    
                                                      |   |       |   |       |    
                           webdav.Lockable.LockableItem --+       |   |       |    
                                                          |       |   |       |    
                                   webdav.Resource.Resource --+   |   |       |    
                                                              |   |   |       |    
                                   webdav.Collection.Collection --+   |       |    
                                                                  |   |       |    
                                    OFS.Traversable.Traversable --+   |       |    
                                                                  |   |       |    
                                    OFS.ObjectManager.ObjectManager --+       |    
                                                                      |       |    
                                                 object --+           |       |    
                                                          |           |       |    
                                        ExtensionClass.Base --+       |       |    
                                                              |       |       |    
                                             object --+       |       |       |    
                                                      |       |       |       |    
                                    ExtensionClass.Base --+   |       |       |    
                                                          |   |       |       |    
                                 OFS.CopySupport.CopySource --+       |       |    
                                                              |       |       |    
                                             object --+       |       |       |    
                                                      |       |       |       |    
                                    ExtensionClass.Base --+   |       |       |    
                                                          |   |       |       |    
                                        App.Management.Tabs --+       |       |    
                                                              |       |       |    
                                OFS.Traversable.Traversable --+       |       |    
                                                              |       |       |    
                                             object --+       |       |       |    
                                                      |       |       |       |    
                                    ExtensionClass.Base --+   |       |       |    
                                                          |   |       |       |    
                                  AccessControl.Owned.Owned --+       |       |    
                                                              |       |       |    
                              Products.ZenRelations.ZItem.ZItem --+   |       |    
                                                                  |   |       |    
                                                 object --+       |   |       |    
                                                          |       |   |       |    
                                        ExtensionClass.Base --+   |   |       |    
                                                              |   |   |       |    
                                           EventDetail.Implicit --+   |       |    
                                                                  |   |       |    
                                                 object --+       |   |       |    
                                                          |       |   |       |    
                                        ExtensionClass.Base --+   |   |       |    
                                                              |   |   |       |    
                AccessControl.PermissionMapping.RoleManager --+   |   |       |    
                                                              |   |   |       |    
                                 AccessControl.Role.RoleManager --+   |       |    
                                                                  |   |       |    
  Products.ZenRelations.PrimaryPathObjectManager.PrimaryPathManager --+       |    
                                                                      |       |    
                                                     object --+       |       |    
                                                              |       |       |    
                                            ExtensionClass.Base --+   |       |    
                                                                  |   |       |    
                                               App.Undo.UndoSupport --+       |    
                                                                      |       |    
Products.ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager --+   |    
                                                                          |   |    
                                                     object --+           |   |    
                                                              |           |   |    
                                            ExtensionClass.Base --+       |   |    
                                                                  |       |   |    
                                          OFS.ZDOM.Node --+       |       |   |    
                                                          |       |       |   |    
                                           OFS.ZDOM.Element --+   |       |   |    
                                                              |   |       |   |    
                                 OFS.ZDOM.ElementWithAttributes --+       |   |    
                                                                  |       |   |    
                                OFS.PropertyManager.PropertyManager --+   |   |    
                                                                      |   |   |    
            Products.ZenRelations.ZenPropertyManager.ZenPropertyManager --+   |    
                                                                          |   |    
                                    ZenModel.ZenModelRM.RelationshipManager --+    
                                                                              |    
                                                             object --+       |    
                                                                      |       |    
                                                    ExtensionClass.Base --+   |    
                                                                          |   |    
                                                     OFS.History.Historical --+    
                                                                              |    
                                                                 object --+   |    
                                                                          |   |    
                                      Products.ZenModel.ZenPacker.ZenPacker --+    
                                                                              |    
                                        Products.ZenModel.ZenModelRM.ZenModelRM --+
                                                                                  |
                                                             object --+           |
                                                                      |           |
                                                  persistent.Persistent --+       |
                                                                          |       |
                                                             object --+   |       |
                                                                      |   |       |
                                                    ExtensionClass.Base --+       |
                                                                          |       |
                                                     Persistence.Persistent --+   |
                                                                              |   |
                                      Products.ZenUtils.ObjectCache.ObjectCache --+
                                                                                  |
                                                                     object --+   |
                                                                              |   |
                                                      DbAccessBase.DbAccessBase --+
                                                                                  |
                                                                                 EventManagerBase

Known Subclasses:: MySqlEventManager'.MySqlEventManager

Data connector to backend of the event management system.

Instance Methods

[hide private]

__init__(self, id, title='', hostname='localhost', username='root', password='', database='events', port=3306, defaultWhere='', defaultOrderby='', defaultResultFields=[])
Sets up event database access and initializes the cache. source code

tuple

getEventResultFields(self, context)
A wrapper for lookupManagedEntityResultFields accepting an object with an event_key attribute. source code

list

getEventListME(self, me, **kwargs)
Queries the database for events on a managed entity.

source code

list

getEventBatchME(self, me, selectstatus=None, resultFields=[], where='', orderby='', severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter='', goodevids=[], badevids=[], **kwargs)
Returns a batch of events based on criteria from checked rows on the event console. source code

list

getEventList(self, resultFields=[], where='', orderby='', severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter='', **kwargs)
Fetch a list of events from the database matching certain criteria. source code

list

getEventSummaryME(self, me, severity=1, state=1, prodState=None)
Return the CSS class, number of acknowledged events, and number of unacknowledged events, per severity, for a ManagedEntity. source code

list

getEventPillME(self, me, number=1, showGreen=False)
Get HTML code displaying the maximum event severity and the number of events of that severity on a particular ManagedEntity in a pleasing pill-shaped container.

source code

string

getDeviceComponentEventSummary(self, device, REQUEST=None)
Return a list of categories of components on a device along with event pills for the maximum severity event on each category in the form of a JSON object ready for inclusion in a YUI data table.

source code

string

getObjectsEventSummaryJSON(self, objects, REQUEST=None)
Return an HTML link and event pill for each object passed as a JSON object ready for inclusion in a YUI data table.

source code

string

getEntityListEventSummary(self, entities=[], REQUEST=None)
A wrapper for getObjectsEventSummaryJSON that accepts a list of paths to Zope objects which it then attempts to resolve. source code

list

getEventSummary(self, where='', severity=1, state=1, prodState=None)
Return a list of tuples with number of events and the color of the severity that the number represents. source code

getEventDetailFromStatusOrHistory(self, evid=None, dedupid=None, better=False)

source code

getEventDetail(self, evid=None, dedupid=None, better=False)
Return an EventDetail object for a particular event.

source code

getStatusME(self, me, statusclass=None, **kwargs)

source code

getGenericStatus(self, me)
Return status based on a where clause defined for the me event_type.

source code

getOrganizerStatus(self, org, statusclass=None, severity=None, state=0, where='')
see IEventStatus source code

getOrganizerStatusIssues(self, event_key, severity=4, state=0, where='', limit=0)
Return list of tuples (org, count) for all organizers with events. source code

getDevicePingIssues(self, state=2, limit=0)
Return devices with ping problems.

source code

getWmiConnIssues(self, state=2, limit=0)
Return devices with WMI connection failures.

source code

getDeviceStatusIssues(self, severity=4, state=1, limit=0)
Return only status issues.

source code

getDeviceIssues(self, severity=1, state=0, where='', mincount=0, limit=0)
Return list of tuples (device, count, total) of events for all devices with events. source code

getDeviceStatus(self, device, statclass=None, countField=None, severity=3, state=None, where='')
see IEventStatus source code

defaultAvailabilityStart(self)

source code

defaultAvailabilityEnd(self)

source code

getAvailability(self, state, **kw)

source code

getHeartbeat(self, failures=True, simple=False, limit=0, db=None)
Return all heartbeat issues list of tuples (device, component, secs)

source code

getHeartbeatObjects(self, failures=True, simple=False, limit=0, db=None)

source code

getAllComponentStatus(self, statclass, countField=None, severity=3, state=1, where='')
Fetch the counts on all components matching statClass source code

getMaxSeverity(self, me)
Returns the severity of the most severe event.

source code

getComponentStatus(self, device, component, statclass=None, countField=None, severity=3, state=1, where='')
see IEventStatus source code

getEventOwnerListME(self, me, severity=0, state=1)
Return list of event owners based on passed in managed entity.

source code

getEventOwnerList(self, where='', severity=0, state=1)
Return a list of userids that correspond to the events in where. source code

lookupManagedEntityWhere(self, me)
Lookup and build where clause for managed entity.

source code

lookupManagedEntityField(self, event_key)
Lookup database field for managed entity default is event_key.

source code

lookupManagedEntityResultFields(self, event_key)
Gets the column names that should be requested in an event query for this entity type.

source code

_wand(self, where, fmt, field, value)

source code

_setupDateRange(self, startdate=DateTime('2007/10/25 16:27:14.644 GMT-4'), enddate=DateTime('2007/10/24 16:27:14.644 GMT-4'))
Make a start and end date range that is at least one day long.

source code

getDashboardInfo(self, simple=False, organizer='Devices', REQUEST=None)
Return a dictionary that has all info for the dashboard. source code

getDeviceIssuesJSON(self)
Get devices with issues in a form suitable for a portlet on the dashboard.

source code

getHeartbeatIssuesJSON(self)
Get heartbeat issues in a form suitable for a portlet on the dashboard.

source code

getDeviceDashboard(self, simple=False)
return device info for bad device to dashboard

source code

getOrganizerSummary(self, rootname='Systems', template='', simple=False)
Return systems info for dashboard. source code

getDevProdStateJSON(self, prodStates=['Maintenance'], REQUEST=None)
Return a map of device to production state in a format suitable for a YUI data table. source code

getOrganizerDashboard(self)

source code

getSummaryDashboard(self, REQUEST=None)
Build summary of serveral zope servers

source code

getJSONEventsInfo(self, context, offset=0, count=50, getTotalCount=True, startdate=None, enddate=None, filter='', severity=2, state=1, orderby='', **kwargs)
Event data in JSON format. source code

getJSONFields(self, context)

source code

getAvgFieldLength(self, fieldname)

source code

sendEvents(self, events)
Send a group of events to the backend.

source code

sendEvent(self, event)
Send an event to the backend.

source code

convert(self, field, value)
Perform convertion of value coming from database value if nessesary.

source code

getFieldList(self)
Return a list of all fields in the status table of the backend.

source code

getEventStates(self)
Return a list of possible event states.

source code

getEventActions(self)
Return a list of possible event actions.

source code

getSeverities(self)
Return a list of tuples of severities [('Warning', 3), ...]

source code

getSeverityString(self, severity)
Return a string representation of the severity.

source code

getPriorities(self)
Return a list of tuples of priorities [('Warning', 3), ...]

source code

getPriorityString(self, priority)
Return the priority name

source code

getStatusCssClass(self, status)

source code

getStatusImgSrc(self, status)
Return the img source for a status number

source code

getEventCssClass(self, severity, acked=False)
return the css class name to be used for this event.

source code

isDate(self, colName)
Check to see if a column is of type date.

source code

dateString(self, value)
Convert a date from database format to string.

source code

dateDB(self, value)
Convert a date to its database format.

source code

escape(self, value)
Prepare string values for db by escaping special characters.

source code

loadSchema(self)
Load schema from database.

source code

eventControls(self)
Are there event controls on this event list.

source code

updateEvents(self, stmt, whereClause, reason, table='status', toLog=True) source code

manage_addEvent(self, REQUEST=None)
Create an event from user supplied data

source code

deleteEvents(self, whereClause, reason)

source code

manage_deleteEvents(self, evids=(), REQUEST=None)
Delete the given event ids source code

undeleteEvents(self, whereClause, reason)

source code

manage_undeleteEvents(self, evids=(), REQUEST=None)
Move the given event ids into status and delete from history source code

manage_deleteAllEvents(self, devname, REQUEST=None)
Delete the events for a given Device (used for deleting the device

source code

manage_deleteHeartbeat(self, devname, REQUEST=None)

source code

manage_ackEvents(self, evids=(), REQUEST=None)
Ack the given event ids source code

manage_setEventStates(self, eventState=None, evids=(), REQUEST=None) source code

manage_createEventMap(self, eventClass=None, evids=(), REQUEST=None)
Create an event map from an event or list of events. source code

manage_refreshConversions(self, REQUEST=None)
get the conversion information from the omnibus server

source code

manage_editCache(self, timeout=5, clearthresh=20, REQUEST=None)
Reset cache values

source code

manage_clearCache(self, REQUEST=None)
Reset cache values

source code

manage_editEventManager(self, REQUEST=None)
Call zmanage_editProperties then take care of saving a few values to ZenEventHistory

source code

manage_clearHeartbeats(self, REQUEST=None)
truncate heartbeat table

source code

zmanage_editProperties(self, REQUEST=None)
Need to handle editing of history event fields differently

source code

manage_addLogMessage(self, evid=None, message='', REQUEST=None)
Add a log message to an event source code

manage_addCommand(self, id, REQUEST=None)
add a new EventCommand

source code

manage_deleteCommands(self, ids, REQUEST=None)
add a new EventCommand

source code

_genuuid(self)
globally unique id based on timestamp, fqdn, and random number.

source code

installIntoPortal(self)
Install skins into portal.

source code

Inherited from Products.ZenModel.ZenModelRM.ZenModelRM: changePythonClass, creator, editableDeviceList, getCreatedTimeString, getDmdKey, getModificationTimeString, getSubObjects, getTreeItems, getZenRootNode, index_object, primarySortKey, reindex_all, rename, unindex_object, viewName, zmanage_addProperty, zmanage_delObjects, zmanage_delProperties, zmanage_exportObject, zmanage_importObject, zmanage_importObjects

Inherited from Products.ZenModel.ZenModelBase.ZenModelBase: __call__, __hash__, all_meta_types, breadCrumbs, callZenScreen, checkRemotePerm, checkValidId, createHierarchyObj, custPropertyIds, custPropertyMap, getBreadCrumbUrlPath, getDmd, getDmdObj, getDmdRoot, getHierarchyObj, getIconPath, getIdLink, getNowString, getObjByPath, getPrimaryDmdId, getUnusedId, getZ, getZopeObj, helpLink, isLocalName, manage_deleteObjects, prepId, saveCustProperties, todayDate, urlLink, view, visibleCustPropertyMap, yesterdayDate, zenScreenUrl, zenpathjoin, zenpathsplit, zentinelTabs

Inherited from ZenModel.ZenModelRM.RelationshipManager: addRelation, buildRelations, cb_isMoveable, checkRelations, exportXml, exportXmlProperties, exportXmlRelationships, getRelationshipManagerId, getRelationshipNames, getRelationships, manage_addRelation, manage_beforeDelete, manage_removeRelation, manage_workspace, removeRelation

Inherited from ZenModel.ZenModelRM.RelationshipManager (private): _getCopy, _notifyOfCopyTo, _setObject

Inherited from Products.ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager (private): _delObject

Inherited from Products.ZenRelations.RelCopySupport.RelCopyContainer: manage_linkObjects, manage_renameObject, manage_unlinkObjects

Inherited from Products.ZenRelations.RelCopySupport.RelCopyContainer (private): _getRelName, _getSourceObjects, _verifyObjectLink, _verifyObjectPaste

Inherited from OFS.ObjectManager.ObjectManager: SQLConnectionIDs, ZQueryIds, __class_init__, __getitem__, addDTMLDocument, addDTMLMethod, filtered_meta_types, hasObject, list_imports, manage_FTPlist, manage_FTPstat, manage_addDTMLDocument, manage_addDTMLMethod, manage_addDocument, manage_addFile, manage_addFolder, manage_addImage, manage_addOrderedFolder, manage_addSiteRoot, manage_addUserFolder, manage_addZGadflyConnection, manage_addZGadflyConnectionForm, manage_afterAdd, manage_afterClone, manage_delObjects, manage_exportObject, manage_hasId, manage_importObject, objectIds, objectIds_d, objectItems, objectItems_d, objectMap, objectMap_d, objectValues, objectValues_d, superValues, tpValues

Inherited from OFS.ObjectManager.ObjectManager (private): _checkId, _delOb, _getOb, _importObjectFromFile, _setOb, _subobject_permissions

Inherited from OFS.CopySupport.CopyContainer: __providedBy__, cb_dataItems, cb_dataValid, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_clone, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObjects, validClipData

Inherited from OFS.CopySupport.CopyContainer (private): _get_id

Inherited from App.Management.Navigation: manage_zmi_logout

Inherited from Products.ZenRelations.PrimaryPathObjectManager.PrimaryPathManager: getPrimaryId, getPrimaryParent, getPrimaryPath, getPrimaryUrlPath, primaryAq

Inherited from Products.ZenRelations.ZItem.ZItem: __len__, __name__, __repr__, getId, manage_editedDialog, raise_standardErrorMessage, this, title_and_id, title_or_id, tpURL

Inherited from App.Undo.UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions

Inherited from Products.ZenRelations.ZenPropertyManager.ZenPropertyManager: deleteZenProperty, getOverriddenObjects, isLocal, manage_editProperties, saveZenProperties, setZenProperty, zenPropIsPassword, zenPropertyIds, zenPropertyItems, zenPropertyMap, zenPropertyOptions, zenPropertyPath, zenPropertyString, zenPropertyType

Inherited from Products.ZenRelations.ZenPropertyManager.ZenPropertyManager (private): _onlystars, _setPropValue, _setProperty

Inherited from OFS.PropertyManager.PropertyManager: getProperty, getPropertyType, hasProperty, manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id

Inherited from OFS.PropertyManager.PropertyManager (private): _delPropValue, _delProperty, _propertyMap, _updateProperty, _wrapperCheck

Inherited from OFS.History.Historical: manage_afterHistoryCopy, manage_beforeHistoryCopy, manage_change_history, manage_historicalComparison, manage_historyCompare, manage_historyCopy

Inherited from Products.ZenModel.ZenPacker.ZenPacker: addToZenPack, findObject

Inherited from Products.ZenUtils.ObjectCache.ObjectCache: addToCache, checkCache, cleanCache, clearCache, getCache, getCacheClearthresh, getCacheTimeout, initCache

Inherited from DbAccessBase.DbAccessBase: cleanstring, close, connect

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Inherited from ExtensionClass.Base: __getnewargs__, __getstate__, __setstate__

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Inherited from OFS.ZDOM.ElementWithAttributes: getAttribute, getAttributeNode, getAttributes

Inherited from OFS.ZDOM.Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName

Inherited from OFS.ZDOM.Node: getNodeValue, getOwnerDocument, hasChildNodes

Inherited from App.Management.Tabs: class_manage_path, filtered_manage_options, tabs_path_default, tabs_path_info

Inherited from EventDetail.Implicit: __of__

Inherited from Persistence.Persistent: bobobase_modification_time, locked_in_version, modified_in_version

Inherited from persistent.Persistent (private): _p_activate, _p_deactivate, _p_delattr, _p_getattr, _p_invalidate, _p_setattr

Inherited from webdav.Collection.Collection: DELETE, HEAD, PUT, dav__init, listDAVObjects

Inherited from webdav.Resource.Resource: COPY, LOCK, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, TRACE, UNLOCK, dav__simpleifhandler, dav__validate, manage_DAVget

Inherited from AccessControl.Role.RoleManager: ac_inherited_permissions, access_debug_info, acquiredRolesAreUsedBy, get_local_roles, get_local_roles_for_userid, get_valid_userids, has_local_roles, manage_access, manage_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_defined_roles, manage_delLocalRoles, manage_editRoles, manage_permission, manage_role, manage_setLocalRoles, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, validRoles, valid_roles, validate_roles

Inherited from AccessControl.Role.RoleManager (private): _addRole, _delRoles, _has_user_defined_role, _setRoles

Inherited from ExtensionClass.Base: __getnewargs__, __getstate__, __setstate__

Inherited from OFS.CopySupport.CopySource: cb_isCopyable, cb_userHasCopyOrMovePermission

Inherited from OFS.CopySupport.CopySource (private): _canCopy, _postCopy, _setId

Inherited from App.Management.Tabs: class_manage_path, filtered_manage_options, tabs_path_default, tabs_path_info

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Inherited from webdav.Lockable.LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockTokens, wl_lockValues, wl_lockmapping, wl_setLock

Inherited from webdav.EtagSupport.EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag

Inherited from OFS.Traversable.Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path

Inherited from AccessControl.Owned.Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_changeOwnershipType, manage_fixupOwnershipAfterAdd, manage_takeOwnership, owner_info, userCanTakeOwnership

Inherited from AccessControl.Owned.Owned (private): _deleteOwnershipAfterAdd

Inherited from ExtensionClass.Base: __getnewargs__, __getstate__, __setstate__

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Inherited from AccessControl.PermissionMapping.RoleManager: manage_getPermissionMapping, manage_setPermissionMapping

Inherited from AccessControl.PermissionMapping.RoleManager (private): _isBeingAccessedAsZClassDefinedInstanceMethod, _isBeingUsedAsAMethod

Class Methods

[hide private]

Inherited from ZenModel.ZenModelRM.RelationshipManager: lookupSchema

Class Variables

[hide private]

eventStateConversions = (('New', 0), ('Acknowledged', 1), ('Su...

eventActions = ('status', 'history', 'drop')

severityConversions = (('Critical', 5), ('Error', 4), ('Warnin...

severities = {0: 'Clear', 1: 'Debug', 2: 'Info', 3: 'Warning',...

priorityConversions = (('None', -1), ('Emergency', 0), ('Alert...

priorities = {-1: 'None', 0: 'Emergency', 1: 'Alert', 2: 'Crit...

statusTable = 'status'

detailTable = 'detail'

logTable = 'log'

lastTimeField = 'lastTime'

firstTimeField = 'firstTime'

deviceField = 'device'

componentField = 'component'

eventClassField = 'eventClass'

severityField = 'severity'

stateField = 'eventState'

countField = 'count'

prodStateField = 'prodState'

DeviceGroupField = 'DeviceGroups'

SystemField = 'Systems'

DeviceWhere = '"device = \'%s\'" % me.getDmdKey()'

DeviceResultFields = ('component', 'eventClass', 'summary', 'f...

ComponentWhere = '"(device = \'%s\' and component = \'%s\')" %...

ComponentResultFields = ('eventClass', 'summary', 'firstTime',...

IpAddressWhere = '"ipAddress=\'%s\'" % (me.getId())'

EventClassWhere = '"eventClass like \'%s%%\'" % me.getDmdKey()'

EventClassInstWhere = '"eventClass = \'%s\' and eventClassKey ...

DeviceClassWhere = '"DeviceClass like \'%s%%\'" % me.getDmdKey()'

LocationWhere = '"Location like \'%s%%\'" % me.getDmdKey()'

SystemWhere = '"Systems like \'%%|%s%%\'" % me.getDmdKey()'

DeviceGroupWhere = '"DeviceGroups like \'%%|%s%%\'" % me.getDm...

defaultResultFields = ('device', 'component', 'eventClass', 's...

defaultFields = ('eventState', 'severity', 'evid')

defaultEventId = ('device', 'component', 'eventClass', 'eventK...

requiredEventFields = ('device', 'summary', 'severity')

refreshConversionsForm = <App.special_dtml.DTMLFile object at ...

defaultAvailabilityDays = 7

defaultPriority = 3

eventAgingHours = 4

eventAgingSeverity = 4

_properties = ({'id': 'backend', 'mode': 'r', 'type': 'string'...

_relations = (('commands', <Products.ZenRelations.RelSchema.To...

factory_type_information = ({'actions': ({'action': 'editEvent...

security = ClassSecurityInfo()

__ac_permissions__ = (('Manage EventManager', ('manage_deleteC...

a = 'Debug'

b = 10

Inherited from Products.ZenModel.ZenModelRM.ZenModelRM: default_catalog, isInTree, meta_type

Inherited from Products.ZenModel.ZenModelBase.ZenModelBase: index_html, sub_meta_types

Inherited from ZenModel.ZenModelRM.RelationshipManager: manage_main, manage_options

Inherited from ZenModel.ZenModelRM.RelationshipManager (private): _operation

Inherited from OFS.ObjectManager.ObjectManager: SiteRootAdd, __implemented__, __provides__, isAnObjectManager, isPrincipiaFolderish, manage_addProduct, manage_addSiteRootForm, manage_importExportForm, manage_index_main, meta_types

Inherited from OFS.ObjectManager.ObjectManager (private): _objects

Inherited from OFS.CopySupport.CopyContainer: manage_renameForm

Inherited from App.Management.Navigation: manage, manage_copyright, manage_form_title, manage_menu, manage_page_footer, manage_page_header, manage_page_style.css, manage_top_frame, manage_zmi_prefs, zope_quick_start

Inherited from Products.ZenRelations.ZItem.ZItem: REQUEST, __allow_access_to_unprotected_subobjects__, __propsets__, icon, id, isTopLevelPrincipiaApplicationObject, title

Inherited from Products.ZenRelations.ZItem.ZItem (private): _manage_editedDialog

Inherited from App.Undo.UndoSupport: manage_UndoForm

Inherited from Products.ZenRelations.ZenPropertyManager.ZenPropertyManager: manage_propertiesForm

Inherited from OFS.PropertyManager.PropertyManager: manage_propertyTypeForm, propertysheets

Inherited from OFS.PropertyManager.PropertyManager (private): _reserved_names

Inherited from OFS.History.Historical: HistoricalRevisions, manage_change_history_page

Inherited from OFS.History.Historical (private): _manage_historyComparePage

Inherited from Products.ZenUtils.ObjectCache.ObjectCache: editCache

Inherited from DbAccessBase.DbAccessBase (private): _cpool

Inherited from App.Management.Tabs: manage_tabs

Inherited from webdav.Collection.Collection: __dav_collection__

Inherited from webdav.Resource.Resource: __dav_resource__, __http_methods__

Inherited from AccessControl.Role.RoleManager: __ac_local_roles__, __ac_roles__, aclAChecked, aclEChecked, aclPChecked, manage_acquiredForm, manage_editLocalRoles, manage_listLocalRoles, manage_permissionForm, manage_roleForm, permissionMappingPossibleValues, selectedRoles, smallRolesWidget

Inherited from AccessControl.Role.RoleManager (private): _method_manage_access, _normal_manage_access

Inherited from App.Management.Tabs: manage_tabs

Inherited from webdav.EtagSupport.EtagSupport: __implements__

Inherited from OFS.Traversable.Traversable: getPhysicalRoot

Inherited from AccessControl.Owned.Owned: manage_owner

Properties

[hide private]

Inherited from object: __class__

Inherited from persistent.Persistent (private): _p_changed, _p_jar, _p_mtime, _p_oid, _p_serial, _p_state

Inherited from object: __class__

Method Details

[hide private]

init(self, id, title=`''`, hostname=`'localhost'`, username=`'root'`, password=`''`, database=`'events'`, port=3306, defaultWhere=`''`, defaultOrderby=`''`, defaultResultFields=`[]`)
(Constructor)

source code

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: Products.ZenModel.ZenModelRM.ZenModelRM.__init__

getEventResultFields(self, context)

source code

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.

getEventListME(self, me, **kwargs)

source code

Queries the database for events on a managed entity.

Parameters:

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

Returns: list

ZEvent objects

getEventBatchME(self, me, selectstatus=None, resultFields=`[]`, where=`''`, orderby=`''`, severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter=`''`, goodevids=`[]`, badevids=`[]`, **kwargs)

source code

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) - DEPRECATED The base where clause to modify (ignored).
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

To Do: Remove unused parameters from the method definition

getEventList(self, resultFields=`[]`, where=`''`, orderby=`''`, severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter=`''`, **kwargs)

source code

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.

To Do: Remove unused parameters from the method definition

getEventSummaryME(self, me, severity=1, state=1, prodState=None)

source code

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].

getEventPillME(self, me, number=1, showGreen=False)

source code

Get HTML code displaying the maximum event severity and the number of events of that severity on a particular ManagedEntity in a pleasing pill-shaped container. Optionally return pills for lesser severities as well. Optionally return a green pill if there are no events (normally no events in a severity will not yield a result).

Parameters:

me (ManagedEntity) - The object regarding which event data should be queried.
number (int) - The number of pills to return
showGreen (bool) - Whether to return an empty green pill if all is well

Returns: list

HTML strings ready for template inclusion

getDeviceComponentEventSummary(self, device, REQUEST=None)

source code

Return a list of categories of components on a device along with event pills for the maximum severity event on each category in the form of a JSON object ready for inclusion in a YUI data table. If a category contains components with events, the component and its associated event pill are returned as a separate (indented) row.

Parameters:

device (Device) - The device for which to gather component data

Returns: string

A JSON-formatted string representation of the columns and rows of the table

getObjectsEventSummaryJSON(self, objects, REQUEST=None)

source code

Return an HTML link and event pill for each object passed as a JSON object ready for inclusion in a YUI data table.

Parameters:

objects (list) - The objects for which to create links and pills.

Returns: string

A JSON-formatted string representation of the columns and rows of the table

getEntityListEventSummary(self, entities=`[]`, REQUEST=None)

source code

A wrapper for getObjectsEventSummaryJSON that accepts a list of paths to Zope objects which it then attempts to resolve. If no list of paths is given, it will try to read them from the POST data of the REQUEST object.

Parameters:

entities (list) - A list of paths that should be resolved into objects and passed to getObjectsEventSummaryJSON.

Returns: string

A JSON-formatted string representation of the columns and rows of the table

getEventSummary(self, where=`''`, severity=1, state=1, prodState=None)

source code

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].

getGenericStatus(self, me)

source code

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

getEventOwnerList(self, where=`''`, severity=0, state=1)

source code

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

lookupManagedEntityResultFields(self, event_key)

source code

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.

_setupDateRange(self, startdate=DateTime('2007/10/25 16:27:14.644 GMT-4'), enddate=DateTime('2007/10/24 16:27:14.644 GMT-4'))

source code

Make a start and end date range that is at least one day long. returns a start and end date as a proper database element.

loadSchema(self)

source code

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

zmanage_editProperties(self, REQUEST=None)

source code

Need to handle editing of history event fields differently

Overrides: Products.ZenModel.ZenModelRM.ZenModelRM.zmanage_editProperties

Class Variable Details

[hide private]

eventStateConversions

Value:

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

severityConversions

Value:

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

severities

Value:

{0: 'Clear',
 1: 'Debug',
 2: 'Info',
 3: 'Warning',
 4: 'Error',
 5: 'Critical'}

priorityConversions

Value:

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

priorities

Value:

{-1: 'None',
 0: 'Emergency',
 1: 'Alert',
 2: 'Critical',
 3: 'Error',
 4: 'Warning',
 6: 'Notice',
 8: 'Info',
...

DeviceResultFields

Value:

('component',
 'eventClass',
 'summary',
 'firstTime',
 'lastTime',
 'count')

ComponentWhere

Value:

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

ComponentResultFields

Value:

('eventClass', 'summary', 'firstTime', 'lastTime', 'count')

EventClassInstWhere

Value:

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

DeviceGroupWhere

Value:

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

defaultResultFields

Value:

('device',
 'component',
 'eventClass',
 'summary',
 'firstTime',
 'lastTime',
 'count')

defaultEventId

Value:

('device', 'component', 'eventClass', 'eventKey', 'severity')

refreshConversionsForm

Value:

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

_properties

Value:

({'id': 'backend', 'mode': 'r', 'type': 'string'},
 {'id': 'username', 'mode': 'w', 'type': 'string'},
 {'id': 'password', 'mode': 'w', 'type': 'string'},
 {'id': 'host', 'mode': 'w', 'type': 'string'},
 {'id': 'database', 'mode': 'w', 'type': 'string'},
 {'id': 'port', 'mode': 'w', 'type': 'int'},
 {'id': 'defaultWhere', 'mode': 'w', 'type': 'text'},
 {'id': 'defaultOrderby', 'mode': 'w', 'type': 'text'},
...

_relations

Value:

"commands", ToManyCont(ToOne, "Products.ZenEvents.EventCommand", "even
tManager"),

factory_type_information

Value:

({'actions': ({'action': 'editEventManager',
               'id': 'edit',
               'name': 'Edit',
               'permissions': ('Manage DMD')},
              {'action': 'editEventManagerFields',
               'id': 'edit',
               'name': 'Fields',
               'permissions': ('Manage DMD')},
...

__ac_permissions__

Value:

(('Manage EventManager',
  ('manage_deleteCommands',
   'manage_addCommand',
   'manage_addLogMessage',
   'manage_clearCache',
   'manage_refreshConversions',
   'manage_clearHeartbeats',
   'zmanage_editProperties',
...

Class EventManagerBase

__init__(self, id, title='', hostname='localhost', username='root', password='', database='events', port=3306, defaultWhere='', defaultOrderby='', defaultResultFields=[]) (Constructor)

getEventResultFields(self, context)

getEventListME(self, me, **kwargs)

getEventBatchME(self, me, selectstatus=None, resultFields=[], where='', orderby='', severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter='', goodevids=[], badevids=[], **kwargs)

getEventList(self, resultFields=[], where='', orderby='', severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter='', **kwargs)

getEventSummaryME(self, me, severity=1, state=1, prodState=None)

getEventPillME(self, me, number=1, showGreen=False)

getDeviceComponentEventSummary(self, device, REQUEST=None)

getObjectsEventSummaryJSON(self, objects, REQUEST=None)

getEntityListEventSummary(self, entities=[], REQUEST=None)

getEventSummary(self, where='', severity=1, state=1, prodState=None)

getGenericStatus(self, me)

getEventOwnerList(self, where='', severity=0, state=1)

lookupManagedEntityResultFields(self, event_key)

_setupDateRange(self, startdate=DateTime('2007/10/25 16:27:14.644 GMT-4'), enddate=DateTime('2007/10/24 16:27:14.644 GMT-4'))

loadSchema(self)

zmanage_editProperties(self, REQUEST=None)

eventStateConversions

severityConversions

severities

priorityConversions

priorities

DeviceResultFields

ComponentWhere

ComponentResultFields

EventClassInstWhere

DeviceGroupWhere

defaultResultFields

defaultEventId

refreshConversionsForm

_properties

_relations

factory_type_information

__ac_permissions__

init(self, id, title=`''`, hostname=`'localhost'`, username=`'root'`, password=`''`, database=`'events'`, port=3306, defaultWhere=`''`, defaultOrderby=`''`, defaultResultFields=`[]`)
(Constructor)

getEventBatchME(self, me, selectstatus=None, resultFields=`[]`, where=`''`, orderby=`''`, severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter=`''`, goodevids=`[]`, badevids=`[]`, **kwargs)

getEventList(self, resultFields=`[]`, where=`''`, orderby=`''`, severity=None, state=2, startdate=None, enddate=None, offset=0, rows=0, getTotalCount=False, filter=`''`, **kwargs)

getEntityListEventSummary(self, entities=`[]`, REQUEST=None)

getEventSummary(self, where=`''`, severity=1, state=1, prodState=None)

getEventOwnerList(self, where=`''`, severity=0, state=1)