README.md

RADAR-base Data Dashboard backend

Application that provides a REST API to provide Variables (measured modalities) and related Observations (measurements) for Subjects (participants). The data layer connects to the TimescaleDB database that is provisioned with (a subset of) the data from the RADAR-base kafka service.[]

• RADAR-base Data Dashboard backend
  • Features supported
  • APIs to be used by REST Source-Connectors
  • Installation
  • Authorization
    • Registering OAuth Clients with ManagementPortal
  • Sentry monitoring

Features supported

1. API for retrieving variables and observations for a single subject.
2. Has liquibase support to enable seamless database schema migration.

APIs to be used by REST Source-Connectors

Data dashboard applications can use the APIs as follows.

GET */project/{projectId}/subject/{subjectId}/topic/{topicId}/observations

Installation

To install functional RADAR-base Rest-Sources Authorizer application with minimal dependencies from source, please use the docker-compose.yml under the root directory.

Copy the docker/etc/rest-source-authorizer/authorizer.yml.template into docker/etc/rest-source-authorizer/authorizer.yml and modify the restSourceClients.FitBit.clientId and restSourceClients.FitBit.clientSecret with your Fitbit client application credentials. Then start the docker-compose stack:

docker-compose up -d --build

Authorization

All users registered with the application will be authorized against ManagementPortal for integrity and security.

Registering OAuth Clients with ManagementPortal

To add new OAuth clients, you can add at runtime through the UI on Management Portal, or you can add them to the OAuth clients file referenced by the MANAGEMENTPORTAL_OAUTH_CLIENTS_FILE configuration option. For more info, see officail docs The OAuth client for authorizer-app-backend should have the following properties.

client-id:data_dashboard_api
client-secret:Confidential
grant-type:authorization_code,refresh_token
resources:res_DataDashboardAPI
scope:MEASUREMENT.READ

Sentry monitoring

To enable Sentry monitoring:

1. Set a SENTRY_DSN environment variable that points to the desired Sentry DSN.
2. (Optional) Set the SENTRY_LOG_LEVEL environment variable to control the minimum log level of events sent to Sentry. The default log level for Sentry is WARN. Possible values are TRACE, DEBUG, INFO, WARN, and ERROR.