"A wrapper around event objects that encodes generic metadata. NOTE: This on wiki schema serves purely for documentation purposes. It is not the canonical schema used by EventLogging source code. The EventCapsule schema can be found at https://github.com/wikimedia/eventlogging/blob/master/eventlogging/capsule.py"
properties
event
type
"object"
description
"The encapsulated event object"
required
true
wiki
type
"string"
description
"$wgDBName (for example: 'enwiki')"
required
true
webHost
type
"string"
description
"Request host. 'window.location.hostname' on client-side events; $_SERVER['HTTP_HOST'] on server."
schema
type
"string"
description
"Title of event schema"
required
true
revision
type
"integer"
description
"Revision ID of event schema"
required
true
topic
type
"string"
description
"The queue topic name this event belongs in"
recvFrom
type
"string"
description
"Hostname of server emitting the log line"
required
true
timestamp
type
"number"
description
"UTC unix epoch timestamp of event. Optional. Should be the same as dt. Exists for backwards compatibility. See: https://phabricator.wikimedia.org/T179625)"
dt
type
"string"
description
"UTC ISO-8601 timestamp of event"
format
"date-time"
seqId
type
"integer"
description
"Udp2log sequence ID"
uuid
type
"string"
description
"Unique event identifier"
format
"uuid5-hex"
required
true
userAgent
type
"any"
description
"User Agent from HTTP request. Either a parsed object, parsed JSON string, or original User-Agent string."
required
false
ip
type
"string"
description
"Client IP address that sent this event, usually best guess parsed out of from X-Forwarded-For."
