OBJECT

Observation

A point-in-time observation about the state of something in the system which may interest our insight service

link GraphQL Schema definition

  • type Observation implements Node {
  • # Contains native payload of observation. TODO alternative is to define sub-types
  • # with additional fields
  • body: JSON
  • # Time at which the observation generated at source. Expressed in UTC ISO-8601
  • # format
  • creationTime: DateTime!
  • description: String
  • # Optional hyperlink of observation source
  • hyperLinks: [HyperLink!]
  • id: ID!
  • # impacts of observation w.r.t. one or more dimensions/measures
  • impacts: [InsightImpact]!
  • # Inferred tags
  • inferredTags: [Tag]
  • # Details of insights related to observation
  • #
  • # Arguments
  • # filter: Optional additional field filters.
  • # sort: Sort order for results in insightConnection
  • insightConnection(filter: QueryFilter, sort: [QuerySort!]): InsightConnection
  • # Transient observations are expected to have a follow-up observation indicating
  • # the end of a insight sequence
  • isTransient: Boolean
  • # Time at which the observation is updated at source. Expressed in UTC ISO-8601
  • # format
  • lastUpdateTime: DateTime!
  • # Alert name or definition
  • name: String
  • # Ensemble generated id unique for the Observation. UUID Primary key format
  • # agnostic to the cloud/source provider and will be used for Insight to
  • # Observation mapping
  • observationId: ID!
  • # status of observation based on point-product's observation status e.g. NEW
  • observationStatus: ObservationStatus!
  • # Time at which the observation was received. Expressed in UTC ISO-8601 format
  • observationTime: DateTime!
  • # type of observation, which is defined by observation providers. e.g.
  • # VROPS-Alert:Infrastructure
  • observationType: String!
  • # Entities from which the observation will be originated
  • originatingEntities: [Entity!]
  • # entityIds from which the observation will be originated
  • originatingEntityIds: [EntityId!] @deprecated( reason: "Refer to originatingEntities field!" )
  • # originating observation id which can be from point-product. e.g.
  • # vrn:/provider:VROPS/Alert:
  • originatingObservationId: String!
  • # originating per-product entityIds
  • originatingProductEntityIds: [EntityId!]
  • # Severity of an observation from source
  • severity: InsightSeverity
  • # Source of the observation
  • source: ObservationSource!
  • # suggested trigger type of insight that should be created from this observation,
  • # if known e.g. ANOMALOUS
  • suggestedTriggerType: InsightTriggerType
  • # Custom tags
  • tags: [Tag!]
  • }