@intentius/chant-lexicon-grafana 0.96.0

package/src/schema/gauge.gen.ts

@@ -0,0 +1,64 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/gauge.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Options {
+  showThresholdLabels: boolean;
+  showThresholdMarkers: boolean;
+  sizing: BarGaugeSizing;
+  minVizWidth: number;
+  reduceOptions: ReduceDataOptions;
+  text?: VizTextDisplayOptions;
+  minVizHeight: number;
+  orientation: VizOrientation;
+}
+
+/**
+ * Allows for the bar gauge size to be set explicitly
+ */
+export type BarGaugeSizing = "auto" | "manual";
+
+/**
+ * TODO docs
+ */
+export interface ReduceDataOptions {
+  /**
+   * If true show each row value
+   */
+  values?: boolean;
+  /**
+   * if showing all values limit
+   */
+  limit?: number;
+  /**
+   * When !values, pick one value for the whole field
+   */
+  calcs: string[];
+  /**
+   * Which fields to show.  By default this is only numeric fields
+   */
+  fields?: string;
+}
+
+/**
+ * TODO docs
+ */
+export interface VizTextDisplayOptions {
+  /**
+   * Explicit title text size
+   */
+  titleSize?: number;
+  /**
+   * Explicit value text size
+   */
+  valueSize?: number;
+  /**
+   * Explicit percent text size
+   */
+  percentSize?: number;
+}
+
+/**
+ * TODO docs
+ */
+export type VizOrientation = "auto" | "vertical" | "horizontal";

package/src/schema/heatmap.gen.ts

@@ -0,0 +1,321 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/heatmap.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+/**
+ * Controls the color mode of the heatmap
+ */
+export type HeatmapColorMode = "opacity" | "scheme";
+
+/**
+ * Controls the color scale of the heatmap
+ */
+export type HeatmapColorScale = "linear" | "exponential";
+
+/**
+ * Controls which axis to allow selection on
+ */
+export type HeatmapSelectionMode = "x" | "y" | "xy";
+
+/**
+ * Controls various color options
+ */
+export interface HeatmapColorOptions {
+  /**
+   * Sets the color mode
+   */
+  mode?: HeatmapColorMode;
+  /**
+   * Controls the color scheme used
+   */
+  scheme: string;
+  /**
+   * Controls the color fill when in opacity mode
+   */
+  fill: string;
+  /**
+   * Controls the color scale
+   */
+  scale?: HeatmapColorScale;
+  /**
+   * Controls the exponent when scale is set to exponential
+   */
+  exponent: number;
+  /**
+   * Controls the number of color steps
+   */
+  steps: number;
+  /**
+   * Reverses the color scheme
+   */
+  reverse: boolean;
+  /**
+   * Sets the minimum value for the color scale
+   */
+  min?: number;
+  /**
+   * Sets the maximum value for the color scale
+   */
+  max?: number;
+}
+
+/**
+ * Configuration options for the yAxis
+ */
+export interface YAxisConfig {
+  /**
+   * Sets the yAxis unit
+   */
+  unit?: string;
+  /**
+   * Reverses the yAxis
+   */
+  reverse?: boolean;
+  /**
+   * Controls the number of decimals for yAxis values
+   */
+  decimals?: number;
+  /**
+   * Sets the minimum value for the yAxis
+   */
+  min?: number;
+  axisPlacement?: AxisPlacement;
+  axisColorMode?: AxisColorMode;
+  axisLabel?: string;
+  axisWidth?: number;
+  axisSoftMin?: number;
+  axisSoftMax?: number;
+  axisGridShow?: boolean;
+  scaleDistribution?: ScaleDistributionConfig;
+  axisCenteredZero?: boolean;
+  /**
+   * Sets the maximum value for the yAxis
+   */
+  max?: number;
+  axisBorderShow?: boolean;
+}
+
+/**
+ * Controls cell value options
+ */
+export interface CellValues {
+  /**
+   * Controls the cell value unit
+   */
+  unit?: string;
+  /**
+   * Controls the number of decimals for cell values
+   */
+  decimals?: number;
+}
+
+/**
+ * Controls the value filter range
+ */
+export interface FilterValueRange {
+  /**
+   * Sets the filter range to values less than or equal to the given value
+   */
+  le?: number;
+  /**
+   * Sets the filter range to values greater than or equal to the given value
+   */
+  ge?: number;
+}
+
+/**
+ * Controls tooltip options
+ */
+export interface HeatmapTooltip {
+  /**
+   * Controls how the tooltip is shown
+   */
+  mode: TooltipDisplayMode;
+  maxHeight?: number;
+  maxWidth?: number;
+  /**
+   * Controls if the tooltip shows a histogram of the y-axis values
+   */
+  yHistogram?: boolean;
+  /**
+   * Controls if the tooltip shows a color scale in header
+   */
+  showColorScale?: boolean;
+}
+
+/**
+ * Controls legend options
+ */
+export interface HeatmapLegend {
+  /**
+   * Controls if the legend is shown
+   */
+  show: boolean;
+}
+
+/**
+ * Controls exemplar options
+ */
+export interface ExemplarConfig {
+  /**
+   * Sets the color of the exemplar markers
+   */
+  color: string;
+}
+
+/**
+ * Controls frame rows options
+ */
+export interface RowsHeatmapOptions {
+  /**
+   * Sets the name of the cell when not calculating from data
+   */
+  value?: string;
+  /**
+   * Controls tick alignment when not calculating from data
+   */
+  layout?: HeatmapCellLayout;
+}
+
+export interface Options {
+  /**
+   * Controls if the heatmap should be calculated from data
+   */
+  calculate?: boolean;
+  /**
+   * Calculation options for the heatmap
+   */
+  calculation?: HeatmapCalculationOptions;
+  /**
+   * Controls the color options
+   */
+  color: HeatmapColorOptions;
+  /**
+   * Filters values between a given range
+   */
+  filterValues?: FilterValueRange;
+  /**
+   * Controls tick alignment and value name when not calculating from data
+   */
+  rowsFrame?: RowsHeatmapOptions;
+  /**
+   * | *{
+   * 	layout: ui.HeatmapCellLayout & "auto" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
+   * }
+   * Controls the display of the value in the cell
+   */
+  showValue: VisibilityMode;
+  /**
+   * Controls gap between cells
+   */
+  cellGap?: number;
+  /**
+   * Controls cell radius
+   */
+  cellRadius?: number;
+  /**
+   * Controls cell value unit
+   */
+  cellValues?: CellValues;
+  /**
+   * Controls yAxis placement
+   */
+  yAxis: YAxisConfig;
+  /**
+   * | *{
+   * 	axisPlacement: ui.AxisPlacement & "left" // TODO: fix after remove when https://github.com/grafana/cuetsy/issues/74 is fixed
+   * }
+   * Controls legend options
+   */
+  legend: HeatmapLegend;
+  /**
+   * Controls tooltip options
+   */
+  tooltip: HeatmapTooltip;
+  /**
+   * Controls exemplar options
+   */
+  exemplars: ExemplarConfig;
+  /**
+   * Controls which axis to allow selection on
+   */
+  selectionMode?: HeatmapSelectionMode;
+}
+
+export interface FieldConfig {
+  scaleDistribution?: ScaleDistributionConfig;
+  hideFrom?: HideSeriesConfig;
+}
+
+/**
+ * TODO docs
+ */
+export type AxisPlacement = "auto" | "top" | "right" | "bottom" | "left" | "hidden";
+
+/**
+ * TODO docs
+ */
+export type AxisColorMode = "text" | "series";
+
+/**
+ * TODO docs
+ */
+export interface ScaleDistributionConfig {
+  type: ScaleDistribution;
+  log?: number;
+  linearThreshold?: number;
+}
+
+/**
+ * TODO docs
+ */
+export type TooltipDisplayMode = "single" | "multi" | "none";
+
+export type HeatmapCellLayout = "le" | "ge" | "unknown" | "auto";
+
+export interface HeatmapCalculationOptions {
+  /**
+   * The number of buckets to use for the xAxis in the heatmap
+   */
+  xBuckets?: HeatmapCalculationBucketConfig;
+  /**
+   * The number of buckets to use for the yAxis in the heatmap
+   */
+  yBuckets?: HeatmapCalculationBucketConfig;
+}
+
+/**
+ * TODO docs
+ */
+export type VisibilityMode = "auto" | "never" | "always";
+
+/**
+ * TODO docs
+ */
+export interface HideSeriesConfig {
+  tooltip: boolean;
+  legend: boolean;
+  viz: boolean;
+}
+
+/**
+ * TODO docs
+ */
+export type ScaleDistribution = "linear" | "log" | "ordinal" | "symlog";
+
+export interface HeatmapCalculationBucketConfig {
+  /**
+   * Sets the bucket calculation mode
+   */
+  mode?: HeatmapCalculationMode;
+  /**
+   * The number of buckets to use for the axis in the heatmap
+   */
+  value?: string;
+  /**
+   * Controls the scale of the buckets
+   */
+  scale?: ScaleDistributionConfig;
+}
+
+export type HeatmapCalculationMode = "size" | "count";

package/src/schema/index.ts

@@ -0,0 +1,17 @@
+/**
+ * The generated Grafana schema types, one namespace per vendored schema.
+ * `schema.stat.Options` is the stat panel's options exactly as Grafana's
+ * schema at `GRAFANA_SCHEMA_PIN` spells them.
+ */
+export * as dashboard from "./dashboard.gen";
+export * as timeseries from "./timeseries.gen";
+export * as stat from "./stat.gen";
+export * as gauge from "./gauge.gen";
+export * as table from "./table.gen";
+export * as logs from "./logs.gen";
+export * as heatmap from "./heatmap.gen";
+export * as text from "./text.gen";
+export * as prometheus from "./prometheus.gen";
+export * as tempo from "./tempo.gen";
+export * as loki from "./loki.gen";
+export { DASHBOARD_SCHEMA_VERSION } from "./dashboard.gen";

package/src/schema/logs.gen.ts

@@ -0,0 +1,34 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/logs.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Options {
+  showLabels: boolean;
+  showCommonLabels: boolean;
+  showTime: boolean;
+  showLogContextToggle: boolean;
+  wrapLogMessage: boolean;
+  prettifyLogMessage: boolean;
+  enableLogDetails: boolean;
+  sortOrder: LogsSortOrder;
+  dedupStrategy: LogsDedupStrategy;
+  enableInfiniteScrolling?: boolean;
+  /**
+   * Display controls to jump to the last or first log line, and filters by log level.
+   */
+  showControls?: boolean;
+  /**
+   * Show a component to manage the displayed fields from the logs.
+   */
+  showFieldSelector?: boolean;
+  /**
+   * Use a predefined coloring scheme to highlight relevant parts of the log lines.
+   */
+  syntaxHighlighting?: boolean;
+  fontSize?: "default" | "small";
+  detailsMode?: "inline" | "sidebar";
+}
+
+export type LogsSortOrder = "Descending" | "Ascending";
+
+export type LogsDedupStrategy = "none" | "exact" | "numbers" | "signature";

package/src/schema/loki.gen.ts

@@ -0,0 +1,77 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/loki.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export type QueryEditorMode = "code" | "builder";
+
+export type LokiQueryType = "range" | "instant" | "stream";
+
+export type SupportingQueryType = "logsVolume" | "logsSample" | "dataSample" | "infiniteScroll";
+
+export type LokiQueryDirection = "forward" | "backward" | "scan";
+
+export interface Dataquery {
+  /**
+   * The LogQL query.
+   */
+  expr: string;
+  /**
+   * Used to override the name of the series.
+   */
+  legendFormat?: string;
+  /**
+   * Used to limit the number of log rows returned.
+   */
+  maxLines?: number;
+  /**
+   * @deprecated, now use step.
+   */
+  resolution?: number;
+  editorMode?: QueryEditorMode;
+  /**
+   * @deprecated, now use queryType.
+   */
+  range?: boolean;
+  /**
+   * @deprecated, now use queryType.
+   */
+  instant?: boolean;
+  /**
+   * Used to set step value for range queries.
+   */
+  step?: string;
+  /**
+   * A unique identifier for the query within the list of targets.
+   * In server side expressions, the refId is used as a variable name to identify results.
+   * By default, the UI will assign A->Z; however setting meaningful names may be useful.
+   */
+  refId?: string | null;
+  /**
+   * If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
+   */
+  hide?: boolean;
+  /**
+   * Specify the query flavor
+   * TODO make this required and give it a default
+   */
+  queryType?: string;
+  /**
+   * For mixed data sources the selected datasource is on the query level.
+   * For non mixed scenarios this is undefined.
+   * TODO find a better way to do this ^ that's friendly to schema
+   * TODO this shouldn't be unknown but DataSourceRef | null
+   */
+  datasource?: DataSourceRef;
+  direction?: LokiQueryDirection;
+}
+
+export interface DataSourceRef {
+  /**
+   * The plugin type-id
+   */
+  type?: string;
+  /**
+   * Specific datasource instance
+   */
+  uid?: string;
+}

package/src/schema/prometheus.gen.ts

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