 |
 |
|---|
This document is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/
X-Road Metrics is a collection of tools that can be used to collect, process and present operational monitoring data collected from X-Road Security Servers. The system consists of several modules:
- Database module
- Collector module
- Corrector module
- Reports module
- Anonymizer module
- Opendata module
- Networking/Visualizer module
In addition to the above modules, the source code includes an experimental Analysis Module, which is not yet released.
This document contains an architecture overview of the interfaces between the modules. Also, the document presents some possible hardware infrastructure options that can be used to run X-Road Metrics tools. The operational specifications and hardware recommendations in this documentation are based on the Estonian production X-Road instance.
This document is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/
Expectations below are valid for overall X-Road usage by all its member organizations. Usage of X-Road in particular organization or hosted in particular hosting or X-Road Security Servers farm differs significantly, therefore other architecture, hardware and software might used to fulfill particular organization requirements.
- It is expected to have maximum 1 billion (1 000 000 000) X-Road service calls (queries) in production environment (Estonia: EE) in 1 year period
- Each query results in two operational monitoring data entries to be collected
(from both query partners Client and Producer), id est maximum 2 billion (2 000 000 000) operational monitoring data
entries in production environment in 1 year period. This means:
- 165 000 000 operational monitoring data entries per month
- 40 000 000 operational monitoring data entries per week
- 5 500 000 operational monitoring data entries per day
- 230 000 operational monitoring data entries per hour
- 60 000 operational monitoring data entries per 15 minute
- Each of operational monitoring data entry in JSON-format takes approximately 900 B (bytes).
- Each data entry is uploaded into MongoDB as 'raw_messages' and after correction kept there as 'clean_data'. Raw messages are purged periodically.
- Each data entry is published in PostgreSQL as open-data after anonymization.
- MongoDB shall retain 1 year data in disk memory.
- MongoDB shall retain 1 week data in RAM memory for efficient query.
- MongoDB shall run in a replication set for availability.
- PostgreSQL shall retain 1 year of public available data.
- Collector: runs every 2 hours, collect recent data from Security Servers and stores them in Database.
- Corrector: runs continuously as a service, use recent data in MongoDB.
- Analyzer: runs every hour, uses MongoDB and local cache in disk.
- Report creator: runs monthly, uses MongoDB, stores reports in disk, publish them on public server and sends out notifications about reports available.
- Open Data Module: runs every day, uses MongoDB recent data, uses PostgreSQL as main database.
- Networking Module: runs every day, uses last 30 days data from Opendata PostgresSQL, produces X-Road networking diagram with R Shiny.
Taking to account the operational requirements above, it is recommended to install each X-Road Metrics module on a dedicated server or virtual machine.
In a usual X-Road Metrics setup there is data on two privacy levels. The MongoDb contains data that might contain sensitivie information like IP-addresses or personal data. That should be accessible only by the X-Road administrators. The open data stored in the PostgreSQL is anonymized and intended for public distribution.
Thus, it is recommended to configure the network infrastructure so that the modules handling and serving the open data are strictly isolated from the confidential data in MongoDb. This can be achieved for example by setting up separate virtual LANs for the public and private modules and setting a firewalled routing between the networks that allows only for the anonymized data to be uploaded to the PostgreSQL database. Always consult your network administrator for environment specific details.
Diagram below shows an example setup where private modules are on hosts in VLAN1 and open data modules in VLAN2:
The diagram includes also the experimental Analyzer module that has not been published yet.
Specifications for each host in the example setup is in the following chapters.
Ubuntu Server 20.04 and 22.04 are currently the supported operating systems to run X-Road Metrics.
In addition to the X-Road Metrics packages, following 3rd party software needs to be installed:
- MongoDb 4.4
- PostgreSQL 12.6
- RStudio Shiny Server 1.5.16
Please refer to the module specific documentation for detailed installation instructions.
Table below shows the network connections in the X-Road Metrics system and can be used as a reference for firewall configurations:
| Server | Client(s) | Port | Description |
|---|---|---|---|
| centraldb | collector, corrector, reports, anonymizer | 27017 | MongoDb |
| opendata | 0.0.0.0/0 | 443 | HTTPS to Opendata web UI (Apache) |
| opendata | anonymizer, networking | 5432 | PostgreSQL |
| networking | 0.0.0.0/0 | 443 | HTTPS to Networking Visualizer UI (Apache) |
| X-Road Central Server | collector | 80 | internalconf API to list Security Servers |
| X-Road Monitoring Client | collector | 80/443 | getSecurityServerOperationalData X-Road service |
| SMTP server | reports | 25/465/587 | (Optional) SMTP server to send report e-mail notifications |
| Reports file server | reports | e.g. 22 | (Optional) Sync report files to some public file server using e.g. scp or rsync |
All connections to the web user interfaces use HTTPS protocol. The UI installation packages install Apache web server as a dependency. Installer creates a self signed certificate and configures the Apache to act as a reverse proxy where HTTPS connections are terminated. In production use the system administrator needs to add their own certificates and DNS settings to Apache configuration files. Please refer to each module's installation instructions for detailed instructions.
Table below lists the recommended hardware specifications for the hosts in the example setup.
| Host/Module | CPU cores | RAM | Storage | Notes |
|---|---|---|---|---|
| centraldb | 4 | 32 GB | 5 TB (XFS recommended) | It is recommended to set up minimum 3 MongoDb replication nodes and to use RAID-0 or RAID-10 storage setup for redundancy. |
| collector | 2 | 2 GB | 10 GB | |
| corrector | 4 | 8 GB | 10 GB | |
| reports | 2 | 16 GB | 10 GB | |
| analyzer | 4 | 32 GB | 10 GB | |
| anonymizer | 2 | 4 GB | 10 GB | |
| opendata | 4 | 32 GB | 5 TB | |
| networking | 2 | 8 GB | 10 GB |
Disk size estimates for the databases are based on estimated size for 1 year of documents (1 billion X-Road service calls (queries)):
| Collection Name | Documents | Avg.Document Size (B) | Total Document Size (GB) | Num.Indexes | Total Index Size (GB) |
|---|---|---|---|---|---|
| raw_messages | 2,000,000,000 | 900 | 1,500 | 6 | 170 |
| clean_data | 1,400,000,000 | 2000 | 2,500 | 44 | 530 |
| TOTAL | 3,400,000,000 | 4,000 | 700 |
The Database Module is responsible to store queries data using MongoDB. In the example setup it is installed on the host xroad-metrics-centraldb and it is used only to run MongoDB. Detailed installation instructions can be found in the Database module's documentation.
Scalability: Addition of Nodes (8 nodes to support 1 week data in RAM in 2021 in Estonia)
Note: index size depends on how indexes are set up and used.
Please note about warnings and recommendations of MongoDB:
# mongo admin --username root --password
STORAGE [initandlisten] ** WARNING: Using the XFS filesystem is strongly recommended with the WiredTiger storage engine
STORAGE [initandlisten] ** See http://dochub.mongodb.org/core/prodnotes-filesystem
CONTROL [initandlisten]
CONTROL [initandlisten] ** WARNING: /sys/kernel/mm/transparent_hugepage/enabled is 'always'.
CONTROL [initandlisten] ** We suggest setting it to 'never'
CONTROL [initandlisten]
CONTROL [initandlisten] ** WARNING: /sys/kernel/mm/transparent_hugepage/defrag is 'always'.
CONTROL [initandlisten] ** We suggest setting it to 'never'
The Collector Module is responsible for querying servers and storing the data into MongoDB database. In the example setup it is installed on the host xroad-metrics-collector. Detailed installation instructions can be found in the Collector module's documentation.
The Corrector Module is responsible for transforming the raw data in MongoDB to cleaning data. In the example setup it is installed on the host xroad-metrics-corrector. Detailed installation instructions can be found in the Corrector module's documentation.
The corrector module stores in RAM query documents during duplication removal and client-producer pair matching. The amount of used memory is estimated to 60 MB of RAM memory for 20k batch messages.
The Reports Module is responsible to generate periodical reports, accordingly to user configuration. In the example setup it is installed on the host xroad-metrics-reports. Detailed installation instructions can be found in the Reports module's documentation.
The reports module loads in memory query data for the time period considered in the report. For 1 month of data, a maximum of 10 millions queries are considered for one subsystem code. The amount of used memory is estimated to 30 GB for 10M messages in a report.
Opendata module is used to publish the X-Road operational monitoring data as open data. In the example setup it is installed on the host xroad-metrics-opendata. Opendata module uses a PostgreSQL database to store the published data which is installed on the same host. Detailed installation instructions for Opendata module and the PostgreSQL database can be found in the Opendata module's documentation.
Anonymizer module is responsible for preparing the operational monitoring data for publication through the Opendata module. In the example setup it is installed on the host xroad-metrics-anonymizer. Detailed installation instructions can be found in the Anonymizer module's documentation.
NOTE! Analysis module has not been released and is only included in the source code repository.
Analysis module detects anomalies in the operational monitoring data and provides a UI to present the analysis results. The actual analyzer and the UI are packaged separately but on the example setup they are both installed on the host xroad-metrics-analyzer. Detailed installation instructions can be found in the Analysis module's documentation.
The analyzer module uses MongoDB aggregation functions and therefore has a relatively small memory footprint. The memory usage is dependent of number of X-Road services. The estimated memory usage is 250 MB for 1 000 X-Road operational monitoring data entries.
The Networking visualizer module provides a web UI to display graphical representations of X-Road queries based on the operational monitoring data. In the example setup it is installed on the host xroad-metrics-networking. Detailed installation instructions can be found in the Networking module's documentation.
When testing out X-Road Metrics in a simple X-Road environment, it is not necessary to install each module on a separate host. The example diagram below shows an example setup where the X-Road Metrics modules are installed on two hosts, named xroad-metrics-private and xroad-metrics-opendata. As with the recommended production setup, also here the private data in MongoDb and Opendata in PostgreSQL are isolated by a firewall setup between the hosts.
