/  Yamcs HTTP API  /  Activities  /  Subscribe Activity Log

Subscribe Activity LogΒΆ

Receive activity log updates

WebSocket

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

Use the message type activity-log.

Input Type

interface SubscribeActivityLogRequest {

  // Yamcs instance name
  instance: string;

  // Activity identifier
  activity: string;
}

Output Type

interface ActivityLogInfo {

  // Log time
  time: string;  // RFC 3339 timestamp

  // Source of this log message. One of:
  //
  // - SERVICE: the log is generated by the activity service
  // - ACTIVITY: the log is generated by the activity itself
  source: string;

  // Log level
  level: ActivityLogLevel;

  // Log message
  message: string;
}

Related Types

enum ActivityLogLevel {

  // Info level
  INFO = "INFO",

  // Warning level
  WARNING = "WARNING",

  // Error level
  ERROR = "ERROR",
}