event.v1

Top

arista/event.v1/event.proto

Event

Event is a telemetry event

Field NameTypeDescription
keyEventKey

key is the event instance identifier

severityEventSeverity

severity is the severity of the event

titlegoogle.protobuf.StringValue

title is the title of the event

descriptiongoogle.protobuf.StringValue

description is the description of the event

event_typegoogle.protobuf.StringValue

event_type is the type of the event

dataEventData

data is the data of the event

componentsEventComponents

components is the components on which the event occurred

ackEventAck

ack is the acknowledgement status of the event

notesEventNotes

notes is the notes of the event

last_updated_timegoogle.protobuf.Timestamp

last_updated_time is the time of the most recent update to the event

readEventRead

read is the read status of the event

rule_idgoogle.protobuf.StringValue

rule_id is the label of the rule associated with the event

EventAck

EventAck contains acknowledgement information of an event

Field NameTypeDescription
ackgoogle.protobuf.BoolValue

ack is the acknowledgement state of an event

ackergoogle.protobuf.StringValue

acker is the user that acknowledged the event

ack_timegoogle.protobuf.Timestamp

ack_time is the time of acknowledgement

EventAnnotationConfig

EventAnnotationConfig configures an event annotation

NOTE: Either 1) key and ack or 2) key and notes or 3) key and read are required when used as an argument to Set.

Field NameTypeDescription
keyEventKey

key is the event instance identifier

ackgoogle.protobuf.BoolValue

ack is the acknowledgement state of an event

notesEventNotesConfig

notes is the notes on an event

readgoogle.protobuf.BoolValue

read is the read state of an event. Setting this implies that an event has been read by a user

EventComponent

EventComponent describes an entity on which the event occured

Field NameTypeDescription
typeComponentType

type is the type of component

componentsEventComponent.ComponentsEntry[…]

components identifies the entity on which the event occured

EventComponent.ComponentsEntry

Field NameTypeDescription
keystring

valuestring

EventComponents

EventComponents contains entities on which an event occured

Field NameTypeDescription
componentsEventComponent[…]

components describes the components on which an event occured

EventData

EventData is additional event data

Field NameTypeDescription
dataEventData.DataEntry[…]

data is event data specific to the type of this event

EventData.DataEntry

Field NameTypeDescription
keystring

valuestring

EventKey

EventKey uniquely identifies an event

NOTE: All fields are required when used as an argument to GetOne, Set or Delete.

Field NameTypeDescription
keygoogle.protobuf.StringValue

key is the event data identifier

timestampgoogle.protobuf.Timestamp

timestamp is the time the event occured

EventNote

EventNote is the state of a note

Field NameTypeDescription
notegoogle.protobuf.StringValue

note is the text of the note

note_creatorgoogle.protobuf.StringValue

note_creator is the creator of the note

EventNoteConfig

EventNoteConfig configures a note

NOTE: note is required when used as an argument to Set.

Field NameTypeDescription
notegoogle.protobuf.StringValue

note is the text of the note

EventNotes

EventNotes is the notes of an event state

Field NameTypeDescription
notesEventNotes.NotesEntry[…]

notes is keyed by the time desired

EventNotes.NotesEntry

Field NameTypeDescription
keyint64

valueEventNote

EventNotesConfig

EventNotesConfig configures the notes of an event

NOTE: notes is required when used as an argument to Set.

Field NameTypeDescription
notesEventNotesConfig.NotesEntry[…]

notes is keyed by desired note time in Unix time, in milliseconds

EventNotesConfig.NotesEntry

Field NameTypeDescription
keyint64

valueEventNoteConfig

EventRead

EventRead contains read information of an event

Field NameTypeDescription
readgoogle.protobuf.BoolValue

read is the read state of an event

readergoogle.protobuf.StringValue

reader is the user that read the event

read_timegoogle.protobuf.Timestamp

read_time is the time of read

ComponentType

ComponentType describes the type of entity on which the event occured

NameNumberDescription
COMPONENT_TYPE_UNSPECIFIED0

COMPONENT_TYPE_UNSPECIFIED is the default value, if the type is not specified.

COMPONENT_TYPE_DEVICE1

COMPONENT_TYPE_DEVICE is used for device events.

COMPONENT_TYPE_INTERFACE2

COMPONENT_TYPE_INTERFACE is used for device interface events.

COMPONENT_TYPE_TURBINE3

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_DVS4

COMPONENT_TYPE_DVS is used for DVS 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_INTERFACE5

COMPONENT_TYPE_DVS_INTERFACE is used for DVS interface events.

COMPONENT_TYPE_VM6

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.

COMPONENT_TYPE_VM_INTERFACE7

COMPONENT_TYPE_VM_INTERFACE is used for VM interface events.

COMPONENT_TYPE_WORKLOAD_SERVER8

COMPONENT_TYPE_WORKLOAD_SERVER is used for workload server events.

A workload server is a server/data storage device on which the hypervisor is installed.

COMPONENT_TYPE_WORKLOAD_SERVER_INTERFACE9

COMPONENT_TYPE_WORKLOAD_SERVER_INTERFACE is used for workload server interface events.

COMPONENT_TYPE_APPLICATION10

COMPONENT_TYPE_APPLICATION is used for application-service events.

COMPONENT_TYPE_CVP_NODE11

COMPONENT_TYPE_CVP_NODE is used for CVP node events.

EventSeverity

EventSeverity is the severity level of the event

NameNumberDescription
EVENT_SEVERITY_UNSPECIFIED0

EVENT_SEVERITY_UNSPECIFIED is the default value, if the severity is not specified.

EVENT_SEVERITY_INFO1

EVENT_SEVERITY_INFO is used for generally useful information.

EVENT_SEVERITY_WARNING2

EVENT_SEVERITY_WARNING is used for potentially harmful conditions.

EVENT_SEVERITY_ERROR3

EVENT_SEVERITY_ERROR is used for errors events that may allow for continued functioning.

EVENT_SEVERITY_CRITICAL4

EVENT_SEVERITY_CRITICAL is used to designate severe errors that impede functioning.

Top

arista/event.v1/services.gen.proto

EventAnnotationConfigDeleteAllRequest

EventAnnotationConfigDeleteAllResponse

Field NameTypeDescription
typefmp.DeleteError

This describes the class of delete error.

errorgoogle.protobuf.StringValue

This indicates the error message from the delete failure.

keyEventKey

This is the key of the EventAnnotationConfig instance that failed to be deleted.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp when the key was being deleted.

EventAnnotationConfigDeleteRequest

Field NameTypeDescription
keyEventKey

Key indicates which EventAnnotationConfig instance to remove.

This field must always be set.

EventAnnotationConfigDeleteResponse

Field NameTypeDescription
keyEventKey

Key echoes back the key of the deleted EventAnnotationConfig instance.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

EventAnnotationConfigRequest

Field NameTypeDescription
keyEventKey

Key uniquely identifies a EventAnnotationConfig instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

EventAnnotationConfigResponse

Field NameTypeDescription
valueEventAnnotationConfig

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

EventAnnotationConfig instance in this response.

EventAnnotationConfigSetRequest

Field NameTypeDescription
valueEventAnnotationConfig

EventAnnotationConfig carries the value to set into the datastore.

See the documentation on the EventAnnotationConfig struct for which fields are required.

EventAnnotationConfigSetResponse

Field NameTypeDescription
valueEventAnnotationConfig

Value carries all the values given in the EventAnnotationConfigSetRequest as well

as any server-generated values.

timegoogle.protobuf.Timestamp

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

EventAnnotationConfigSetSomeRequest

Field NameTypeDescription
valuesEventAnnotationConfig[…]

value contains a list of EventAnnotationConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

EventAnnotationConfigSetSomeResponse

Field NameTypeDescription
keyEventKey

errorstring

EventAnnotationConfigStreamRequest

Field NameTypeDescription
partial_eq_filterEventAnnotationConfig[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each EventAnnotationConfig at end.

* Each EventAnnotationConfig response is fully-specified (all fields set).

* start: Returns the state of each EventAnnotationConfig at start, followed by updates until now.

* Each EventAnnotationConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each EventAnnotationConfig at start, followed by updates

until end.

* Each EventAnnotationConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

EventAnnotationConfigStreamResponse

Field NameTypeDescription
valueEventAnnotationConfig

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this EventAnnotationConfig’s last modification.

typearista.subscriptions.Operation

Operation indicates how the EventAnnotationConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

EventRequest

Field NameTypeDescription
keyEventKey

Key uniquely identifies a Event instance to retrieve.

This value must be populated.

timegoogle.protobuf.Timestamp

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

EventResponse

Field NameTypeDescription
valueEvent

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

timegoogle.protobuf.Timestamp

Time carries the (UTC) timestamp of the last-modification of the

Event instance in this response.

EventStreamRequest

Field NameTypeDescription
partial_eq_filterEvent[…]

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

timearista.time.TimeBounds

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Event at end.

* Each Event response is fully-specified (all fields set).

* start: Returns the state of each Event at start, followed by updates until now.

* Each Event response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Event at start, followed by updates

until end.

* Each Event response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

EventStreamResponse

Field NameTypeDescription
valueEvent

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

timegoogle.protobuf.Timestamp

Time holds the timestamp of this Event’s last modification.

typearista.subscriptions.Operation

Operation indicates how the Event value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

EventAnnotationConfigService

Method NameRequest TypeResponse TypeDescription
GetOneEventAnnotationConfigRequestEventAnnotationConfigResponse

GetAllEventAnnotationConfigStreamRequestEventAnnotationConfigStreamResponse stream

SubscribeEventAnnotationConfigStreamRequestEventAnnotationConfigStreamResponse stream

SetEventAnnotationConfigSetRequestEventAnnotationConfigSetResponse

SetSomeEventAnnotationConfigSetSomeRequestEventAnnotationConfigSetSomeResponse stream

DeleteEventAnnotationConfigDeleteRequestEventAnnotationConfigDeleteResponse

DeleteAllEventAnnotationConfigDeleteAllRequestEventAnnotationConfigDeleteAllResponse stream

EventService

Method NameRequest TypeResponse TypeDescription
GetOneEventRequestEventResponse

GetAllEventStreamRequestEventStreamResponse stream

SubscribeEventStreamRequestEventStreamResponse stream