Schema

Graphql Schema for Observability

Events

Event

Fields	Description
`id`	The id of the event
`groupId`	The group id (also known as the trace id) of an event
`spaceId`	The nacelle space id associated to this event
`nacelleEntryId`	The nacelle entry Id associated to this event
`userId`	The userId associated to this event
`sourceID`	The source id of the content related to this event
`action`	What this event was doing
`status`	What the status of this event was. Only possible values are PROGRESS, WARN, ERROR, and COMPLETED.
`message`	A user friendly message about the state of the event. If the event was an error this should include error details.
`timestamp`	When this event occurred in the system
`meta`	A unstructured json blob that contains additional information about the event.
`requestOrigin`	Where this event originated from, either COMMAND or WEBHOOK.

EventFilter

Fields	Description
`after`	A cursor for navigating in forwards through data
`before`	A cursor for navigating in backwards through data
`start`	A timestamp that filters out all events before it
`end`	A timestamp that filters out all events after it
`groupId`	A groupid used to filter out events to only events in that groupid
`nacelleEntryId`	A nacelleEntryID used to filter out events to only those with the given nacelleEntryID
`userId`	A userId used to filter out events to only those with the given userId
`sourceID`	A sourceId used to filter out events to only those with the given sourceId
`action`	An action used to filter out events to only those with the given action
`status`	A status used to filter out events to only those with the given status
`requestOrigin`	A requestOrigin (either COMMAND or WEBHOOK) used to filter out events to only those with the given requestOrigin
`first`	First denotes how many records to return. (Max value 1000)
`orderBy`	How the returned rows are ordered either VERSION, or TIMESTAMP.
`direction`	How the returned rows are ordered either ASC or DESC

EventConnection

Fields	Description
`totalCount`	Triggers an additional query which returns the total count of records that match the given filter
`pageInfo`	An object containing pagination information
`edges`	An object containing EventEdges

EventEdge

Fields	Description
`node`	The request event data
`cursor`	The cursor associated to this node

Group

Fields	Description
`name`	The name of the field being grouped. Either a status or a groupId depending on usage
`count`	The number of events found that match the request

Summaries

Summary

Fields	Description
`groupID`	The group id for a summary
`firstEventTimestamp`	A timestamp representing the first event received
`lastEventTimestamp`	A timestamp representing the latest event received
`countProgress`	The number of progress events received
`countError`	The number of error events received
`countWarn`	The number of warn events received
`countComplete`	The number of complete events received

SummaryFilter

Fields	Description
`after`	A cursor for navigating in forwards through data
`before`	A cursor for navigating in backwards through data
`start`	A timestamp that filters out all summaries before it
`end`	A timestamp that filters out all summaries after it
`groupId`	A groupid used to filter out summaries to only summaries in that groupid
`first`	First denotes how many records to return. Max: 1000 Default: 50
`orderBy`	How the returned rows are ordered either first_event_timestamp, or last_event_timestamp.
`direction`	How the returned rows are ordered either ASC or DESC
`sources`	An array of strings representing the sources to return (for example shopify, contentful)
`countOf`	A status to filter summaries by that must have a count greater than 0

SummaryConnection

Fields	Description
`totalCount`	Triggers an additional query which returns the total count of records that match the given filter
`pageInfo`	An object containing pagination information
`edges`	An array of SummaryEdge’s

SummaryEdge

Fields	Description
`node`	The requested Summary data
`cursor`	The cursor associated to this node

Digests

Digest

Fields	Description
`groupID`	The group id (also known as the trace id) for a digest
`spaceID`	The SpaceID this digest belongs to
`status`	The status of this Digest
`Meta`	Metadata associated with the digest
`Category`	The category of the digest

DigestFilter

Fields	Description
`after`	A cursor for navigating in forwards through data
`before`	A cursor for navigating in backwards through data
`start`	A timestamp that filters out all digests before it
`end`	A timestamp that filters out all digests after it
`groupId`	A groupid used to filter out summaries to only summaries in that groupid
`first`	First denotes how many records to return. Max: 1000 Default: 50
`orderBy`	How the returned rows are ordered currently only CREATED_AT is available.
`direction`	How the returned rows are ordered either ASC of DESC
`categories`	Category to search for digests with

DigestConnection

Fields	Description
`totalCount`	Triggers an additional query which returns the total count of records that match the given filter
`pageInfo`	An object containing pagination information
`edges`	An array of DigestEdge's

DigestEdge

Fields	Description
`node`	The requested Digest data
`cursor`	The cursor associated to this node

Pagination

PageInfo

Fields	Description
`hasNextPage`	Whether there is a next page to view
`hasPreviousPage`	Whether there is a previous page to view
`startCursor`	The starting cursor of this request
`endCursor`	The ending cursor of this request

Updated over 1 year ago