Package lumis.portal.monitor

Defines classes and interfaces for monitoring data.

See: Description

Interface Summary

Interface	Description
IMonitor	A monitor that allows the collection of data related to a specific event.
IMonitorContext	Stores contextual data for use by the monitoring framework.
IMonitorEvent	An event that may be monitored.
IMonitorEventField	Represents a field instance in an event.
IMonitorField	A field of a monitoring event.
IMonitorManager	Provides operations and access to the portal monitoring framework.
IMonitorManagerSPI	Monitor SPI interface.
IMonitorValuesProvider	Interface that provides data to monitor framework when it needs. For performance reasons, IMonitorValuesProvider implementations should guarantee that no unnecessary processing is performed (even more when it is costly) in its constructor.

Class Summary

Class	Description
AbstractMonitorValuesProvider	IMonitorValuesProvider abstract implementation that provides both tread-safety and caching. The monitoring values are internally stored as a map.
DummyMonitorManager	An implementation of IMonitorManager that does not monitor anything.
MonitorFields	Class for organizing the standard monitoring fields identifiers.
MonitorFields.Action	The action related fields.
MonitorFields.Action.Object	The action object related fields.
MonitorFields.Client	The client related fields.
MonitorFields.Client.Device	The client device related fields.
MonitorFields.Client.Origin	The origin related fields.
MonitorFields.Client.Origin.Campaign	The origin campaign related fields.
MonitorFields.Client.UserAgent	The client user agent related fields.
MonitorFields.File	The file related fields.
MonitorFields.HttpSession	The HTTP session related fields.
MonitorFields.Measure	The measure related fields.
MonitorFields.ObjectInteraction	The object interaction related fields.
MonitorFields.ObjectInteraction.TargetObject	The target object related fields.
MonitorFields.ObjectInteraction.TargetObject.Service	The target object related fields.
MonitorFields.ObjectInteraction.TargetObject.ServiceInstance	The target object service instance related fields.
MonitorFields.Page	The page related fields.
MonitorFields.Page.BusinessContext	The page's business context.
MonitorFields.Page.Channel	The page's channel related fields.
MonitorFields.Presentation	The presentation related fields.
MonitorFields.Server	The server related fields.
MonitorFields.Service	The service related fields.
MonitorFields.ServiceInstance	The service instance related fields.
MonitorFields.ServiceInstance.Channel	The service instance's channel related fields.
MonitorFields.ServiceInterface	The service interface related fields.
MonitorFields.ServiceInterfaceInstance	The service interface instance related fields.
MonitorFields.Transaction	The transaction related fields.
MonitorFields.User	The user related fields.
MonitorFields.User.Attributes	User's attributes.
MonitorFields.User.Session	User's session related fields.
MonitorFields.WebResource	The web resource related fields.
MonitorFields.WebResource.Rendered	The rendered web resource related fields.
MonitorFields.Website	The website related fields.
MonitorHelper	Monitor helper class responsible for providing an easy way to add and remove values in the current IMonitorContext. The basic usage for this class is:
MonitorUtil	Utility methods for the monitoring framework.
SimpleMonitorValuesProvider	Simple IMonitorValuesProvider that holds and serves a map of values.

Enum Summary

Enum	Description
IMonitorField.DataType	The possible data type for an event field.

Exception Summary

Exception	Description
FieldNotProvidedException	Exception used to indicate a certain field is not provided by an IMonitorValuesProvider.

Package lumis.portal.monitor Description

Defines classes and interfaces for monitoring data.

To monitor data, you must define an event to be monitored. An event is specified by the IMonitorEvent interface.

The monitoring data is saved in the default big data repository. The data is saved in the form of a Document per collected event. Each field of the event will be a field in the generated and saved document.

The entry point for the monitoring framework API is the IMonitorManager. It may be obtained by calling ManagerFactory.getMonitorManager(). To collect data, obtain an IMonitor and use its available operations.

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $