-
public final class ViewEventSchema 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 classViewEvent.Companionpublic final classViewEvent.ApplicationApplication properties
public final classViewEvent.ViewEventSessionSession properties Session properties
public final classViewEvent.ViewEventViewView properties View properties
public final classViewEvent.UsrUser properties
public final classViewEvent.AccountAccount properties
public final classViewEvent.ConnectivityDevice connectivity properties
public final classViewEvent.DisplayDisplay properties Display properties
public final classViewEvent.SyntheticsSynthetics properties
public final classViewEvent.CiTestCI Visibility properties
public final classViewEvent.OsOperating system properties
public final classViewEvent.DeviceDevice properties
public final classViewEvent.DdInternal properties Internal properties
public final classViewEvent.ContextUser provided context
public final classViewEvent.ContainerView Container properties (view wrapping the current view)
public final classViewEvent.PrivacyPrivacy properties
public final classViewEvent.CustomTimingsUser custom timings of the view. As timing name is used as facet path, it must contain only letters, digits, or the characters - _ . @ $
public final classViewEvent.ActionProperties of the actions of the view
public final classViewEvent.ErrorProperties of the errors of the view
public final classViewEvent.CrashProperties of the crashes of the view
public final classViewEvent.LongTaskProperties of the long tasks of the view
public final classViewEvent.FrozenFrameProperties of the frozen frames of the view
public final classViewEvent.SlowFrameProperties of the slow frames
public final classViewEvent.ResourceProperties of the resources of the view
public final classViewEvent.FrustrationProperties of the frustrations of the view
public final classViewEvent.InForegroundPeriodProperties of the foreground period of the view
public final classViewEvent.FlutterBuildTimeSchema of properties for a technical performance metric
public final classViewEvent.PerformanceSchema for view-level RUM performance data (Web Vitals, etc.)
public final classViewEvent.AccessibilityCompact representation of accessibility features for a view
public final classViewEvent.CellularCellular connectivity properties
public final classViewEvent.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 classViewEvent.ScrollScroll properties
public final classViewEvent.DdSessionSession-related internal properties
public final classViewEvent.ConfigurationSubset of the SDK configuration options in use during its execution Subset of the SDK configuration options in use during its execution
public final classViewEvent.PageStateProperties of the page state
public final classViewEvent.ReplayStatsDebug metadata for Replay Sessions
public final classViewEvent.DdClsAdditional information of the reported Cumulative Layout Shift
public final classViewEvent.ProfilingRUM Profiler Internal Context schema
public final classViewEvent.ContainerViewAttributes of the view's container
public final classViewEvent.PerformanceClsCumulative Layout Shift
public final classViewEvent.FcpFirst Contentful Paint
public final classViewEvent.FidFirst Input Delay
public final classViewEvent.InpInteraction to Next Paint
public final classViewEvent.LcpLargest Contentful Paint
public final classViewEvent.FbcFirst Build Complete (Flutter)
public final classViewEvent.PreviousRectSchema for DOMRect-like rectangles describing an element's bounding client rect
public enumViewEvent.ViewEventSourceThe source of this event
public enumViewEvent.ViewEventSessionTypeType of the session
public enumViewEvent.LoadingTypeType of the loading of the view
public enumViewEvent.ConnectivityStatusStatus of the device connectivity
public enumViewEvent.Interfacepublic enumViewEvent.EffectiveTypeCellular connection type reflecting the measured network performance
public enumViewEvent.DeviceTypeDevice type info
public enumViewEvent.ReplayLevelThe replay privacy level
public enumViewEvent.PlanSession plan: 1 is the plan without replay, 2 is the plan with replay (deprecated)
public enumViewEvent.SessionPreconditionThe precondition that led to the creation of the session
public enumViewEvent.StatePage state name
public enumViewEvent.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 enumViewEvent.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
Fields Modifier and Type Field Description private final Stringtypeprivate final Longdateprivate final ViewEvent.Applicationapplicationprivate final Stringserviceprivate final Stringversionprivate final StringbuildVersionprivate final StringbuildIdprivate final Stringddtagsprivate final ViewEvent.ViewEventSessionsessionprivate final ViewEvent.ViewEventSourcesourceprivate final ViewEvent.ViewEventViewviewprivate final ViewEvent.Usrusrprivate final ViewEvent.Accountaccountprivate final ViewEvent.Connectivityconnectivityprivate final ViewEvent.Displaydisplayprivate final ViewEvent.Syntheticssyntheticsprivate final ViewEvent.CiTestciTestprivate final ViewEvent.Ososprivate final ViewEvent.Devicedeviceprivate final ViewEvent.Ddddprivate final ViewEvent.Contextcontextprivate final ViewEvent.Containercontainerprivate final ViewEvent.ContextfeatureFlagsprivate final ViewEvent.Privacyprivacy
-
Constructor Summary
Constructors Constructor Description ViewEvent(Long date, ViewEvent.Application application, String service, String version, String buildVersion, String buildId, String ddtags, ViewEvent.ViewEventSession session, ViewEvent.ViewEventSource source, ViewEvent.ViewEventView view, ViewEvent.Usr usr, ViewEvent.Account account, ViewEvent.Connectivity connectivity, ViewEvent.Display display, ViewEvent.Synthetics synthetics, ViewEvent.CiTest ciTest, ViewEvent.Os os, ViewEvent.Device device, ViewEvent.Dd dd, ViewEvent.Context context, ViewEvent.Container container, ViewEvent.Context featureFlags, ViewEvent.Privacy privacy)
-
Method Summary
Modifier and Type Method Description final StringgetType()final LonggetDate()final ViewEvent.ApplicationgetApplication()final StringgetService()final StringgetVersion()final StringgetBuildVersion()final StringgetBuildId()final StringgetDdtags()final ViewEvent.ViewEventSessiongetSession()final ViewEvent.ViewEventSourcegetSource()final ViewEvent.ViewEventViewgetView()final ViewEvent.UsrgetUsr()final ViewEvent.AccountgetAccount()final ViewEvent.ConnectivitygetConnectivity()final ViewEvent.DisplaygetDisplay()final ViewEvent.SyntheticsgetSynthetics()final ViewEvent.CiTestgetCiTest()final ViewEvent.OsgetOs()final ViewEvent.DevicegetDevice()final ViewEvent.DdgetDd()final ViewEvent.ContextgetContext()final ViewEvent.ContainergetContainer()final ViewEvent.ContextgetFeatureFlags()final ViewEvent.PrivacygetPrivacy()final JsonElementtoJson()-
-
Constructor Detail
-
ViewEvent
ViewEvent(Long date, ViewEvent.Application application, String service, String version, String buildVersion, String buildId, String ddtags, ViewEvent.ViewEventSession session, ViewEvent.ViewEventSource source, ViewEvent.ViewEventView view, ViewEvent.Usr usr, ViewEvent.Account account, ViewEvent.Connectivity connectivity, ViewEvent.Display display, ViewEvent.Synthetics synthetics, ViewEvent.CiTest ciTest, ViewEvent.Os os, ViewEvent.Device device, ViewEvent.Dd dd, ViewEvent.Context context, ViewEvent.Container container, ViewEvent.Context featureFlags, ViewEvent.Privacy privacy)
- 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 properties Session propertiessource- The source of this eventview- View properties View propertiesusr- User propertiesaccount- Account propertiesconnectivity- Device connectivity propertiesdisplay- Display properties 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)featureFlags- Feature flags propertiesprivacy- Privacy properties
-
-
Method Detail
-
getApplication
final ViewEvent.Application getApplication()
-
getService
final String getService()
-
getVersion
final String getVersion()
-
getBuildVersion
final String getBuildVersion()
-
getBuildId
final String getBuildId()
-
getSession
final ViewEvent.ViewEventSession getSession()
-
getSource
final ViewEvent.ViewEventSource getSource()
-
getView
final ViewEvent.ViewEventView getView()
-
getUsr
final ViewEvent.Usr getUsr()
-
getAccount
final ViewEvent.Account getAccount()
-
getConnectivity
final ViewEvent.Connectivity getConnectivity()
-
getDisplay
final ViewEvent.Display getDisplay()
-
getSynthetics
final ViewEvent.Synthetics getSynthetics()
-
getCiTest
final ViewEvent.CiTest getCiTest()
-
getOs
final ViewEvent.Os getOs()
-
getDevice
final ViewEvent.Device getDevice()
-
getDd
final ViewEvent.Dd getDd()
-
getContext
final ViewEvent.Context getContext()
-
getContainer
final ViewEvent.Container getContainer()
-
getFeatureFlags
final ViewEvent.Context getFeatureFlags()
-
getPrivacy
final ViewEvent.Privacy getPrivacy()
-
toJson
final JsonElement toJson()
-
-
-
-