Changes

Sessions are essentially scopes. They are meant to give context to events; this allows events to be more simple and reusable. Sessions are usually bound to some component of the UI. They are started when the , some user begins interacting action with the UI component and are stopped when the user leaves. They also allow you record how long a user interacts with a given UI component. A simple use-case for sessions is the bookmarks panel in about:home. We start a session when the user swipes into the panel and stop it when they leave. This bookmarks session does two things: Firstly, it gives scope to any generic event that may occur within the panel (e.g loading a URL). Secondlyduration, it allows us to figure out how much time users are spending in the bookmarks panelor some transient state.

To start For example, a session, call ''Telemetry.startUISession(String sessionName)''. Session names should might be brief, lowercase, and should describe what UI component the begun when a user is begins interacting with. In certain cases where the UI component is dynamic, they could include an ID, essential to identifying that componentand stopped when the interaction ends. An example of this is with dynamic home panels, we use session names They implicitly record the duration of the format "''homepanel:<panel_id>''" to identify home panel sessionsinteraction.

A simple use-case for sessions is the bookmarks panel in about:home. We start a session when the user swipes into the panel, and stop it when they swipe away. This bookmarks session does two things: firstly, it gives scope to any generic event that may occur within the panel (e.g., loading a URL). Secondly, it allows us to figure out how much time users are spending in the bookmarks panel. To start a session, call ''Telemetry.startUISession(String sessionName)''. Session names should be brief, lowercase, and should describe which UI component the user is interacting with. In certain cases where the UI component is dynamic, they could include an ID, essential to identifying that component. An example of this is with dynamic home panels, we use session names of the format "''homepanel:<panel_id>''" to identify home panel sessions.  To stop a session call ''Telemetry.stopUISession(String sessionName, String reason)''. ''sessionName'' is the name of the open session and ''reason'' is essentially a descriptive cause for the reason the session was stoppedending. The reason field should capture why the user stopped interacting with the UI component; it . It should be brief, lowercase , and generic so it can be reused in different places. Examples reasons are:

Events capture key occurrences that of importance to us. They should be brief and simple, and should not contain sensitive or excess information. Context for events should come from the session (scope). An event can be created with four fields (via ''Telemetry.sendUIEvent''): action, method, extras, and timestamp.

* '''method''' (Optional): used for user actions that can be performed in many ways. This field specifies the method in which the action was performed. For e.gexample, say we want to record an event for when a user adds users can add an item to their reading list. This action can be performed either by either long-tapping the reader icon in the address bar , or done from within reader mode. We would use the same event name for both user actions but specify two methods: "addressbar" and "readermode".

* '''extras''' (Optional): for extra information that may be useful in understanding the event. It is important Make an effort to keep this very brief.

* '''timestamp''' (Optional): time the event occurred. If not specified this field defaults to the current value of the realtime clock.