Skip to content

Latest commit

 

History

History
126 lines (72 loc) · 3.18 KB

README.md

File metadata and controls

126 lines (72 loc) · 3.18 KB
Raw

bitrise-grafana-api

Grafana Wrapper for Bitrise API

Prerequisites

Grafana Account

Sign up for a free trial account here: https://grafana.com/signup/cloud/select-org

Run Locally

Install Dependencies

npm i

Running Grafana JSON Data Source

node index.js

Run on Repl.it

Run on Repl.it

Just click the button above and when the Repl loads click Run.

Copy the base URL from the running Repl

Make sure to update the url in the code here also: https://github.com/DamienBitrise/bitrise-grafana-api/blob/master/index.js#L12

The following Grafana JSON Endpoints will be available

  • /builds
  • /queue
  • /running
  • /stats

Each endpoint will have the following APIs

  • / should return 200 ok. Used for "Test connection" on the datasource config page.
  • /search should return available metrics when invoked.
  • /query should return metrics based on input.
  • /annotations should return annotations.

Install Grafana JSON Plugin

Table Data Source

Chart Data Source

Generate Personal Access Token for Bitrise API

Configure Grafana JSON Data Sources

Table

Charts

Using the Base URL from your server or Repl configure two Grafana JSON Data Sources

Builds Table

URL: BASE_URL/running

Headers

  • Authorization (Personal Access Token for Bitrise API)
  • content ('application/json')
  • appSlugs (comma seperated list of app slugs) [Optional omit to select all apps]

URL: BASE_URL/stats

Headers

  • Authorization (Personal Access Token for Bitrise API)
  • content ('application/json')
  • appSlugs (comma seperated list of app slugs) [Optional omit to select all apps]

Builds Chart

URL: BASE_URL/builds

Headers

  • Authorization (Personal Access Token for Bitrise API)
  • content ('application/json')
  • appSlugs (comma seperated list of app slugs) [Optional omit to select all apps]

Queue Chart

URL: BASE_URL/queue

Headers

  • Authorization (Personal Access Token for Bitrise API)
  • content ('application/json')
  • appSlugs (comma seperated list of app slugs) [Optional omit to select all apps]

Configure Grafana JSON Dashboard

Just Import Grafana Dashboard JSON here:

https://github.com/DamienBitrise/bitrise-grafana-api/blob/master/Bitrise%20Dashboard.json

Updating Data Sources

Note: Due to a Grafana bug with importing dashboards with Data Sources, you may need to unselect and reselect the data sources in the Dashboard panels.

Reselect the DataSources:

Step 1: Click the title of each panel in the Dashboard view and click edit.

Step 2: Select the "Query" dropdown and select a different data source, then select the original data source again.

This updates the Data Source IDs to match the new DataSources you added previously.