Package lumis.portal.monitor
Defines classes and interfaces for monitoring data.
The data collected is of an event
.
Events have fields
and field groups
.
To declare events, fields and field groups, a file named monitor-definition.xml
may be added in some module to be deployed.
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 one or more fields
in the generated and saved document, depending on what is it's data type
.
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: 21005 $ $Date: 2018-03-06 18:13:47 -0300 (Tue, 06 Mar 2018) $
-
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.IMonitorContextSPI Monitor context internal operations.IMonitorElementSPI<T extends IMonitorElementSPI<T>> Represents a monitor element (event, field or field group).IMonitorEvent An event that may be monitored.IMonitorEventSPI An event that may be monitored.IMonitorField A field of a monitoringevent
.IMonitorFieldGroup Represents a named group offields
.IMonitorFieldGroupInstance Represents anIMonitorFieldGroup
instance within a givenIMonitorEvent
.IMonitorFieldGroupInstanceSPI IMonitorFieldGroupSPI IMonitorFieldInstance Represents a field instance in an event.IMonitorFieldInstanceSPI IMonitorFieldSPI A field of a monitoringevent
.IMonitorFilter Provides a filter to be applied during events monitoring.IMonitorManager Provides operations and access to the portal monitoring framework.IMonitorManagerSPI Monitor SPI interface.IMonitorStatistics Provides monitoring framework statistics.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 amap
.MonitorFields Class for organizing the standard monitoring fields identifiers.MonitorFields.APMMetric The APM Metric related fields.MonitorFields.AutomationFlow Automation flow-related fields.MonitorFields.AutomationFlow.Node The node related fields.MonitorFields.AutomationFlow.Node.AddUserAttribute The add user attribute node related fields.MonitorFields.AutomationFlow.Node.CustomAction The custom action node related fields.MonitorFields.AutomationFlow.Node.RemoveUserAttribute The remove user attribute node related fields.MonitorFields.AutomationFlow.Node.SendEmailAction The email send action node related fields.MonitorFields.AutomationFlow.Node.WaitAction The wait action node related fields.MonitorFields.Banner Banner related fieldsMonitorFields.Client The client related fields.MonitorFields.Client.Device The client device related fields.MonitorFields.Client.DOM The client DOM related fields.MonitorFields.Client.DOM.Element The client DOM element related fields.MonitorFields.Client.InitialOrigin The initial origin related fields.MonitorFields.Client.InitialOrigin.Campaign The initial origin campaign 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.Client.UserAgent.Browser The fields related to the browser information extracted from client user agent.MonitorFields.Client.UserAgent.Browser.Version The fields containing the versions of the browser, extracted from the client user agent.MonitorFields.Client.UserAgent.Device The fields related to the device information extracted from client user agent.MonitorFields.Client.UserAgent.Os The fields related to the operating system information extracted from client user agent.MonitorFields.Client.UserAgent.Os.Version The fields containing the versions of the operating system, extracted from the client user agent.MonitorFields.CommentIt Comments related fields.MonitorFields.Doui Doui related fields.MonitorFields.Doui.Rest The doui's rest related fieldsMonitorFields.Event The event related fields.MonitorFields.Event.Experiments A/B test active experiments fieldMonitorFields.Event.Failure Event failure information.MonitorFields.Event.Success Event success information.MonitorFields.File The file related fields.MonitorFields.Journey The Journey related fields.MonitorFields.Journey.Exit The Journey Exit related fields.MonitorFields.Journey.OriginStage The Journey Origin Stage related fields.MonitorFields.Journey.TargetStage The Journey Target Stage related fields.MonitorFields.LikeIt Likes related fields.MonitorFields.Object The content object related fields.MonitorFields.Object.Categories The categories of object related fields.MonitorFields.Object.Publications The publications of object related fieldsMonitorFields.Object.ServiceInstance The service instance of object related fields.MonitorFields.Object.Tags The tags of object related fieldsMonitorFields.Page The page related fields.MonitorFields.Page.Channel The page's channel related fields.MonitorFields.PageCache Page cache related fields.MonitorFields.Request The request related fields.MonitorFields.Request.BusinessContext Request business context fields.MonitorFields.Response The response related fields.MonitorFields.Search Search 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.Attributes.TypeBoolean Boolean attribute type fields.MonitorFields.User.Attributes.TypeDateTime Date time attribute type fields.MonitorFields.User.Attributes.TypeDouble Double attribute type fields.MonitorFields.User.Attributes.TypeKeyword Keyword attribute type fields.MonitorFields.User.Attributes.TypeLong Long attribute type fields.MonitorFields.User.Attributes.TypeString String attribute type fields.MonitorFields.User.Attributes.TypeText Text attribute type fields.MonitorFields.User.Attributes.TypeUrl URL attribute type fields.MonitorFields.User.Journeys User journey fields.MonitorFields.User.Journeys.Stage MonitorFields.User.Name User's name.MonitorFields.UserSegmentation User segmentation-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 currentIMonitorContext
.
The basic usage for this class is:
MonitorUtil Utility methods for the monitoring framework.MonitorUtilInternal SimpleMonitorValuesProvider SimpleIMonitorValuesProvider
that holds and serves a map of values. -
Enum Summary Enum Description IMonitorField.DataType The possible data type for an event field.