Changelog

v3.19.0 - 2026-06-02

Features and Enhancements

  • Updated the service to build from Synapse v2.244.1.

v3.18.0 - 2026-04-15

Features and Enhancements

  • Updated the service to build from Synapse v2.239.0.

v3.17.0 - 2025-08-22

Features and Enhancements

  • Updated the service to build from Synapse v2.219.0.

v3.16.0 - 2025-08-01

Features and Enhancements

  • Updated the service to build from Synapse v2.218.1.

v3.15.0 - 2025-06-12

Features and Enhancements

  • Update the service to build from Synapse v2.213.0.

v3.14.0 - 2025-01-24

Features and Enhancements

  • Update the service to build from Synapse v2.195.0.

v3.13.0 - 2025-01-17

Features and Enhancements

  • Updated deprecated $lib.list() usage to JSON style syntax.

v3.12.0 - 2024-12-02

Features and Enhancements

  • Update the service to build from Synapse v2.190.0.

v3.11.0 - 2024-09-06

Features and Enhancements

  • Add support for disabling readahead on layer slabs by setting the SYNDEV_METRICS_LAYER_READAHEAD environment variable.

v3.10.0 - 2024-08-20

Features and Enhancements

  • Migrate service layer data out of Cell hive storage.

  • Update the service to build from Synapse v2.178.0.

v3.9.0 - 2024-06-14

Features and Enhancements

  • Update the service to build from Synapse v2.171.0.

v3.8.0 - 2024-05-24

Features and Enhancements

  • Move exported Storm API documentation to the package definition.

Bugfixes

  • Fix an issue where statistics were not migrated on mirrors.

This release contains an automatic data migration that will cause additional startup time on first boot for instances that were upgraded as a mirror for any version after 2.7.0. If the migration needs to run, it may take up to 1 hour per 100 million edits stored. During the migration the service will appear offline, and will appear unhealthy to any configured healthchecks. INFO level logs will be produced that show more detailed progress of the migration.

v3.7.0 - 2024-03-26

Features and Enhancements

  • Update the service to build from Synapse v2.165.0.

v3.6.0 - 2024-03-01

Features and Enhancements

  • Update the service to build from Synapse v2.164.0.

v3.5.1 - 2024-02-16

Features and Enhancements

  • Update deprecated $lib.dict() usage to JSON style syntax.

v3.5.0 - 2023-11-15

Features and Enhancements

  • Update the service to build from Synapse v2.154.1.

v3.4.0 - 2023-10-13

Features and Enhancements

  • Update the service to build from Synapse v2.151.0.

v3.3.1 - 2023-09-25

Bugfixes

  • Update the examples in Synapse-Metrics commands to use Storm style comments.

v3.3.0 - 2023-08-21

Features and Enhancements

  • Update the service to build from Synapse v2.144.0.

v3.2.0 - 2023-07-28

Features and Enhancements

  • Update the service to build from Synapse v2.143.0.

v3.1.0 - 2023-07-07

Features and Enhancements

  • Update the service to build from Synapse v2.141.0.

v3.0.0 - 2023-06-14

Features and Enhancements

  • Add API for returning pre-computed aggregated statistics.

  • Added new permission power-ups.metrics.stats.cortex to allow a user to view Cortex-wide statistics.

Migration from v2.x.x

  • Removed metrics.api Storm module (APIs are available in the metrics Storm module).

  • Removed statsByTime() API, associated stored statistics, and stats:ival configuration option.

This release contains an automatic data migration that will cause additional startup time on first boot (potentially up to 1 hour per 100 million edits stored). During the migration the service will appear offline, and will appear unhealthy to any configured healthchecks. INFO level logs will be produced that show more detailed progress of the migration.

v2.8.0 - 2023-05-18

Features and Enhancements

  • Update the service to build from Synapse v2.134.0.

v2.7.0 - 2023-05-09

Features and Enhancements

  • Update the service to build from Synapse v2.133.0.

  • Automatically remove deleted layers from storage; this behavior can be disabled with the layer:cull_deleted configuration option.

  • Add layer index information to metrics.status debug output.

v2.6.0 - 2023-02-02

Features and Enhancements

  • Update the service to build from Synapse v2.122.0.

v2.5.1 - 2022-12-05

Bugfixes

  • Fix a packaging issue.

v2.5.0 - 2022-12-05

Features and Enhancements

  • Add boot hooks to the container entrypoint. Move the entrypoint script to /vertex/synapse/entrypoint.sh.

v2.4.0 - 2022-10-09

Features and Enhancements

  • Update the service to build from Synapse v2.110.0.

v2.3.0 - 2022-08-30

Documentation

  • Fix permission name in Admin Guide.

  • Add clarifying documentation to statsByTime API.

v2.2.0 - 2022-06-01

Documentation

  • Update documentation for AHA provisioning.

v2.1.0 - 2022-05-17

Features and Enhancements

  • Update to the newest Synapse v2.93.0 to support AHA provisioning.

Bugfixes

  • Load storm package readonly to allow containers to run as non-root user.

v2.0.1 - 2022-03-28

Features and Enhancements

  • Update the Metrics service to build off of the current Synapse base image.

v2.0.0 - 2021-12-17

Features and Enhancements

  • New storage format reduces required space by up to 60%.

  • New metrics.nodes.by* commands to lift nodes present in the returned edits.

  • New metrics.edits.byedge command to lift edits by light edge name.

  • Additional statistics collection for props, tags, tagprops, and light edges.

  • Statistics are generated from the layer edit stream instead of polling the Cortex.

Upgrading from v1.x.x

The v1.x.x stroage format is incompatible with v2.x.x, and therefore the service must be re-deployed.

Since statistics are generated from the edit stream, the entire history will be created for active layers. However, previously deleted layers will not be present in the statistics or edit queries.

v1.5.0 - 2021-09-02

Features and Enhancements

  • Update the service to build from Synapse v2.59.0. Resolves issue where lmdb databases created by the service were not efficient copied.

v1.4.0 - 2021-07-21

Features and Enhancements

  • Update the service to use tini as a container entrypoint.

v1.3.0 - 2021-06-21

Features and Enhancements

  • Update the service to build from Synapse v2.43.0.

v1.2.0 - 2021-05-17

Features and Enhancements

  • Update the service to build from Synapse v2.38.0.

v1.1.0 - 2021-04-26

Features and Enhancements

  • Update the service to include information for the getCellInfo() API.

v1.0.0 - 2021-01-18

Features and Enhancements

  • Initial release of Synapse Metrics.