PHP logging

EventLogging::logEvent( 'GettingStartedNavbar', 5588671, $event );

extension.json setup for JavaScript logging

{
	"attributes": {
		"EventLogging": {
			"Schemas": {
				"GettingStartedNavbar": 5588671
			}
		}
	}
}

JavaScript logging

mw.track( 'event.GettingStartedNavbar', { /* ... */ } );

Schema:GettingStartedNavbar

From Meta, a Wikimedia project coordination wiki
Revision 5588671
Jump to navigation Jump to search
description"Logs events related to tasks assigned to new registered users via the GettingStarted extension. In this experiment we test three different types of tasks: 1. adding links 2. copyediting 3. improving clarity We also control for users returning to the referral page via the returnTo link. A navigation bar and guiders are displayed when users land on a GettingStarted article."
properties
version
type"integer"
requiredtrue
description"Version number"
action
type"string"
requiredtrue
enum
"welcomepage-impression"
"welcomepage-click"
"gettingstarted-specialpage-impression"
"gettingstarted-click"
"page-impression"
"page-edit-impression"
"page-save-attempt"
"page-save-success"
"navbar-return-click"
"navbar-next-click"
description"The actions involved in accepting a task and completing it. welcomepage-impression occurs immediately after they signup, whether they see the GettingStarted UI or the control (built-in UI) welcomepage-click is used for both test and control, for items that only appear on the post-signup welcome page, excluding GettingStarted task clicks which are logged as gettingstarted-click; this event currently only applies to clicks on the returnto button. gettingstarted-specialpage-impression occurs if they visit the actual Special:GettingStarted page (i.e., not immediately post-signup) gettingstarted-click means a click on an article task (gettingstarted-* task). It can occur on the post-signup welcome page or on the actual Special:GettingStarted page. The other events occur on a page linked from the post-signup welcome page when users visit it (either a task page or the referral page linked via returnTo) page-edit-impression also logs if user opens a protected page by clicking on [View source] (see isEditable field below). Navbar events refer to actions taken on the navigation bar given to users on task articles: * navbar-return-click means they clicked 'Return to list'. * navbar-next-click means they clicked 'Try another article'."
isNavbarVisible
type"boolean"
description"Whether the navbar is visible. Logged on all client-side page-* events: page-impression page-edit-impression page-save-success"
source
type"string"
enum
"navbar-return"
"navbar-next"
"gettingstarted"
description"Logs the source of a gettingstarted-specialpage-impression or page-impression event. NULL source for gettingstarted-specialpage-impression and page-impression is possible (if none of the below apply), NULL source for page-edit-impression is required. navbar-return applies only to gettingstarted-specialpage-impression: * navbar-return means they clicked 'Return to list'. navbar-next and gettingstarted apply only to page-impression: * navbar-next means the source was the 'Try another' article navbar link. * gettingstarted means the source was GettingStarted (either actual special page or post-signup landing page)."
funnel
type"string"
description"Identifies the funnel in which an action is occurring. It is logged on the page-*, navbar-*, welcomepage-click, and gettingstarted-click events. For welcomepage-click, it must be 'returnto'. For gettingstarted-click, it must be one of the others in this enum *besides* 'returnto'."
enum
"gettingstarted-addlinks"
"gettingstarted-copyedit"
"gettingstarted-clarify"
"returnto"
bucket
type"string"
requiredtrue
enum
"test"
"control"
description"Identifies the experimental bucket a user is randomly assigned to."
pageId
type"integer"
description"ID of the target article the user is invited to edit, or currently attempting to edit, if available. Logged only on: * page-impression * page-edit-impression * page-save-attempt * page-save-success * navbar-return-click * navbar-next-click. But it always applies to the current page, not the page they are clicking to (e.g. for navbar-next-click)"
revId
type"integer"
description"Current revision of the target article the user is invited to edit, or currently attempting to edit, if available. For page-save-attempt, it is the old revId for the article, since it is not yet known whether the edit will succeed. Is updated to the latest revision for action=page-save-success events. Available for same actions as pageId"
userId
type"integer"
description"User ID (events from anonymous users are not logged)"
requiredtrue
isNew
type"boolean"
description"Always sent as true with welcomepage-impression and welcomepage-click, whether it is test or control. Always sent as false with gettingstarted-specialpage-impression Also sent for gettingstarted-click, in which case it is the same as the isNew on the current impression"
isEditable
type"boolean"
description"True if the target article the user is invited to edit (or attempting to edit for page-save-attempt) is editable based on user privileges"