PHP logging

EventLogging::logEvent( 'VisualEditorFeatureUse', 20118253, $event );

extension.json setup for JavaScript logging

{
	"attributes": {
		"EventLogging": {
			"Schemas": {
				"VisualEditorFeatureUse": 20118253
			}
		}
	}
}

JavaScript logging

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

Schema:VisualEditorFeatureUse: Difference between revisions

From Meta, a Wikimedia project coordination wiki
Revision 20118253
Jump to navigation Jump to search
(Remove second enum)
No edit summary
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{
{
"description": "Basic data on the use of various tools and feature provided by the VisualEditor. You can join it with Schema:EditAttemptStep data to enrich with user- and session-level data; as of May 2020, some of this is duplicated into this schema as well. For living dictionary of current values, see https://www.mediawiki.org/wiki/VisualEditor/FeatureUse_data_dictionary",
"properties": {
"properties": {
"editingSessionId": {
"editingSessionId": {
"type": "string",
"type": "string",
"required": true,
"required": true,
"description": "Alphanumeric code used to uniquely identify a single editing attempt. Must be the same ID as used for Schema:Edit."
"description": "Alphanumeric code used to uniquely identify a single editing attempt. Must be the same ID as used for Schema:EditAttemptStep."
},
},
"feature": {
"feature": {
Line 15: Line 16:
"required": true,
"required": true,
"description": "The specific, technical action that has been trigged, written as a hyphen-separated phrase consisting of the object and the action taken. For example, 'dialog-open' or 'annotation-toggle-selection'. This is not an enum so that the visual editor's maintainers have flexibility in which of its many features to implement and because extensions can add arbitrary new features which could pass through already-instrumented code paths."
"description": "The specific, technical action that has been trigged, written as a hyphen-separated phrase consisting of the object and the action taken. For example, 'dialog-open' or 'annotation-toggle-selection'. This is not an enum so that the visual editor's maintainers have flexibility in which of its many features to implement and because extensions can add arbitrary new features which could pass through already-instrumented code paths."
},
"platform": {
"type": "string",
"enum": [
"desktop",
"tablet",
"phone",
"other"
],
"description": "The editing device through which the user is attempting to edit the page."
},
"integration": {
"type": "string",
"enum": [
"page",
"flow",
"lqt",
"app",
"discussiontools"
],
"description": "The editor integration through which the user is attempting to edit the page."
},
"editor_interface": {
"type": "string",
"enum": [
"visualeditor",
"wikitext-2017",
"wikitext",
"other"
],
"description": "The editor interface through which the user is attempting to edit the page."
},
"user_id": {
"type": "integer",
"description": "The user id (0 if logged out)."
},
"user_editcount": {
"type": "integer",
"description": "The total number of edits of the user."
},
"bucket": {
"type": "string",
"description": "If necessary, a string used to identify temporarily relevant groups of users, such as the groups in a controlled experiment. For example '2019-03-mobile-VE-section-editing-control'. If multiple buckets need to be set at once (e.g. for overlapping experiment), separate the strings with commas."
}
}
}
}

Revision as of 16:54, 26 May 2020

description"Basic data on the use of various tools and feature provided by the VisualEditor. You can join it with Schema:EditAttemptStep data to enrich with user- and session-level data; as of May 2020, some of this is duplicated into this schema as well. For living dictionary of current values, see https://www.mediawiki.org/wiki/VisualEditor/FeatureUse_data_dictionary"
properties
editingSessionId
type"string"
requiredtrue
description"Alphanumeric code used to uniquely identify a single editing attempt. Must be the same ID as used for Schema:EditAttemptStep."
feature
type"string"
requiredtrue
description"The user-facing capability that is being used, such as 'link', 'autosave', 'clipboard' or 'textStyle/bold'. This is not an enum so that the visual editor's maintainers have flexibility in which of its many features to implement and because extensions can add arbitrary new features which could pass through already-instrumented code paths."
action
type"string"
requiredtrue
description"The specific, technical action that has been trigged, written as a hyphen-separated phrase consisting of the object and the action taken. For example, 'dialog-open' or 'annotation-toggle-selection'. This is not an enum so that the visual editor's maintainers have flexibility in which of its many features to implement and because extensions can add arbitrary new features which could pass through already-instrumented code paths."
platform
type"string"
enum
"desktop"
"tablet"
"phone"
"other"
description"The editing device through which the user is attempting to edit the page."
integration
type"string"
enum
"page"
"flow"
"lqt"
"app"
"discussiontools"
description"The editor integration through which the user is attempting to edit the page."
editor_interface
type"string"
enum
"visualeditor"
"wikitext-2017"
"wikitext"
"other"
description"The editor interface through which the user is attempting to edit the page."
user_id
type"integer"
description"The user id (0 if logged out)."
user_editcount
type"integer"
description"The total number of edits of the user."
bucket
type"string"
description"If necessary, a string used to identify temporarily relevant groups of users, such as the groups in a controlled experiment. For example '2019-03-mobile-VE-section-editing-control'. If multiple buckets need to be set at once (e.g. for overlapping experiment), separate the strings with commas."