Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/broadinstitute/dsp-grafana

Dashboards, datasources, and notifiers for DSP's Grafana server

https://github.com/broadinstitute/dsp-grafana

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Dashboards, datasources, and notifiers for DSP's Grafana server

Basic Info
  • Host: GitHub
  • Owner: broadinstitute
  • License: bsd-3-clause
  • Default Branch: main
  • Size: 52.7 KB
Statistics
  • Stars: 1
  • Watchers: 56
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 4 years ago · Last pushed about 3 years ago
Metadata Files
Readme License Codeowners

README.md

dsp-grafana: Dashboards, Datasources, and Notifiers

Looking to version-control your dashboards for DSP's Grafana instance? Look no further.

This repository can contain .json files for Grafana dashboards and .yaml files for datasources and notifiers (notification channels). When you merge a PR, the Grafana instance will automatically pick up any changes.

Most folks will be working with the dashboard files here--the datasources and notifiers will change much less frequently. Just ping #dsp-devops-champions if you'd like help.

Do we have to version control dashboards?

Nope! For stable dashboards that are frequently viewed but rarely edited, having them version-controlled might make sense.

How do we develop the Dashboard .json files themselves?

For development work, the UI is your friend. - If they're new, create them in the UI and when you're done you can can get the "JSON Model" from the gear icon in the top right. - If they already exist, go ahead and edit like normal--when you click the save button you'll get a prompt with JSON you can copy.

How do we develop the Datasource or Notifier .yaml files?

Ping DevOps for help, look inside those directories for more info--this process is hard and will probably require some usage of Grafana's underlying API to get the fields right.

My file needs to have a password or token in it!

This shouldn't ever happen for dashboards--but for datasources and notifiers, read on.

A little secret: this repository supports json.ctmpl and .yaml.ctmpl files. When the CI/CD action finds a .ctmpl file, it renders it with Vault access (and the rendered file is deployed to Kubernetes as a Secret, not a ConfigMap).

See here for info on the syntax you'd need to use.

The CI/CD action used for this purpose only has the ability to read secret/suitable/grafana/config/*, so put anything you need there.

Why is the ability to template files here an intentionally-poorly-kept secret? Because templating is not recommended for any purpose other than simple Vault access, and it is extremely discouraged for dashboards (which should not need passwords or tokens). DevOps has specific items in our roadmap to make editing dashboards easier, and none of that will work if the dashboard files here contain Consul templating.

Owner

  • Name: Broad Institute
  • Login: broadinstitute
  • Kind: organization
  • Location: Cambridge, MA

Broad Institute of MIT and Harvard

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 23
  • Average time to close issues: N/A
  • Average time to close pull requests: 12 days
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.04
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • jack-r-warren (8)
  • mikeflinn (5)
  • jordansafer (1)
  • yonghaoy (1)
Top Labels
Issue Labels
Pull Request Labels