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 TM StatisticsΒΆ
Receive TM statistics updates
WebSocket
This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.
Use the message type tmstats
.
Input Type
// Request message for `SubscribeTMStatistics`.
interface SubscribeTMStatisticsRequest {
// Yamcs instance name
instance: string;
// Processor name
processor: string;
}
Output Type
interface Statistics {
// Yamcs instance name.
instance: string;
// Processor name.
processor: string;
tmstats: TmStatistics[];
lastUpdated: string; // RFC 3339 timestamp
}
Related Types
interface TmStatistics {
// Packet name.
packetName: string;
qualifiedName: string;
receivedPackets: string; // String decimal
subscribedParameterCount: number;
lastReceived: string; // RFC 3339 timestamp
lastPacketTime: string; // RFC 3339 timestamp
packetRate: string; // String decimal
dataRate: string; // String decimal
}