- yamcs
- yamcs alarms
- yamcs algorithms
- yamcs commands
- yamcs config
- yamcs containers
- yamcs dbshell
- yamcs events
- yamcs instances
- yamcs links
- yamcs login
- yamcs logout
- yamcs packets
- yamcs parameter-archive
- yamcs parameters
- yamcs processors
- yamcs rocksdb
- yamcs services
- yamcs space-systems
- yamcs storage
- yamcs streams
- yamcs tables
yamcs events¶
Synopsis¶
Description¶
Add events to the Yamcs event log.
Commands¶
- create
Create an event. This command shows an editor where you can enter the event message. Alternatively you can specify the message using the
--message
option.
- log [-n <LINES>, --lines <LINES>] [-s <DATE>, --since <DATE>] [-u <DATE>, --until <DATE>]
Read event log
Options¶
- -m <MESSAGE>, --message <MESSAGE>¶
Event message.
- --date <DATE>¶
Event time. If unspecified, defaults to mission time.
The date should be specified in ISO format or as detailed under Timestamps.
- --sequence-number <SEQNO>¶
Sequence number of this event. This is used to determine unicity of events at the same time and coming from the same source. If not set Yamcs will automatically assign a sequential number as if every submitted event is unique.
- --severity <LEVEL>¶
The severity level of the event. One of
info
,watch
,warning
,distress
,critical
orsevere
. Default isinfo
.
- --source <SOURCE>¶
Source of the event. Defaults to
User
if unset.
- --type <TYPE>¶
Type of the event.
- --extra <KEY=VALUE> [KEY=VALUE ...]¶
Set additional event properties.
- -n <LINES>, --lines <LINES>¶
With
log
, specify the number of events to show, orall
to show all.Default: 10, but only when
--since
and--until
are unset.
- -s <DATE>, --since <DATE>¶
With
log
, include events not older than the specified date.The date should be specified in ISO format or as detailed under Timestamps.
- -u <DATE>, --until <DATE>¶
With
log
, include events not newer than the specified date.The date should be specified in ISO format or as detailed under Timestamps.
Timestamps¶
When parsing timestamps, yamcs-cli accepts a specification in ISO format. The following special patterns are also recognised:
now
: current timenow UTC
: current UTC timetoday
: 00:00:00 of the current daytoday UTC
: 00:00:00 UTC of the current dayyesterday
: 00:00:00 of the day beforeyesterday UTC
: 00:00:00 UTC of the day beforetomorrow
: 00:00:00 of the next daytomorrow UTC
: 00:00:00 UTC of the next day