X-Road Metrics

Introduction

X-Road® Metrics is a tool for collecting, storing and analysing reporting data and metrics from an X-Road® ecosystem. The data can be used to measure usage of individual services, understand dependencies and relationships between different information systems and services, monitor service health, etc. Also, the information can be published as open data.

X-Road Metrics can be used by both X-Road Operators and X-Road Members. The X-Road Operator can use X-Road Metrics to collect data from an entire X-Road ecosystem while X-Road Members can access their own data.

The X-Road Metrics software is released under the MIT open source license and is available free of charge. The documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Architecture

The system architecture is described in the System Architecture document.

Installation instructions

Installing/setting up the Mongo Database (MongoDB)

The first thing that should be done is setting up the MongoDB. Instructions on setting up the MongoDB can be found in the Database Module document.

Module installation precedence

The modules should be set up in the following order:

• Database module
• Collector module
• Corrector module
• Reports module
• Anonymizer module
• Opendata module
• Networking/Visualizer module
• Opendata Collector module

Programming language

All modules, except Networking, are written in Python™ and tested with version 3.8 Other 3.x versions are likely to be compatible, give or take some 3rd party library interfaces. Networking module is written in R.

How to contribute?

Sign up for an account and get access to the X-Road Metrics Backlog.

Submit a pull request to X-Road Metrics source code Github repository or an enhancement request to the ideas category under discussions.

When opening a pull request, please provide a signed Contributor Licence Agreement (CLA). More information can be found here.

Support disclaimer

The following activities, among others, are undertaken by the Nordic Institute for Interoperability Solutions (NIIS) with regard to X-Road Metrics:

• management, development, verification, and audit of the source code
• administration of documentation
• administration of business and technical requirements
• conducting development
• developing and implementing principles of licensing and distribution
• providing second-line support for the NIIS members
• international cooperation.

X-Road Technology Partners are enterprises providing X-Road consultation services, e.g. deploying independent X-Road instances, developing X-Road extensions and X-Road-compatible services, integrating informations systems with X-Road etc.

No support for X-Road Metrics deployment is provided here.

Credits

• X-Road Metrics was initially developed by: STACC (Software Technology and Applications Competence Center) according to procurement RHR 183990
• In 2020 it was agreed that Nordic Institute for Interoperability Solutions (NIIS) takes maintenance responsibility.