Dashboard Service

Service to retrieve TSB Grafana dashboards.

DashboardService

The Dashboard Service provides access to Grafana dashboards designed for monitoring the TSB platform. These dashboards offer insights into key metrics related to platform health, supporting platform operators in managing and troubleshooting the TSB installation. See Key Metrics docs for more information about the displayed metrics.

ListDashboards

rpc ListDashboards (tetrateio.api.tsb.dashboard.v1.ListDashboardsRequest) returns (tetrateio.api.tsb.dashboard.v1.ListDashboardsResponse)

Return the list of available dashboards, alongside their descriptions. Dashboards are identified by their names, which can be used to download them.

DownloadDashboard

rpc DownloadDashboard (tetrateio.api.tsb.dashboard.v1.DownloadDashboardRequest) returns (google.api.HttpBody)

Download a Grafana dashboard in JSON format by providing the dashboard's name. The downloaded dashboard is intended to be uploaded to a Grafana instance. Platform operators can use each dashboard to monitor specific components of the TSB platform.

Dashboard

Message containing some metadata of a dashboard.

Field	Description	Validation Rule
name	string The name of the dashboard.	–
title	string The title of the dashboard.	–
description	string The description of the dashboard.	–

DownloadDashboardRequest

Request for downloading a dashboard.

Field	Description	Validation Rule
name	string REQUIRED The name of the dashboard to download.	string = {   min_len: 1 }

ListDashboardsRequest

Request for listing available Grafana dashboards.

ListDashboardsResponse

Response providing a list of available Grafana dashboards.

Field	Description	Validation Rule
dashboards	List of tetrateio.api.tsb.dashboard.v1.Dashboard List of available dashboards.	–