Skip to content
This repository has been archived by the owner on Jul 13, 2022. It is now read-only.

ria-ee/X-Road-opmonitor

Repository files navigation

Republic of Estonia Information System Authority X-ROAD European Union / European Regional Development Fund / Investing in your future

X-Road v6 monitor project

Introduction

REPO IS ARCHIVED. PLEASE USE NIIS REPO

The project maintains X-Road v6 log of service calls (queries). Logs are collected and corrected. Further analysis about anomalies (possible incidents) is made. Usage reports are created and published. Logs are anonymized and published as opendata.

Instructions to install all components, as well as all modules source code, can be found at:

https://github.com/ria-ee/X-Road-opmonitor

Architecture

The system architecture is described ==> here <==.

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 ==> here <==

Module installation precedence

The modules should be set up in the following order:

  1. Collector (before others)
  2. Corrector (after Collector, before others)
  3. Analyzer (optional, after previous)
  4. Reports (optional, after previous)
  5. Opendata (optional, after previous)
  6. Networking (optional, after Opendata)

Programming language

All modules, except Networking, are written in Python™ and tested with version 3.5.2. Other 3.x versions are likely to be compatible, give or take some 3rd party library interfaces. Networking module is written in R https://www.r-project.org/.

Reporting Issues / Contributing

Efforts have been made to ensure everything is easy, correct, secure. Please report any bugs and feature requests on the Github issue tracker. We will read all reports!

We also accept pull requests from forks. If possible please follow guidelines https://github.com/nordic-institute/X-Road-development/blob/master/WORKFLOW.md Very grateful to accept contributions from folks.

Stay Safe

We have every reason to believe this X-Road operational monitoring tool will not corrupt your data or harm your computer. But if we were you, we would suggest to test thoroughly before use it in a production environment.

Developed by: STACC (Software Technology and Applications Competence Center) according to procurement RHR 183990

Released by Riigi Infosüsteemi Amet, Data Exchange Layer X-Road, under the MIT License.

Contact

Product owner: Toomas Mölder, toomas.molder@ria.ee; (desk) +372 666 8822 / (mobile) +372 55 22000; skype: toomas.molder