Skip to main content

ExecEndpointStat

Calls to one endpoint (a node type's method) of an app's ck-exec code over a window, by outcome. A client's or an instance's call is counted once, by the host it entered on, with the status its caller got; a platform event ($timer, $topic, $presence, $session, $world) is counted by the host that ran it. Counts are whole numbers.

type ExecEndpointStat {
  nodeType: String!
  method: String!
  calls: Float!
  appErrors: Float!
  busy: Float!
  denied: Float!
  deadlineExceeded: Float!
  otherErrors: Float!
  timedCalls: Float!
  latencyMsAvg: Float
  latencyMsMax: Float
  firstMinute: DateTime!
  lastMinute: DateTime!
}

Fields​

ExecEndpointStat.nodeType ● String! non-null scalar​

The node type called; (other) for calls to endpoints past the 256 one host counts per app a minute.

ExecEndpointStat.method ● String! non-null scalar​

The method called; a $ method is a platform event, and (other) as for nodeType.

ExecEndpointStat.calls ● Float! non-null scalar​

Calls in the window.

ExecEndpointStat.appErrors ● Float! non-null scalar​

Calls the handler answered with an error (AppError).

ExecEndpointStat.busy ● Float! non-null scalar​

Calls refused as busy: a full mailbox, the root hub’s call rate, or the caller’s call limit (120 calls per 10 seconds per player and app on a host, refused Busy with a message starting "rate limited").

ExecEndpointStat.denied ● Float! non-null scalar​

Calls refused as not allowed (Denied).

ExecEndpointStat.deadlineExceeded ● Float! non-null scalar​

Calls not answered before their deadline (DeadlineExceeded).

ExecEndpointStat.otherErrors ● Float! non-null scalar​

Calls that failed otherwise: not found, unavailable, trapped, moved, internal or a bad request.

ExecEndpointStat.timedCalls ● Float! non-null scalar​

Calls a handler answered (Ok or AppError); the latencies are over these.

ExecEndpointStat.latencyMsAvg ● Float scalar​

The timed calls’ average latency in milliseconds. For a client’s or an instance’s call it runs from reaching the host the call entered on to its answer leaving that host: queueing, the handler, and any hop to the host that runs the target. For a platform event it is the time in the handler. Null when no call was timed.

ExecEndpointStat.latencyMsMax ● Float scalar​

The longest of those latencies in milliseconds; null when no call was timed.

ExecEndpointStat.firstMinute ● DateTime! non-null scalar​

The first minute of the window with calls.

ExecEndpointStat.lastMinute ● DateTime! non-null scalar​

The last minute of the window with calls. Each host reports a minute once it ends.

Returned By​

execEndpointStats query