# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.2.0 - 2026-03-20

### Additions

- WOM-1112: Include additional keys in summary output:
  - "missed_event_count"
  - "discarded_event_count"
  - "not_connected"
- WOM-1113, WOM-1198, WOM-1199: Provide readthedocs site with tutorial

### Updates

- WOM-953: Improve summary printing output:
  + Units are now scaled to make numbers reasonable rather than always reporting microseconds
  + Clearly demarcate output per device server
  + Align output to make scanning easier
  + Use a table to output performance statistics
- WOM-953: Check version field to ensure the script is compatible with QueryEventSystem data
- WOM-1107: The server counter is now reported as the last sent value of the counter on the server side, rather than the value that is going to be sent next.

### Fixes

- WOM-1099: Do not crash when a non-Tango exception is thrown
- WOM-1099: Do not call print_stats when we do not have event gap data

## 0.1.1 - 2026-02-04

### Fixes

- WOM-1073: Fix crash when device server starts subscribing while the script is polling
- WOM-1073: Do not require the output argument


## 0.1.0 - 2025-11-11

Initial release of script, `ska-tango-event-monitor` with basic
functionality. The event system of multiple servers can be monitored, with
changes being printed to stdout.  The script can optionally turn on performance
monitoring for the event system of each device server being monitored. It is
also possible to record the (compressed) polled information in an output file.

The pre-release version of this repository built patched pytango wheels to
provide new DServer commands to allow the event system status to be queried,
however, this is no longer required as this feature has been upstreamed in cppTango 10.1.0.  As such, this repository now requires that device servers use pytango/cppTango 10.1.0.

See the README.md for usage.

### Features

- WOM-632: Initial script implementation with option '-m' to turn on performance monitoring and '-o' option to output records to a file.
- WOM-873: Update to work with cppTango 10.1.0
- WOM-680: Add optional compression for output file