Skip to content

analytics: add channel interval event schema #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
zknill wants to merge 1 commit into from
Closed

analytics: add channel interval event schema #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/generated/
/node_modules/
/output/
**/*.swp
147 changes: 147 additions & 0 deletions json-schemas/src/channel-intervals.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"eventId": {
"type": "string",
"description": "Unique identifier for this event. Autogenerated by the system."
},
"intervalId": {
"type": "string",
"description": "The interval in unix milliseconds."
},
"interval": {
"type": "number",
"description": "The interval in unix milliseconds."
},
"intervalStartTime": {
"type": "number",
"description": "Start time of the interval in unix milliseconds."
},
"intervalEndTime": {
"type": "number",
"description": "End time of the interval in unix milliseconds."
},
"accountId": {
"type": "string"
},
"appId": {
"type": "string"
},
"channelId": {
"type": "string"
},
"schema": {
"type": "string",
"description": "URI to this schema."
},
"site": {
"type": "string"
},
"realtimeInstanceId": {
"type": "string"
},
"cluster": {
"type": "string"
},
"ec2InstanceId": {
"type": "string"
},
"containerName": {
"type": "string"
},
"role": {
"type": "string"
},
"stats": {
"type": "object",
"properties": {
"direction":{
"type": "string",
"enum": ["inbound", "outbound"],
"description": "Describes the direction of the analytics data."
},
"messages": {
"type": "object",
"properties": {
"all": {
"type": "object",
"properties": {
"succeeded": {
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {"type": "integer"}
}
},
"billableCount": {
"type": "object",
"properties": {
"value": {"type": "integer"}
}
},
"data": {
"type": "object",
"properties": {
"value": {"type": "integer"}
}
}
}
},
"failed": {
"type": "object",
"patternProperties": {
"^[0-9]+$": {
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {"type": "integer"}
}
},
"billableCount": {
"type": "object",
"properties": {
"value": {"type": "integer"}
}
},
"data": {
"type": "object",
"properties": {
"value": {"type": "integer"}
}
}
}
}
},
"additionalProperties": false
}
},
"required": ["succeeded", "failed"]
}
},
"required": ["all"]
}
},
"required": ["messages", "direction"]
}
},
"required": [
"eventId",
"intervalId",
"interval",
"accountId",
"appId",
"channelId",
"site",
"realtimeInstanceId",
"cluster",
"ec2InstanceId",
"containerName",
"role",
"stats"
]
}
1 change: 1 addition & 0 deletions json-schemas/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"app-stats": "0.0.5",
"client-events-api-requests": "0.0.1",
"client-events-connections": "0.0.1",
"channel-intervals": "0.0.1",
"channel-lifecycle": "0.0.1",
"attachments": "0.0.1",
"epoch": "0.0.1"
Expand Down
Loading