Open Metrics Framework - User Guide

Introduction

This guide helps EBRAINS development teams request access to the Open Metrics Framework dashboards relevant to their services and provides an overview of available dashboards. Service owners can request access for themselves and team members via the dedicated form. Access is managed by the Technical Coordination (TC) team.

Access Instructions for Registered/Deployed Services

1. Navigate to the Open Metrics Framework Request Access Form.
2. Fill in the required fields:
   • Select the service you are requesting access for.
   • Select the Deployment Type of the service.
     This field is required to enable access to the Operating System Metrics Dashboard, which provides system-level metrics (e.g., CPU, memory, and storage usage) for your service deployment.
     If your service is deployed within the EBRAINS infrastructure, this dashboard will automatically be available once access is granted.
   • Provide the Deployment Name of the service.
     For Virtual Machine (VM) deployments, specify the VM name and for Kubernetes (K8s) deployments, specify the namespace where the service is deployed.
   • Provide the IAM OIDC Client Name of the service.
     This field is required to enable access to the dashboard showing metrics for authenticated EBRAINS users who visited your service. This requires your service to have a valid OIDC client registered in the EBRAINS IAM service, which is used to authenticate users via their EBRAINS accounts.
   • Provide the Matomo Site ID of the service.
     This field enables access to the dashboard tracking all visits, including both authenticated and non-authenticated visitors.
     To use this dashboard, your service must be integrated with EBRAINS Stats (powered by Matomo) following the EBRAINS Stats integration guidelines. Analytics data must be successfully sent to the EBRAINS Stats service. Once integrated, you can find your Site ID in the Matomo tracking snippet provided by the support team. Search for the term setSiteId in the snippet to locate the value.
   • List the team members who should be granted access. All members must have an EBRAINS account.
   • Add any additional notes, if applicable.
3. After submitting the form, all team members listed above must log in to the Open Metrics Framework using the Sign in with OAuth option and their EBRAINS credentials. If the request is approved, the TC team will grant access to the appropriate dashboards within the Open Metrics Framework. Otherwise, access will be restricted for members who are not related to the corresponding service.

Note: The only mandatory fields are Service Name and Team Members. If you are unsure about any of the other fields, you may leave them blank. In that case, please describe in the Additional Notes field which dashboard(s) you expect to gain access to. The TC team, together with the Open Metrics Framework administrators, will investigate your request and contact you with further information.