rucio-dataset-mon-go

README

rucio-dataset-mon-go package

The rucio-dataset-mon-go package serves Rucio aggregated data, imported to MongoDB, using JQuery datatables.

Package development is in still progress. You may see test page from : rocket: here 🚀 , beware that some functionalities not there yet.

Docs

• Deployment instructions
• Datatables example request

Bug Report & Contribution

Please open GitHub issue

References

• https://github.com/dmwm/das2go
• https://dev.to/hackmamba/build-a-rest-api-with-golang-and-mongodb-gin-gonic-version-269m
• https://github.com/dmwm/CMSKubernetes/tree/master/docker/cmsmon-rucio-ds-web
• https://github.com/dmwm/CMSKubernetes/blob/master/kubernetes/monitoring/services/mongo/cmsmon-rucio-ds-web.yaml

Special Thanks

• Special thanks to Valentin for his suggestions, reviews and guidance.
• Many thanks to Danilo Piparo for bringing up the idea of this project

Documentation

Overview

Package main

Rucio dataset monitoring using aggregated Spark data

What is this

Main aim of the project is to show all Rucio dataset information in a web page with required functionalities

What is used

DataTables: very popular JQuery library to show pretty tables with nice UI and search/query functionalities
MongoDB: used to store following data in separate collections
            - aggregated Rucio datasets results,
            - detailed dataset results,
            - short url hash_id:request binding
            - data source timestamp
         multiple MongoDB indexes are created to use full performance of it
JQuery/JS: to manipulate and customize DataTables, JQuery and JS used

What Go service provide

`gin-gonic` web framework is used to both
    - MongoDB APIs, see `routes.main_router`
    - serve html pages using Go templates

Main page functionalities

Main page provides
    - Sort
    - Detailed RSE functionality: green "+" button
    - Paging
    - Count of search result
    - Search using SearchBuilder conditions: "Add condition". Even though SB allows nested conditions, now it supports depth=1
    - Buttons:copy, excel,PDF,column visibility
    - Short URL: which is the advanced functionality of this service. Please see its documentation for more details.