/  Yamcs HTTP API  /  Table  /  Subscribe Stream Statistics

Subscribe Stream StatisticsΒΆ

Receive updates on stream stats

WebSocket

This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.

Use the message type stream-stats.

Input Type

interface SubscribeStreamStatisticsRequest {
  instance: string;
}

Output Type

interface StreamEvent {

  // Event type
  type: Type;

  // Stream name
  name: string;

  // Number of tuples
  dataCount: string;  // String decimal
}

Related Types

enum Type {

  // A new stream was created
  CREATED = "CREATED",

  // A stream was deleted
  DELETED = "DELETED",

  // A stream's info was updated
  UPDATED = "UPDATED",
}