Supervisor

Table of Contents

1. About The Project
   • Built With
2. Roadmap
3. Contributing
4. License
5. Contact

About The Project

It's a project to periodically test APIs endpoints, send alerts and get APIs status reports

Built With

• 
• 
• 
• 

(back to top)

Roadmap

• Tenant service
• User service
• Authentication service with support External SSO providers
  • Google SSO
  • Azure SSO
• Back office web site
  • Create tenant with admin user
  • Login user
  • Register users
  • Modify user roles
• Configuration Service
  • Manage Api test configuration
  • Send configuration to Messaging hub
• Scheduler Service
  • Periodical ask to Testing Service to test API
• Testing Service
  • Test Api endpoint with provided configuration
  • Send test Api result to Messaging hub
• Aggregation Service
  • Receive and save test Api result from Messaging hub
  • Aggregate result and save it
• Alerting Service
  • Send Alert on test api error which depends of testing configuration
• Reporting Service

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache License 2.0 with Commons Clause License Condition v1.0. See LICENSE.txt for more information.

(back to top)

Contact

Guillaume Fortin - [email protected]

Project Link: https://github.com/NEETROF/supervisor

(back to top)

Architecture Schema

---
title: Front Architecture Schema
---
flowchart LR

    BackOffice[Back office Front]
    Bff[Back for front Service]
    
    subgraph backendPanel [Back end]
        AuthService[Authentication Service]
        UserService[User Service]
        TenantService[Tenant Service]
        ConfigurationService[Configuration Service]
        AggregationService[Aggregation Service]
        ReportingService[Reporting Service]
    end
    
    BackOffice --> Bff
    Bff --> AuthService
    Bff --> UserService
    Bff --> TenantService
    Bff --> ConfigurationService
    Bff --> AggregationService
    Bff --> ReportingService
    

Loading

---
title: Backend Architecture Schema
---
flowchart LR

subgraph external_sso_providers [External SSO Providers]
googleSSO[Google SSO provider]
azureSSO[Azure SSO provider]
otherSSO[Other SSO provider]
end

subgraph authentication [Authentication]
AuthService[Authentication<br>Service]
AuthData[(Database)]
UserData[(Database)]
UserService[User Service]
TenantData[(Database)]
TenantService[Tenant Service]
end

subgraph scheduler [Scheduler]
SchedulerService[Scheduler<br>Service]
SchedulerService --> SchedulerRedis[(Redis)]
end

subgraph testing [Testing]
ConfigurationData[(Database)]
AggregationData[(Database)]
AggregationService[Aggregation Service]
TestingService[Testing Service]
ConfigurationService[Configuration<br>Service]
end

subgraph alerting [Alerting]
    AlertingService[Alerting Service]
end

subgraph reporting [Reporting]
    ReportingService[Reporting Service]
end

AlertingService --> ReportingService

subgraph mailing [Mailing]
    MailingService[Mailing Service]
end

MessagingService[[Messaging service]]
MailingService --> MailingProvider[[MailingProvider]]

AuthService --> googleSSO
AuthService --> azureSSO
AuthService --> otherSSO
AuthService --> AuthData
TenantService --> TenantData
UserService --> UserData
AggregationService --> AggregationData
AuthService --> UserService
AuthService --> TenantService
MessagingService <-.-> SchedulerService
MessagingService -.-> AggregationService
MessagingService <-.-> TestingService
ConfigurationService -.-> MessagingService
TenantService -.-> MessagingService
MessagingService -.-> AlertingService
MessagingService -.-> MailingService

ConfigurationService --> ConfigurationData

Loading