telemetry_services > Event

Class: Event

Describes a single telemetry event. A telemetry event is when something occurs in the system.

author: Jean-Philippe Steinmetz info@acceleratxr.com

Hierarchy

SimpleMongoEntity

↳ Event

Index

Constructors

Properties


Constructors

constructor

new Event(other?: any): Event

Overrides SimpleMongoEntity.__constructor

Defined in models/Event.ts:42

Parameters:

Name Type
Optional other any

Returns: Event


Properties

_id

● _id: ObjectID

Inherited from SimpleMongoEntity._id

Defined in C:/Users/jpsaxr/gitlab/telemetry_services/node_modules/@acceleratxr/services_common/dist/types/models/SimpleMongoEntity.d.ts:13

The internal unique identifier used by MongoDB.


environment

● environment: string = “prod”

Defined in models/Event.ts:18

The name of the environment that the event originated from. This is typically dev or prod.


origin

● origin: string = “”

Defined in models/Event.ts:24

The unique name of the service or client that the event originated from.


timestamp

● timestamp: Date = new Date()

Defined in models/Event.ts:30

The date and time that the event occured.


type

● type: string = “”

Defined in models/Event.ts:36

The type of event being recorded.


uid

● uid: string

Inherited from BaseEntity.uid

Defined in C:/Users/jpsaxr/gitlab/telemetry_services/node_modules/@acceleratxr/services_common/dist/types/models/SimpleEntity.d.ts:11

The universally unique identifier of the entity.


userId

● userId: string = “”

Defined in models/Event.ts:42

The universally unique identifer of the user that sent the event.