Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- List Processor Types
- List Processors
- Get Processor
- Delete Processor
- Edit Processor
- Create Processor
- Get Parameter Value
- Set Parameter Value
- Batch Get Parameter Values
- Batch Set Parameter Values
- Subscribe TM Statistics
- Subscribe Parameters
- Subscribe Processors
- Get Algorithm Status
- Subscribe Algorithm Status
- Get Algorithm Trace
- Edit Algorithm Trace
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
Subscribe Algorithm StatusΒΆ
Receive algorithm status updates
WebSocket
This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.
Use the message type algorithm-status
.
Input Type
// Request message for `SubscribeAlgorithmStatus`.
interface SubscribeAlgorithmStatusRequest {
// Yamcs instance name
instance: string;
// Processor name
processor: string;
// Algorithm name
name: string;
}
Output Type
interface AlgorithmStatus {
//true if the algorithm is active
active: boolean;
//true if the tracing has been enabled
traceEnabled: boolean;
// how many times the algorithm ran (successfully or with error)
runCount: number;
// when the algorithm was last run
lastRun: string; // RFC 3339 timestamp
// how many times the algorithm ran with errors
errorCount: number;
// if the algorithm produced an error,
// the fields below contain the error message and the time when the error was raised
errorMessage: string;
errorTime: string; // RFC 3339 timestamp
//total execution time in nanoseconds
execTimeNs: string; // String decimal
}