feat: Add initial event schemas with Supported Event Types #2
Conversation
thogarty
commented
Nov 5, 2024
•
thogarty
commented
- Add:
- Change data schema
- Change Alert data schema
- Metric data schema
- Metric Alert data schema
- SupportedEventTypes data loader file
- Data Loader File Update Script to be added to GHA later
| @@ -0,0 +1,225 @@ | |||
| { | |||
There was a problem hiding this comment.
We need to be consistent with the names here:
events / alerts vs change/changeAlerts
| @@ -1,3 +1,199 @@ | |||
| { | |||
There was a problem hiding this comment.
please add am/crh and NE sections
There was a problem hiding this comment.
This catalog is for json validation only. Follows strict schema set in https://json.schemastore.org/schema-catalog
| "description": "The time that the resource that fired the event was updated", | ||
| "format": "date-time" | ||
| } | ||
| }, |
There was a problem hiding this comment.
ResourceChange is not change log. Please refer to the following:
change:
uuid: 65e86e2f-328e-40d4-b47f-3a4327123f1b
type: CONNECTION_UPDATE
status: COMPLETED
createdDateTime: '2024-11-11T17:30:54Z'
data:
- op: replace
path: "/name"
value: p2p1-update-2
previousValue: p2p1-update-1
op can be one of [replace, add, remove]
| "ResourceChange": { | ||
| "properties": { | ||
| "createdBy": { | ||
| "type": "string", | ||
| "description": "User account that created the resource that fired the event" | ||
| }, | ||
| "createdDateTime": { | ||
| "type": "string", | ||
| "description": "The time that the resource that fired the event was created", | ||
| "format": "date-time" | ||
| }, | ||
| "updatedBy": { | ||
| "type": "string", | ||
| "description": "User account that updated the resource that fired the event" | ||
| }, | ||
| "updatedDateTime": { | ||
| "type": "string", | ||
| "description": "The time that the resource that fired the event was updated", | ||
| "format": "date-time" | ||
| } | ||
| }, |
| "cloudeventTypes": [ | ||
| "equinix.fabric.connection.bandwidth_rx.usage", | ||
| "equinix.fabric.connection.bandwidth_tx.usage", | ||
| "equinix.fabric.port.bandwidth_rx.usage", | ||
| "equinix.fabric.port.bandwidth_tx.usage", | ||
| "equinix.fabric.port.frames_erred_rx.count", | ||
| "equinix.fabric.port.frames_erred_tx.count", | ||
| "equinix.fabric.port.frames_dropped_rx.count", | ||
| "equinix.fabric.port.frames_dropped_tx.count", | ||
| "equinix.fabric.router.routes_ipv4_installed.utilization", | ||
| "equinix.fabric.router.routes_ipv6_installed.utilization", | ||
| "equinix.fabric.metro.{:asideMetroCode}_{:zsideMetroCode}.latency", | ||
| "equinix.fabric.metric" | ||
| ], |
There was a problem hiding this comment.
cloudeventTypes for metrics is only one: equinix.fabric.metric
Can we add another metricNames list, and put metric name to it.
| "change": { | ||
| "$ref": "#/definitions/ResourceChange", | ||
| "additionalProperties": true, | ||
| "description": "Chang information for the resource that fired the event" | ||
| } |
There was a problem hiding this comment.
No change block here for metric resource.
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "description": "The type of the metric event" |
There was a problem hiding this comment.
Should be: The type of the metric
| "metrics": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/Metrics", |
There was a problem hiding this comment.
The item itself should be named Metric here.
| "title": "Resource", | ||
| "description": "Schema of the resource that fired the event" | ||
| }, | ||
| "Metrics": { |
There was a problem hiding this comment.
Which means this should be defined as Metric. That is the reason I suggest to use Data at the top level.
| }, | ||
| "additionalProperties": true, | ||
| "type": "object", | ||
| "title": "Metrics", |
| "$ref": "#/definitions/MetricAlert", | ||
| "definitions": { | ||
| "MetricAlert": { |
There was a problem hiding this comment.
Similarly, can we rename to Data?
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "description": "The type of the metric event" |
There was a problem hiding this comment.
remove event. Please check similar descriptions.
