Welcome to Scorpion’s documentation!

ScorPIoN is a Dashboard that collects and visualizes Key Performance Indicators (KPI) for services. KPIs are measurements we agreed upon to monitor how well a service is performing. Based on trends over a year this will give insights into what measures to take. Scorpion is the tool that is used to collect the results of all services in the Service Monitoring and generate plots and overviews for the review processs.

Note

This project is under active development.

This documentation provides insights into how to use Scorpion (see Usage for further details) as well as provide documentation of the REST API (see API for further details.). In addition instructions for the Deployment are provided.

Contents

• Usage
  • Registration
  • Service Registration via BONSAI Form
  • KPI Submission using the Web Interface
  • KPI Visualizations
• API
  • Authentication and Authorization
  • Public Endpoints
• Deployment
  • Software Architecture
    • Storage Layer
    • API Layer
    • GUI Layer
  • RDC Integration
  • Installation Guide