-
public final class VitalOperationStepEventSchema of common properties of RUM events View Container schema for views that are nested (webviews in mobile)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classVitalOperationStepEvent.Companionpublic final classVitalOperationStepEvent.ApplicationApplication properties
public final classVitalOperationStepEvent.VitalOperationStepEventSessionSession properties
public final classVitalOperationStepEvent.VitalOperationStepEventViewView properties
public final classVitalOperationStepEvent.UsrUser properties
public final classVitalOperationStepEvent.AccountAccount properties
public final classVitalOperationStepEvent.ConnectivityDevice connectivity properties
public final classVitalOperationStepEvent.DisplayDisplay properties
public final classVitalOperationStepEvent.SyntheticsSynthetics properties
public final classVitalOperationStepEvent.CiTestCI Visibility properties
public final classVitalOperationStepEvent.OsOperating system properties
public final classVitalOperationStepEvent.DeviceDevice properties
public final classVitalOperationStepEvent.DdInternal properties Internal properties
public final classVitalOperationStepEvent.ContextUser provided context
public final classVitalOperationStepEvent.ContainerView Container properties (view wrapping the current view)
public final classVitalOperationStepEvent.VitalVital properties Vital properties
public final classVitalOperationStepEvent.CellularCellular connectivity properties
public final classVitalOperationStepEvent.ViewportThe viewport represents the rectangular area that is currently being viewed. Content outside the viewport is not visible onscreen until scrolled into view.
public final classVitalOperationStepEvent.DdSessionSession-related internal properties
public final classVitalOperationStepEvent.ConfigurationSubset of the SDK configuration options in use during its execution
public final classVitalOperationStepEvent.ProfilingRUM Profiler Internal Context schema
public final classVitalOperationStepEvent.ContainerViewAttributes of the view's container
public enumVitalOperationStepEvent.VitalOperationStepEventSourceThe source of this event
public enumVitalOperationStepEvent.VitalOperationStepEventSessionTypeType of the session
public enumVitalOperationStepEvent.ConnectivityStatusStatus of the device connectivity
public enumVitalOperationStepEvent.Interfacepublic enumVitalOperationStepEvent.EffectiveTypeCellular connection type reflecting the measured network performance
public enumVitalOperationStepEvent.DeviceTypeDevice type info
public enumVitalOperationStepEvent.StepTypeType of the step that triggered the vital, if applicable
public enumVitalOperationStepEvent.FailureReasonReason for the failure of the step, if applicable
public enumVitalOperationStepEvent.PlanSession plan: 1 is the plan without replay, 2 is the plan with replay (deprecated)
public enumVitalOperationStepEvent.SessionPreconditionThe precondition that led to the creation of the session
public enumVitalOperationStepEvent.ProfilingStatusUsed to track the status of the RUM Profiler.
They are defined in order of when they can happen, from the moment the SDK is initialized to the moment the Profiler is actually running.
starting: The Profiler is starting (i.e., when the SDK just started). This is the initial status.running: The Profiler is running.stopped: The Profiler is stopped.error: The Profiler encountered an error. Seeerror_reasonfor more details.
public enumVitalOperationStepEvent.ErrorReasonThe reason the Profiler encountered an error. This attribute is only present if the status is
error.Possible values:
not-supported-by-browser: The browser does not support the Profiler (i.e.,window.Profileris not available).failed-to-lazy-load: The Profiler script failed to be loaded by the browser (may be a connection issue or the chunk was not found).missing-document-policy-header: The Profiler failed to start because its missingDocument-Policy: js-profilingHTTP response header.unexpected-exception: An exception occurred when starting the Profiler.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description VitalOperationStepEvent(Long date, VitalOperationStepEvent.Application application, String service, String version, String buildVersion, String buildId, String ddtags, VitalOperationStepEvent.VitalOperationStepEventSession session, VitalOperationStepEvent.VitalOperationStepEventSource source, VitalOperationStepEvent.VitalOperationStepEventView view, VitalOperationStepEvent.Usr usr, VitalOperationStepEvent.Account account, VitalOperationStepEvent.Connectivity connectivity, VitalOperationStepEvent.Display display, VitalOperationStepEvent.Synthetics synthetics, VitalOperationStepEvent.CiTest ciTest, VitalOperationStepEvent.Os os, VitalOperationStepEvent.Device device, VitalOperationStepEvent.Dd dd, VitalOperationStepEvent.Context context, VitalOperationStepEvent.Container container, VitalOperationStepEvent.Vital vital)
-
Method Summary
-
-
Constructor Detail
-
VitalOperationStepEvent
VitalOperationStepEvent(Long date, VitalOperationStepEvent.Application application, String service, String version, String buildVersion, String buildId, String ddtags, VitalOperationStepEvent.VitalOperationStepEventSession session, VitalOperationStepEvent.VitalOperationStepEventSource source, VitalOperationStepEvent.VitalOperationStepEventView view, VitalOperationStepEvent.Usr usr, VitalOperationStepEvent.Account account, VitalOperationStepEvent.Connectivity connectivity, VitalOperationStepEvent.Display display, VitalOperationStepEvent.Synthetics synthetics, VitalOperationStepEvent.CiTest ciTest, VitalOperationStepEvent.Os os, VitalOperationStepEvent.Device device, VitalOperationStepEvent.Dd dd, VitalOperationStepEvent.Context context, VitalOperationStepEvent.Container container, VitalOperationStepEvent.Vital vital)
- Parameters:
date- Start of the event in ms from epochapplication- Application propertiesservice- The service name for this applicationversion- The version for this applicationbuildVersion- The build version for this applicationbuildId- Generated unique ID of the application build.ddtags- Tags of the event in key:value format, separated by commas (e.g.session- Session propertiessource- The source of this eventview- View propertiesusr- User propertiesaccount- Account propertiesconnectivity- Device connectivity propertiesdisplay- Display propertiessynthetics- Synthetics propertiesciTest- CI Visibility propertiesos- Operating system propertiesdevice- Device propertiesdd- Internal properties Internal propertiescontext- User provided contextcontainer- View Container properties (view wrapping the current view)vital- Vital properties Vital properties
-
-
Method Detail
-
getApplication
final VitalOperationStepEvent.Application getApplication()
-
getService
final String getService()
-
getVersion
final String getVersion()
-
getBuildVersion
final String getBuildVersion()
-
getBuildId
final String getBuildId()
-
getSession
final VitalOperationStepEvent.VitalOperationStepEventSession getSession()
-
getSource
final VitalOperationStepEvent.VitalOperationStepEventSource getSource()
-
getView
final VitalOperationStepEvent.VitalOperationStepEventView getView()
-
getUsr
final VitalOperationStepEvent.Usr getUsr()
-
getAccount
final VitalOperationStepEvent.Account getAccount()
-
getConnectivity
final VitalOperationStepEvent.Connectivity getConnectivity()
-
getDisplay
final VitalOperationStepEvent.Display getDisplay()
-
getSynthetics
final VitalOperationStepEvent.Synthetics getSynthetics()
-
getCiTest
final VitalOperationStepEvent.CiTest getCiTest()
-
getOs
final VitalOperationStepEvent.Os getOs()
-
getDevice
final VitalOperationStepEvent.Device getDevice()
-
getDd
final VitalOperationStepEvent.Dd getDd()
-
getContext
final VitalOperationStepEvent.Context getContext()
-
getContainer
final VitalOperationStepEvent.Container getContainer()
-
getVital
final VitalOperationStepEvent.Vital getVital()
-
toJson
final JsonElement toJson()
-
-
-
-