Dashboard - Revision history

Jebba: dashboard screencap

2020-01-20T02:59:25Z

dashboard screencap

Jebba: Librespace1 moved page Telemetry Dashboards to Dashboard: Match hostname

2020-01-20T02:19:38Z

Librespace1 moved page Telemetry Dashboards to Dashboard: Match hostname

Jebba: categories

2020-01-19T21:38:49Z

Cshields at 23:40, 9 February 2019

2019-02-09T23:40:52Z

Cshields: categories

2019-02-02T20:16:46Z

Cshields at 19:41, 2 February 2019

2019-02-02T19:41:40Z

Cshields at 19:41, 2 February 2019

2019-02-02T19:41:15Z

Cshields: major revamp, new screenshots

2019-02-02T19:40:21Z

major revamp, new screenshots

Cshields at 22:34, 25 August 2018

2018-08-25T22:34:13Z

Cshields at 22:33, 25 August 2018

2018-08-25T22:33:35Z

← Older revision		Revision as of 02:59, 20 January 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
		+
		+	== Introduction ==
		+	A SatNOGS dashboard website is available:
		+
		+	* [https://dashboard.satnogs.org/ SatNOGS Dashboard]
		+
		+	[[File:Satnogs-dashboard-cap.png\|800px\|SatNOGS Dashboard Screen capture]]

	===<span class="glyphicon glyphicon-dashboard"></span> https://dashboard.satnogs.org<nowiki/>===		===<span class="glyphicon glyphicon-dashboard"></span> https://dashboard.satnogs.org<nowiki/>===

@@ Line 69: / Line 69: @@
 "Save As" will allow you to make a copy of a graph and hack on it.
-[[Category:Development]]
+[[Category:Develop]]
 [[Category:Telemetry]]
 __NOEDITSECTION__

@@ Line 6: / Line 6: @@
 I'm going to drop a few things to get the reader going on telemetry dashboard in SatNOGS, and expect that the reader also reference the [https://docs.grafana.org Grafana documentation] for more details on building dashboards.
-This doc also assumes you have an account to edit dashboards. You can generate an account by clicking the Sign In link.
+This doc also assumes you have an account to edit dashboards. You can generate an account by clicking the Sign In link, and then [[Get In Touch|contacting us]] to escalate your permissions. You will be put into a group with access to the "Scratchpad - New Users" folder at first.
 Today there is a top level folder hierarchy designed as such:

@@ Line 1: / Line 1: @@
 __NOTOC__
-=== <span class="glyphicon glyphicon-dashboard"></span> https://dashboard.satnogs.org ===
+===<span class="glyphicon glyphicon-dashboard"></span> https://dashboard.satnogs.org<nowiki/>===
 We are using [https://www.influxdata.com/ InfluxDB] and [https://grafana.com/ Grafana] for our telemetry dashboards. [https://www.influxdata.com/ InfluxDB] is a time-series database designed to be efficient for time-series data like the telemetry we collect in SatNOGS.
@@ Line 69: / Line 69: @@
 "Save As" will allow you to make a copy of a graph and hack on it.

@@ Line 1: / Line 1: @@
 __NOTOC__
-=== <span class="glyphicon glyphicon-dashboard"> https://dashboard.satnogs.org ===
+=== <span class="glyphicon glyphicon-dashboard"></span> https://dashboard.satnogs.org ===
 We are using [https://www.influxdata.com/ InfluxDB] and [https://grafana.com/ Grafana] for our telemetry dashboards. [https://www.influxdata.com/ InfluxDB] is a time-series database designed to be efficient for time-series data like the telemetry we collect in SatNOGS.

← Older revision	Revision as of 02:19, 20 January 2020
(No difference)

← Older revision		Revision as of 19:41, 2 February 2019
Line 1:		Line 1:
−	=== https://dashboard.satnogs.org ===	+	__NOTOC__
		+
		+	=== <span class="glyphicon glyphicon-dashboard"> https://dashboard.satnogs.org ===
	We are using [https://www.influxdata.com/ InfluxDB] and [https://grafana.com/ Grafana] for our telemetry dashboards. [https://www.influxdata.com/ InfluxDB] is a time-series database designed to be efficient for time-series data like the telemetry we collect in SatNOGS.		We are using [https://www.influxdata.com/ InfluxDB] and [https://grafana.com/ Grafana] for our telemetry dashboards. [https://www.influxdata.com/ InfluxDB] is a time-series database designed to be efficient for time-series data like the telemetry we collect in SatNOGS.

@@ Line 1: / Line 1: @@
-== THIS IS A WORK IN PROGRESS AND SUBJECT TO CHANGE ==
+I'm going to drop a few things to get the reader going on telemetry dashboard in SatNOGS, and expect that the reader also reference the [https://docs.grafana.org Grafana documentation] for more details on building dashboards.
-We are using InfluxDB and Grafana for our telemetry dashboards. InfluxDB is a time-series database designed to be efficient for time-series data like the telemetry we collect in SatNOGS.
+This doc also assumes you have an account to edit dashboards. You can generate an account by clicking the Sign In link.
-I'm going to drop a few things to get the reader going on telemetry dashboard in SatNOGS, and expect that the reader also reference the [Grafana documentation](http://docs.grafana.org/) for more details on building dashboards.
+Today there is a top level folder hierarchy designed as such:
-This doc also assumes you have an account to edit dashboards.
+* Telemetry (where telemetry dashboards should be stored, publicly accessible)
-Today there is a top level folder hierarchy designed as such:
+=== Creating a dashboard ===
-* Telemetry (where telemetry dashboards should be stored)
+Now - before you get started please note that <u>'''you have to save your changes!! They do not save automatically!'''</u>
-Clicking the + icon will allow you to create a new dashboard. When you do this a new panel is started for you. This panel can be resized at the lower-right corner, and moved around by dragging once more panels are added.
+Click "Graph" to make this a graph panel. Click the graph title and then Edit to edit this specific graph.
-Now - before you get started please note that you have to save your changes!! They do not save automatically!
+[[File:Grafana panel edit.png|frameless|600x600px]]
-Click "Graph" to make this a graph panel. Click the graph title and then Edit to edit this specific graph. A few things you will want to edit:
+A few things you will want to edit:
 ==== General ====
@@ Line 25: / Line 28: @@
 ==== Metrics ====
-First, select the data source. While the "default" data source should always be assumed to point to the SatNOGS data warehouse, it never hurts to be explicit about it.
+[[File:Grafana select measurement.png|frameless|600x600px]]
-[[File:grafanametric.png|800px]]
+In most cases you will want to leave the WHERE clause blank, but from here you can also filter data based on the tag that the data has (such as filtering on a specific observer).
-Next, select the metric, by clicking "select measurement". What you will see here are the names of all measurements available. This is bound to get messy as we grow, so you will need to rely on schema documentation for the satellite you are working on. NOTE: underscores in variable names from kaitai may be truncated. You can type part of the variable name for suggestions.
+[[File:Grafana filter tag.png|frameless|600x600px]]
-TODO: the kaitai schemas are not available to users today (they aren't exposed in the db ui yet), but are available in the admin console under "telemetries". In the meantime, if you are working on a dashboard and want a copy of the schema ping an admin.
+Next, select the telemetry field you are looking to graph by clicking on field("value"). If there is data in the database that has been properly decoded you should see the relevant fields for that satellite displayed here:
-After "WHERE" you can add conditions based on tags. The most important here will be "norad" to identify the satellite. NOTE: multiple satellites may share the same measurement variable names, so this will be important! "Select tag value" will give you options to pick from based on what is in the database today.
+[[File:Grafana field value.png|frameless|600x600px]]
-No data yet? Change your timeframe to something like "last 30 days" as the default of "last 6 hours" may not have data decoded (especially true for our dev instance, where we have no steady stream of recent data)
+See any data in your graph yet? If not, change your timeframe in the upper-right corner to something like "last 30 days" as the default of "last 6 hours" may not have data decoded (especially true for our dev instance, where we have no steady stream of recent data)
-[[File:grafanamath.png|700px]]
+SELECT: mean() (default), distinct(), and last() are likely to be the most useful for us. Keep in mind that there is the possibility for multiple data points from multiple stations and observations, some overlapping. InfluxDB handles this for us. The timeframe selected is also taken into account in these measurements. This line is where you may need to add math to make the number human-readable. For instance, for CubeBel-1, to calculate voltage we have to take (Measured value) / 4096×2.5×3.75, which looks like this:
-SELECT: mean() (default) and last() are likely to be the most useful for us. Keep in mind that there is the possibility for multiple data points from multiple stations and observations, some overlapping. InfluxDB handles this for us. The timeframe selected is also taken into account in these measurements. This line is where you may need to add math to make the number human-readable. For instance, in the docs for CAS-4, to calculate voltage we have to take 6×(3.3/255)×(Measured value), which looks like this:
+[[File:Grafana math.png|frameless|900x900px]]
 GROUP BY:  you may wish to change the fill value here, there are a number of options. Be careful as this may be misleading to users if we are dealing with very sparse data sets, as this option will fill in any gaps, yet "none" or "linear" may be options to use to make the graphs look better.

@@ Line 50: / Line 50: @@
 You may want to change the Unit here, as "Short" may be undesired for certain figures, and "None" would be better.
-==== Display =====
+==== Display ====
 If you are doing a line graph and do not want the shading below the line, change the "Fill" value here to 0.