Generate jsonnet from json #3

malcolmholmes · 2020-09-07T12:45:18Z

This is a first pass at generating Jsonnet from a dashboard JSON. It proves the theory. Now it is just a question of working through the remaining issues.

Noted issues include:

Dashboard alerts not in the spec
targets in spec are prometheus specific, needs fixing
axes (xaxis, yaxis, yaxes) need implementing
timepicker needs implementing
templating needs implementing
annotations need to be wrapped in a list element.

malcolmholmes · 2020-09-07T12:46:27Z

To use this, download a dashboard JSON to sample.json then:

$ make bundle
$ go build .
$ ./dashboard-spec instance 7.0 jsonnet sample.json

malcolmholmes · 2020-09-07T12:47:39Z

Once the above issues are resolved, a useful test would be to automatically pull a load of dashboards from an active Grafana instance, convert them to Jsonnet, execute the Jsonnet, then diff the original and generated JSON. The differences should only be expected ones.

trotttrotttrott

Took a first pass.

specs/7.0/Dashboard.yml

trotttrotttrott · 2020-09-15T02:21:09Z

specs/7.0/panels/Gauge.yml

-      $ref: '_threshold.yml#/threshold'
+      $ref: '_thresholds.yml#/thresholds'


Appropriate change, but again could you please move this to a separate pull request?

trotttrotttrott · 2020-09-15T03:18:28Z

spec.go

@@ -49,6 +52,78 @@ func (s Schema) DefaultJSON() string {
 	return string(b)
 }

+// IsDefault checks if the value matches the schema's default value
+func (s Schema) IsDefault(value interface{}, name string) (bool, error) {


I think we should get rid of this. Seems to me we can simplify a lot by explicitly setting the value regardless if it's the default or not. We could then do away with TopLevelSimpleNonDefaultProperties and drop the added argument on the filter function.

trotttrotttrott · 2020-09-15T03:36:17Z

spec.go

@@ -108,31 +211,56 @@ func (s Schema) TopLevelObjectProperties() map[string]*Schema {
 	return p
 }

-// Returns all nested properties except arrays of objects. It's anticipated
+// TopLevelArrayProperties returns all top-level array properties.
+func (s Schema) TopLevelArrayProperties() map[string]*Schema {


Why do we need this?

trotttrotttrott · 2020-09-15T03:38:36Z

spec.go

+//NestedSimpleProperties Returns all nested properties except arrays of objects. It's anticipated
 // that the parent schema object is a top-level object property and that the
 // properties returned here will be arguments in the parent's setter method.


Suggested change

//NestedSimpleProperties Returns all nested properties except arrays of objects. It's anticipated

// that the parent schema object is a top-level object property and that the

// properties returned here will be arguments in the parent's setter method.

// NestedSimpleProperties returns all nested properties except arrays of

// objects. It's anticipated that the parent schema object is a top-level

// object property and that the properties returned here will be arguments in

// the parent's setter method.

textwidth=80

trotttrotttrott · 2020-09-15T03:56:03Z

instance.go

+		return err
+	}
+
+	outFile := strings.ReplaceAll(instanceFile, ".json", "") + ".libsonnet"


Would like to keep the Go code language agnostic.

trotttrotttrott · 2020-09-15T03:58:45Z

instance.go

+			"toKey": func(s string) string {
+				return inflect.CamelizeDownFirst(s)
+			},
+			"toCamel": func(s string) string {
+				return inflect.Camelize(s)
+			},


Can't we use objectInflection where this might be used?

CLAassistant · 2022-06-15T17:54:24Z

All committers have signed the CLA.

malcolmholmes added 5 commits September 7, 2020 13:36

Put templates for building libraries into a dir

e9dbe34

Fixes to specs

6ce0276

Templates for dashboard instances

3049636

Ignore binary

8683980

Support for instance generation as well as libraries

1989134

malcolmholmes requested a review from trotttrotttrott September 7, 2020 12:45

Change CLI signature in drone

3b18b2c

malcolmholmes marked this pull request as draft September 7, 2020 13:21

Add Grafana alerts to spec

b848b95

trotttrotttrott reviewed Sep 15, 2020

View reviewed changes

trotttrotttrott force-pushed the master branch from 595fe9b to 9f97df7 Compare October 5, 2020 21:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate jsonnet from json #3

Generate jsonnet from json #3

malcolmholmes commented Sep 7, 2020

malcolmholmes commented Sep 7, 2020

malcolmholmes commented Sep 7, 2020

trotttrotttrott left a comment

trotttrotttrott Sep 15, 2020

trotttrotttrott Sep 15, 2020

trotttrotttrott Sep 15, 2020

trotttrotttrott Sep 15, 2020

trotttrotttrott Sep 15, 2020

trotttrotttrott Sep 15, 2020

CLAassistant commented Jun 15, 2022 •

edited

		$ref: '_threshold.yml#/threshold'
		$ref: '_thresholds.yml#/thresholds'

-//NestedSimpleProperties Returns all nested properties except arrays of objects. It's anticipated
-// that the parent schema object is a top-level object property and that the
-// properties returned here will be arguments in the parent's setter method.
+// NestedSimpleProperties returns all nested properties except arrays of
+// objects. It's anticipated that the parent schema object is a top-level
+// object property and that the properties returned here will be arguments in
+// the parent's setter method.

Generate jsonnet from json #3

Are you sure you want to change the base?

Generate jsonnet from json #3

Conversation

malcolmholmes commented Sep 7, 2020

malcolmholmes commented Sep 7, 2020

malcolmholmes commented Sep 7, 2020

trotttrotttrott left a comment

Choose a reason for hiding this comment

trotttrotttrott Sep 15, 2020

Choose a reason for hiding this comment

trotttrotttrott Sep 15, 2020

Choose a reason for hiding this comment

trotttrotttrott Sep 15, 2020

Choose a reason for hiding this comment

trotttrotttrott Sep 15, 2020

Choose a reason for hiding this comment

trotttrotttrott Sep 15, 2020

Choose a reason for hiding this comment

trotttrotttrott Sep 15, 2020

Choose a reason for hiding this comment

CLAassistant commented Jun 15, 2022 • edited

CLAassistant commented Jun 15, 2022 •

edited