X-Road Metrics v1.2.0 Release Notes

Release Info

Version number

1.2.0

Release date

06.10.2023

Supported versions

  • 1.2.0

  • 1.1.1

  • 1.0.0

Supported platforms

  • Ubuntu 20.04 LTS

  • Ubuntu 22.04 LTS

Official documentation

https://github.com/nordic-institute/X-Road-Metrics/tree/master/docs

Source code

https://github.com/nordic-institute/X-Road-Metrics

Software license

MIT



On this page:



Changes in This Release

Summary

  • Various optimisations to reduce resource usage and improve processing speed.

  • Various fixes to the installation process.

  • Security fixes and dependency updates.

  • Add new Opendata statistics endpoint.

  • Add new Opendata harvest API endpoint for sharing instance data.

  • Add new Opendata metadata API endpoints to query configuration data.

Completed Issues

Issue ID

Type

Summary

Issue ID

Type

Summary

OPMONDEV-136

Fix

Fix issue in the Opendata module web interface where the constraint operator is empty on the initial load.

OPMONDEV-138

Improvement

Improve MongoDB query construction to prevent potential query injection issues.

OPMONDEV-149

Improvement

Improve the Opendata module so that the Postgres initialisation can be re-run without causing issues.

OPMONDEV-160

New

Introduce new Opendata API endpoint (/api/harvest) that enables time range based harvesting of the data collected by the Opendata module.

This new endpoint is enabled by default on new and existing instances and can be disabled by setting the opendata.disable-opendata-harvest property to true in the opendata modules settings.yaml file.

OPMONDEV-161

New

Introduce a new Opendata Collector module that enables collection of open data using the new Opendata API endpoint (/api/harvest).

More information is available in the modules documentation: https://github.com/nordic-institute/X-Road-Metrics/blob/master/docs/opendata_collector_module.md

OPMONDEV-166

Fix

Fix issue where the Anonymizer module failed to grant access rights to Postgres read-only users listed under the modules settings file.

OPMONDEV-167

Fix

Fix issue where the Networking module failed to start if mTLS settings for Postgres were not filled even if mTLS was not used.

OPMONDEV-168

Improvement

Improve error handling and logging in X-Road Metrics modules to make catching and fixing configuration issues simpler.

OPMONDEV-169

Fix

Fix issue where the collector module incorrectly reported that no operational data was found for a Security Server when there was a connection or communication error.

OPMONDEV-171

New

Introduce a new /api/statistics endpoint to the Opendata module that provides statistical data related to the X-Road instance. The following data is returned:

  • Number of queries in the current month

  • Number of queries in the previous month

  • Number of queries in the current year

  • Number of queries in the previous year

  • Number of queries today

  • Number of queries in total

  • A list of member classes with their code, description and number of X-Road members associated with the class

  • Number of services in total on the instance

  • The top 20 must used services with their query counts

  • The time when the statistics were last updated

The statistics are gathered by a new executable script in the Anonymizer module. Information on setting up a cron job to regularly update the statistics is available here:

https://github.com/nordic-institute/X-Road-Metrics/blob/master/docs/anonymizer_module.md#metrics-statistics

By default statistics are not gathered. Before starting to collect statistics, the users must configure the xroad.central-server block in the Anonymizer modules settings.yaml file. For new installs, the block is already present in the settings.yaml file. For upgrades, the following lines should be added from the example settings file:

https://github.com/nordic-institute/X-Road-Metrics/blob/64fb79deab605757054fe0081d8a11636526abd9/anonymizer_module/etc/settings.yaml#L14-L17.

NB! To generate statistical data, the Anonymizer module needs network access to the global configuration on the Central Server similarly to how the Collector module is set up.

OPMONDEV-172

New

Introduce two new endpoints /api/settings and /api/constraints to be able to query the web interface metadata related to settings and available field constraints.

OPMONDEV-173

Improvement

Improve parsing classifier values from X-Road operational data so that it is case insensitive.

OPMONDEV-177

Improvement

Merged pull request from the community improving the Opendata modules memory usage when querying from the database.

Issue types: fix (bug fix or technical debt), improvement (improvement to an existing feature), new (a new feature).

New/Updated Dependencies

Dependency

Old Version

New Version

Notes

Dependency

Old Version

New Version

Notes

requests

2.28.2

2.31.0



bleach



6.0.0

New dependency

django

3.2.18

3.2.20



pyyaml

5.3.1

5.4.1



Contributors

The following developers have contributed to the development of this release version. A contribution means at least one Git commit that is included in the release. The full list of contributors of different X-Road® versions is available here.

GitHub Username

Other Notes

-

Package Repositories

Repository

URL

Repository

URL

Focal

deb https://artifactory.niis.org/xroad-extensions-release-deb focal-<version> main

Jammy

deb https://artifactory.niis.org/xroad-extensions-release-deb jammy-<version> main

Repository Sign Key Details

Download URL

https://artifactory.niis.org/api/gpg/key/public

Hash

935CC5E7FA5397B171749F80D6E3973B

Fingerprint

A01B FE41 B9D8 EAF4 872F A3F1 FB0D 532C 10F6 EC5B

3rd party key server

Ubuntu key server

Packages

Focal

Package

Checksum

Package

Checksum

xroad-metrics-anonymizer

f041838b014c6470845503f4f09f763d7db97bda051c16fb7fd34688533ade9b

xroad-metrics-collector

70248bfaad451ad6d7bc11677992fb2a8091bda6a550056b5008703545eec32a

xroad-metrics-corrector

b1cd2f71bffddb99a01532d81bba3b2bd11ec2709d700acfd601e26335fdc78f

xroad-metrics-networking

5094b49473d23ad09dd1ae90f44e68281489b5bae60c3c8f59e6c79ef2f6f65e

xroad-metrics-opendata

2c8976e706ec018aef5ba2198a7407cbfe55ed0efa0d096e71581cd483a74295

xroad-metrics-opendata-collector

82d4a7ffa2865554c1ee2233c322fc434475db3925eb937f36c7367954e7543f

xroad-metrics-reports

6409ac074a8fe52d501ee8964dce6db16c43293ce69b07008e1a17203b577992

Jammy

Package

Checksum

Package

Checksum

xroad-metrics-anonymizer

e385d38c75d9822d6556c16472abb27a801d31c18c0e8890451536c3afb6324c

xroad-metrics-collector

a688c035fb165e15f900d37c31976e3d133cc92216300fa8dfc1612d68ae392f

xroad-metrics-corrector

b4c1f3e09d676163686d7b26225168a8cfbc1af11d9de02c6ea84831ca1a1c79

xroad-metrics-networking

c2265a42072a687021ec8c73bd0d706aa4bd81896e9a89a3195df814cbcca3fb

xroad-metrics-opendata

60d71be21a027512323c45cd89ef6db4de897b99120e85e15e3821f2524d55b7

xroad-metrics-opendata-collector

c633dd9b2426a9345b9bbdba818921ff8da82f11fe699dd9df5255484ca65122

xroad-metrics-reports

ebce1923226e072c400e1433eb235737bdfbaf8078bc2f6afedb5d59592443bb