@intentius/chant-lexicon-grafana 0.96.0

package/src/spec/schemas/loki.jsonschema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/dataquery",
+  "definitions": {
+    "QueryEditorMode": {
+      "enum": [
+        "code",
+        "builder"
+      ],
+      "type": "string"
+    },
+    "LokiQueryType": {
+      "enum": [
+        "range",
+        "instant",
+        "stream"
+      ],
+      "type": "string"
+    },
+    "SupportingQueryType": {
+      "enum": [
+        "logsVolume",
+        "logsSample",
+        "dataSample",
+        "infiniteScroll"
+      ],
+      "type": "string"
+    },
+    "LokiQueryDirection": {
+      "enum": [
+        "forward",
+        "backward",
+        "scan"
+      ],
+      "type": "string"
+    },
+    "dataquery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "expr"
+      ],
+      "properties": {
+        "expr": {
+          "type": "string",
+          "description": "The LogQL query."
+        },
+        "legendFormat": {
+          "type": "string",
+          "description": "Used to override the name of the series."
+        },
+        "maxLines": {
+          "type": "integer",
+          "description": "Used to limit the number of log rows returned."
+        },
+        "resolution": {
+          "type": "integer",
+          "description": "@deprecated, now use step."
+        },
+        "editorMode": {
+          "$ref": "#/definitions/QueryEditorMode"
+        },
+        "range": {
+          "type": "boolean",
+          "description": "@deprecated, now use queryType."
+        },
+        "instant": {
+          "type": "boolean",
+          "description": "@deprecated, now use queryType."
+        },
+        "step": {
+          "type": "string",
+          "description": "Used to set step value for range queries."
+        },
+        "refId": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "A unique identifier for the query within the list of targets.\nIn server side expressions, the refId is used as a variable name to identify results.\nBy default, the UI will assign A-\u003eZ; however setting meaningful names may be useful."
+        },
+        "hide": {
+          "type": "boolean",
+          "description": "If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel."
+        },
+        "queryType": {
+          "type": "string",
+          "description": "Specify the query flavor\nTODO make this required and give it a default"
+        },
+        "datasource": {
+          "$ref": "#/definitions/DataSourceRef",
+          "description": "For mixed data sources the selected datasource is on the query level.\nFor non mixed scenarios this is undefined.\nTODO find a better way to do this ^ that's friendly to schema\nTODO this shouldn't be unknown but DataSourceRef | null"
+        },
+        "direction": {
+          "$ref": "#/definitions/LokiQueryDirection"
+        }
+      }
+    },
+    "DataSourceRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The plugin type-id"
+        },
+        "uid": {
+          "type": "string",
+          "description": "Specific datasource instance"
+        }
+      }
+    }
+  }
+}

package/src/spec/schemas/prometheus.jsonschema.json

@@ -0,0 +1,276 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Dataquery",
+  "definitions": {
+    "AdhocFilters": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "operator",
+        "value"
+      ],
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "operator": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "values": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "ResultAssertions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "typeVersion"
+      ],
+      "properties": {
+        "maxFrames": {
+          "type": "integer",
+          "description": "Maximum frame count"
+        },
+        "type": {
+          "$ref": "#/definitions/ResultAssertionsType",
+          "description": "Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `\"\"` \n - `\"timeseries-wide\"` \n - `\"timeseries-long\"` \n - `\"timeseries-many\"` \n - `\"timeseries-multi\"` \n - `\"directory-listing\"` \n - `\"table\"` \n - `\"numeric-wide\"` \n - `\"numeric-multi\"` \n - `\"numeric-long\"` \n - `\"log-lines\"` "
+        },
+        "typeVersion": {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          },
+          "description": "TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/."
+        }
+      }
+    },
+    "ScopesFilters": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "key",
+        "operator",
+        "value"
+      ],
+      "properties": {
+        "key": {
+          "type": "string"
+        },
+        "operator": {
+          "type": "string"
+        },
+        "value": {
+          "type": "string"
+        },
+        "values": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "Scopes": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "title"
+      ],
+      "properties": {
+        "defaultPath": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "filters": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ScopesFilters"
+          }
+        },
+        "title": {
+          "type": "string"
+        }
+      }
+    },
+    "TimeRange": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "from",
+        "to"
+      ],
+      "properties": {
+        "from": {
+          "type": "string",
+          "description": "From is the start time of the query.",
+          "default": "now-6h"
+        },
+        "to": {
+          "type": "string",
+          "description": "To is the end time of the query.",
+          "default": "now"
+        }
+      }
+    },
+    "Dataquery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "expr"
+      ],
+      "properties": {
+        "adhocFilters": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AdhocFilters"
+          },
+          "description": "Additional Ad-hoc filters that take precedence over Scope on conflict."
+        },
+        "datasource": {
+          "$ref": "#/definitions/DataSourceRef",
+          "description": "The datasource"
+        },
+        "editorMode": {
+          "$ref": "#/definitions/QueryEditorMode",
+          "description": "what we should show in the editor\nPossible enum values:\n - `\"builder\"` \n - `\"code\"` "
+        },
+        "exemplar": {
+          "type": "boolean",
+          "description": "Execute an additional query to identify interesting raw samples relevant for the given expr"
+        },
+        "expr": {
+          "type": "string",
+          "description": "The actual expression/query that will be evaluated by Prometheus"
+        },
+        "format": {
+          "$ref": "#/definitions/PromQueryFormat",
+          "description": "The response format\nPossible enum values:\n - `\"time_series\"` \n - `\"table\"` \n - `\"heatmap\"` "
+        },
+        "groupByKeys": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Group By parameters to apply to aggregate expressions in the query"
+        },
+        "hide": {
+          "type": "boolean",
+          "description": "true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)"
+        },
+        "instant": {
+          "type": "boolean",
+          "description": "Returns only the latest value that Prometheus has scraped for the requested time series"
+        },
+        "intervalFactor": {
+          "type": "integer",
+          "description": "Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081\nDeprecated: use interval"
+        },
+        "intervalMs": {
+          "type": "number",
+          "description": "Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model.  It is typically calculated\nfrom the interval required to fill a pixels in the visualization"
+        },
+        "legendFormat": {
+          "type": "string",
+          "description": "Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname"
+        },
+        "maxDataPoints": {
+          "type": "integer",
+          "description": "MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model.  It is typically calculated\nfrom the number of pixels visible in a visualization"
+        },
+        "queryType": {
+          "type": "string",
+          "description": "QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries."
+        },
+        "range": {
+          "type": "boolean",
+          "description": "Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series"
+        },
+        "refId": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "RefID is the unique identifier of the query, set by the frontend call."
+        },
+        "resultAssertions": {
+          "$ref": "#/definitions/ResultAssertions",
+          "description": "Optionally define expected query result behavior"
+        },
+        "scopes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Scopes"
+          },
+          "description": "A set of filters applied to apply to the query"
+        },
+        "timeRange": {
+          "$ref": "#/definitions/TimeRange",
+          "description": "TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly"
+        },
+        "interval": {
+          "type": "string",
+          "description": "An additional lower limit for the step parameter of the Prometheus query and for the\n`$__interval` and `$__rate_interval` variables."
+        }
+      }
+    },
+    "ResultAssertionsType": {
+      "enum": [
+        "",
+        "timeseries-wide",
+        "timeseries-long",
+        "timeseries-many",
+        "timeseries-multi",
+        "directory-listing",
+        "table",
+        "numeric-wide",
+        "numeric-multi",
+        "numeric-long",
+        "log-lines"
+      ],
+      "type": "string"
+    },
+    "QueryEditorMode": {
+      "enum": [
+        "builder",
+        "code"
+      ],
+      "type": "string"
+    },
+    "PromQueryFormat": {
+      "enum": [
+        "time_series",
+        "table",
+        "heatmap"
+      ],
+      "type": "string"
+    },
+    "DataSourceRef": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The plugin type-id"
+        },
+        "uid": {
+          "type": "string",
+          "description": "Specific datasource instance"
+        }
+      }
+    }
+  }
+}

package/src/spec/schemas/stat.jsonschema.json

@@ -0,0 +1,163 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "Options": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "graphMode",
+        "colorMode",
+        "justifyMode",
+        "textMode",
+        "wideLayout",
+        "showPercentChange",
+        "reduceOptions",
+        "percentChangeColorMode",
+        "orientation"
+      ],
+      "properties": {
+        "graphMode": {
+          "$ref": "#/definitions/BigValueGraphMode",
+          "default": "area"
+        },
+        "colorMode": {
+          "$ref": "#/definitions/BigValueColorMode",
+          "default": "value"
+        },
+        "justifyMode": {
+          "$ref": "#/definitions/BigValueJustifyMode",
+          "default": "auto"
+        },
+        "textMode": {
+          "$ref": "#/definitions/BigValueTextMode",
+          "default": "auto"
+        },
+        "wideLayout": {
+          "type": "boolean",
+          "default": true
+        },
+        "showPercentChange": {
+          "type": "boolean",
+          "default": false
+        },
+        "reduceOptions": {
+          "$ref": "#/definitions/ReduceDataOptions"
+        },
+        "text": {
+          "$ref": "#/definitions/VizTextDisplayOptions"
+        },
+        "percentChangeColorMode": {
+          "$ref": "#/definitions/PercentChangeColorMode",
+          "default": "standard"
+        },
+        "orientation": {
+          "$ref": "#/definitions/VizOrientation"
+        }
+      }
+    },
+    "BigValueGraphMode": {
+      "enum": [
+        "none",
+        "line",
+        "area"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "BigValueColorMode": {
+      "enum": [
+        "value",
+        "background",
+        "background_solid",
+        "none"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "BigValueJustifyMode": {
+      "enum": [
+        "auto",
+        "center"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "BigValueTextMode": {
+      "enum": [
+        "auto",
+        "value",
+        "value_and_name",
+        "name",
+        "none"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "ReduceDataOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "calcs"
+      ],
+      "properties": {
+        "values": {
+          "type": "boolean",
+          "description": "If true show each row value"
+        },
+        "limit": {
+          "type": "number",
+          "description": "if showing all values limit"
+        },
+        "calcs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "When !values, pick one value for the whole field"
+        },
+        "fields": {
+          "type": "string",
+          "description": "Which fields to show.  By default this is only numeric fields"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "VizTextDisplayOptions": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "titleSize": {
+          "type": "number",
+          "description": "Explicit title text size"
+        },
+        "valueSize": {
+          "type": "number",
+          "description": "Explicit value text size"
+        },
+        "percentSize": {
+          "type": "number",
+          "description": "Explicit percent text size"
+        }
+      },
+      "description": "TODO docs"
+    },
+    "PercentChangeColorMode": {
+      "enum": [
+        "standard",
+        "inverted",
+        "same_as_value"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    },
+    "VizOrientation": {
+      "enum": [
+        "auto",
+        "vertical",
+        "horizontal"
+      ],
+      "type": "string",
+      "description": "TODO docs"
+    }
+  }
+}