update/event.v1: add DEBUG severity

XXX_SKIP_CHECK_BREAKING

Change-Id: Iaa8793b615cd5b022f365b8b3da36cf1965f30ca

arista/event.v1/event-changelog.yaml

@@ -7,6 +7,15 @@
 # New entries go on top.
 
 Changes:
+    - date: 2024-01-24
+      description: Add new DEBUG event severity
+      version: 1.1.1
+    - date: 2023-09-20
+      description: Add event creation requests and field timestamp
+      version: 1.1.0
+    - date: 2023-06-22
+      description: Rename components COMPONENT_TYPE_DVS & COMPONENT_TYPE_DVS_INTERFACE
+      version: 1.0.9
     - date: 2023-04-17
       description: Add field rule_id
       version: 1.0.8

arista/event.v1/event.proto

@@ -25,9 +25,11 @@ enum EventSeverity {
   EVENT_SEVERITY_ERROR = 3;
   // EVENT_SEVERITY_CRITICAL is used to designate severe errors that impede functioning.
   EVENT_SEVERITY_CRITICAL = 4;
+  // EVENT_SEVERITY_DEBUG is used for debugging useful information.
+  EVENT_SEVERITY_DEBUG = 5;
 }
 
-// ComponentType describes the type of entity on which the event occured
+// ComponentType describes the type of entity on which the event occurred
 enum ComponentType {
   // COMPONENT_TYPE_UNSPECIFIED is the default value, if the type is not specified.
   COMPONENT_TYPE_UNSPECIFIED = 0;
@@ -38,13 +40,13 @@ enum ComponentType {
   // COMPONENT_TYPE_TURBINE is used for events on the internal CVP turbine
   // components. A turbine is an internal CV streaming analytics backend process.
   COMPONENT_TYPE_TURBINE = 3;
-  // COMPONENT_TYPE_DVS is used for DVS events.
+  // COMPONENT_TYPE_VDS is used for VDS events.
   // A vSphere Distributed Switch provides centralized management and
   // monitoring of the networking configuration of all workload servers that are
   // associated with the switch.
-  COMPONENT_TYPE_DVS = 4;
-  // COMPONENT_TYPE_DVS_INTERFACE is used for DVS interface events.
-  COMPONENT_TYPE_DVS_INTERFACE = 5;
+  COMPONENT_TYPE_VDS = 4;
+  // COMPONENT_TYPE_VDS_INTERFACE is used for VDS interface events.
+  COMPONENT_TYPE_VDS_INTERFACE = 5;
   // COMPONENT_TYPE_VM is used for VM events.
   // A VM is a software computer that, like a physical computer, runs an
   // operating system and applications.
@@ -62,17 +64,17 @@ enum ComponentType {
   COMPONENT_TYPE_CVP_NODE = 11;
 }
 
-// EventComponent describes an entity on which the event occured
+// EventComponent describes an entity on which the event occurred
 message EventComponent {
   // type is the type of component
   ComponentType type = 1;
-  // components identifies the entity on which the event occured
+  // components identifies the entity on which the event occurred
   map<string, string> components = 2;
 }
 
-// EventComponents contains entities on which an event occured
+// EventComponents contains entities on which an event occurred
 message EventComponents {
-  // components describes the components on which an event occured
+  // components describes the components on which an event occurred
   repeated EventComponent components = 1;
 }
 
@@ -121,7 +123,7 @@ message EventKey {
   option (fmp.model_key) = true;
   // key is the event data identifier
   google.protobuf.StringValue key = 1;
-  // timestamp is the time the event occured
+  // timestamp is the time the event occurred
   google.protobuf.Timestamp timestamp = 2;
 }
 
@@ -190,3 +192,35 @@ message Event {
   // rule_id is the label of the rule associated with the event
   google.protobuf.StringValue rule_id = 12;
 }
+
+// UserEventCreationKey uniquely identifies a user event request.
+message UserEventCreationKey {
+  option (fmp.model_key) = true;
+  // key is a unique string identifier
+  google.protobuf.StringValue key = 1;
+}
+
+// UserEventCreationConfig is the basis for the manual creation of new events.
+//
+// NOTE: Set is the only valid operation.
+//       Objects are immediately deleted upon event creation.
+//       All fields are required to create a well-formed event.
+message UserEventCreationConfig {
+  option (fmp.model) = "rw";
+  // key is the event instance identifier
+  UserEventCreationKey key = 1;
+  // severity is the severity of the event
+  EventSeverity severity = 2;
+  // title is the title of the event
+  google.protobuf.StringValue title = 3;
+  // description is the description of the event
+  google.protobuf.StringValue description = 4;
+  // event_type is the type of the event
+  google.protobuf.StringValue event_type = 5;
+  // rule_id is the label of the rule associated with the event
+  google.protobuf.StringValue rule_id = 6;
+  // components is the components on which the event occurred
+  EventComponents components = 7;
+  // start_time is the time point at which the event occurred
+  google.protobuf.Timestamp start_time = 8;
+}