-
Notifications
You must be signed in to change notification settings - Fork 2
/
2.0.0.yaml
103 lines (103 loc) · 3.15 KB
/
2.0.0.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
title: fragment/analytics/common
description: Common fields for all WMF analytics and instrumentation events
$id: /fragment/analytics/common/2.0.0
$schema: 'https://json-schema.org/draft-07/schema#'
type: object
additionalProperties: false
required:
- $schema
- meta
properties:
$schema:
description: >
A URI identifying the JSONSchema for this event. This should match an
schema's $id in a schema repository. E.g. /schema/title/1.0.0
type: string
dt:
description: >
ISO-8601 formatted timestamp of when the event occurred/was generated in
UTC). This exists separately from meta.dt in the main common schema. For
external client-sent instrumentation events, we want to allow meta.dt to
be the received time (filled in by EventGate at ingest time), as we don't
trust client-sent events to always set the proper date and time.
Client-set event generation time should be set here instead. See:
https://phabricator.wikimedia.org/T240460
type: string
format: date-time
maxLength: 128
http:
type: object
properties:
has_cookies:
description: True if the http request has any cookies set
type: boolean
method:
description: 'The HTTP request method (GET, POST, etc.)'
type: string
protocol:
description: The protocol used for the request (HTTP or HTTPS)
type: string
request_headers:
description: 'Request headers sent by the client. E.g. user-agent, etc.'
type: object
additionalProperties:
type: string
response_headers:
description: Response headers sent back to the client (when known).
type: object
additionalProperties:
type: string
status_code:
description: The HTTP status code returned for this request (when known)
type: integer
maximum: 9007199254740991
minimum: -9007199254740991
meta:
type: object
required:
- dt
- stream
properties:
domain:
description: Domain the event or entity pertains to
type: string
minLength: 1
dt:
description: 'UTC event datetime, in ISO-8601 format'
type: string
format: date-time
maxLength: 128
id:
description: Unique ID of this event
type: string
request_id:
description: Unique ID of the request that caused the event
type: string
stream:
description: Name of the stream/queue/dataset that this event belongs in
type: string
minLength: 1
uri:
description: Unique URI identifying the event or entity
type: string
format: uri-reference
maxLength: 8192
examples:
- $schema: /fragment/analytics/common/2.0.0
dt: '2021-01-01T00:00:00.0Z'
http:
has_cookies: false
method: dolor
protocol: dolor
request_headers:
dolorb: dolor
response_headers:
dolorb: dolor
status_code: -6305039478318694
meta:
domain: dolor
dt: '2021-01-01T00:00:00.0Z'
id: dolor
request_id: dolor
stream: dolor
uri: 'http://example.org'