@intentius/chant-lexicon-grafana 0.98.0 → 0.100.0

package/src/schema/geomap.gen.ts

@@ -0,0 +1,112 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/geomap.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Options {
+  view: MapViewConfig;
+  controls: ControlsOptions;
+  basemap: MapLayerOptions;
+  layers: MapLayerOptions[];
+  tooltip: TooltipOptions;
+}
+
+export interface MapViewConfig {
+  id: string;
+  lat?: number;
+  lon?: number;
+  zoom?: number;
+  minZoom?: number;
+  maxZoom?: number;
+  padding?: number;
+  allLayers?: boolean;
+  lastOnly?: boolean;
+  layer?: string;
+  shared?: boolean;
+  noRepeat?: boolean;
+  dashboardVariable?: boolean;
+  dashboardVariableName?: string;
+}
+
+export interface ControlsOptions {
+  /**
+   * Zoom (upper left)
+   */
+  showZoom?: boolean;
+  /**
+   * let the mouse wheel zoom
+   */
+  mouseWheelZoom?: boolean;
+  /**
+   * Lower right
+   */
+  showAttribution?: boolean;
+  /**
+   * Scale options
+   */
+  showScale?: boolean;
+  /**
+   * Show debug
+   */
+  showDebug?: boolean;
+  /**
+   * Show measure
+   */
+  showMeasure?: boolean;
+}
+
+export interface TooltipOptions {
+  mode: TooltipMode;
+}
+
+export type TooltipMode = "none" | "details";
+
+export type MapCenterID = "zero" | "coords" | "fit";
+
+export interface MapLayerOptions {
+  type: string;
+  /**
+   * configured unique display name
+   */
+  name: string;
+  /**
+   * Custom options depending on the type
+   */
+  config?: Record<string, unknown>;
+  /**
+   * Common method to define geometry fields
+   */
+  location?: FrameGeometrySource;
+  /**
+   * Defines a frame MatcherConfig that may filter data for the given layer
+   */
+  filterData?: Record<string, unknown>;
+  /**
+   * Common properties:
+   * https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html
+   * Layer opacity (0-1)
+   */
+  opacity?: number;
+  /**
+   * Check tooltip (defaults to true)
+   */
+  tooltip?: boolean;
+}
+
+export interface FrameGeometrySource {
+  mode: FrameGeometrySourceMode;
+  /**
+   * Field mappings
+   */
+  geohash?: string;
+  latitude?: string;
+  longitude?: string;
+  wkt?: string;
+  lookup?: string;
+  /**
+   * Path to Gazetteer
+   */
+  gazetteer?: string;
+}
+
+export type FrameGeometrySourceMode = "auto" | "geohash" | "coords" | "lookup";

package/src/schema/googlecloudmonitoring.gen.ts

@@ -0,0 +1,330 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/googlecloudmonitoring.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface CloudMonitoringQuery {
+  /**
+   * 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;
+  /**
+   * Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.
+   */
+  aliasBy?: string;
+  /**
+   * GCM query type.
+   * queryType: #QueryType
+   * Time Series List sub-query properties.
+   */
+  timeSeriesList?: TimeSeriesList;
+  /**
+   * Time Series sub-query properties.
+   */
+  timeSeriesQuery?: TimeSeriesQuery;
+  /**
+   * SLO sub-query properties.
+   */
+  sloQuery?: SLOQuery;
+  /**
+   * PromQL sub-query properties.
+   */
+  promQLQuery?: PromQLQuery;
+  /**
+   * 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;
+  /**
+   * Time interval in milliseconds.
+   */
+  intervalMs?: number;
+}
+
+/**
+ * Time Series List sub-query properties.
+ */
+export interface TimeSeriesList {
+  /**
+   * GCP project to execute the query against.
+   */
+  projectName: string;
+  /**
+   * Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.
+   */
+  crossSeriesReducer: string;
+  /**
+   * Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.
+   */
+  alignmentPeriod?: string;
+  /**
+   * Alignment function to be used. Defaults to ALIGN_MEAN.
+   */
+  perSeriesAligner?: string;
+  /**
+   * Array of labels to group data by.
+   */
+  groupBys?: string[];
+  /**
+   * Array of filters to query data by. Labels that can be filtered on are defined by the metric.
+   */
+  filters?: string[];
+  /**
+   * Data view, defaults to FULL.
+   */
+  view?: string;
+  /**
+   * Annotation title.
+   */
+  title?: string;
+  /**
+   * Annotation text.
+   */
+  text?: string;
+  /**
+   * Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.
+   */
+  secondaryCrossSeriesReducer?: string;
+  /**
+   * Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.
+   */
+  secondaryAlignmentPeriod?: string;
+  /**
+   * Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN.
+   */
+  secondaryPerSeriesAligner?: string;
+  /**
+   * Only present if a preprocessor is selected. Array of labels to group data by.
+   */
+  secondaryGroupBys?: string[];
+  /**
+   * Preprocessor is not part of the API, but is used to store the preprocessor and not affect the UI for the rest of parameters
+   */
+  preprocessor?: PreprocessorType;
+}
+
+/**
+ * Types of pre-processor available. Defined by the metric.
+ */
+export type PreprocessorType = "none" | "rate" | "delta";
+
+/**
+ * Time Series sub-query properties.
+ */
+export interface TimeSeriesQuery {
+  /**
+   * GCP project to execute the query against.
+   */
+  projectName: string;
+  /**
+   * MQL query to be executed.
+   */
+  query: string;
+  /**
+   * To disable the graphPeriod, it should explictly be set to 'disabled'.
+   */
+  graphPeriod?: string;
+}
+
+/**
+ * SLO sub-query properties.
+ */
+export interface SLOQuery {
+  /**
+   * GCP project to execute the query against.
+   */
+  projectName: string;
+  /**
+   * Alignment function to be used. Defaults to ALIGN_MEAN.
+   */
+  perSeriesAligner?: string;
+  /**
+   * Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.
+   */
+  alignmentPeriod?: string;
+  /**
+   * SLO selector.
+   */
+  selectorName: string;
+  /**
+   * ID for the service the SLO is in.
+   */
+  serviceId: string;
+  /**
+   * Name for the service the SLO is in.
+   */
+  serviceName: string;
+  /**
+   * ID for the SLO.
+   */
+  sloId: string;
+  /**
+   * Name of the SLO.
+   */
+  sloName: string;
+  /**
+   * SLO goal value.
+   */
+  goal?: number;
+  /**
+   * Specific lookback period for the SLO.
+   */
+  lookbackPeriod?: string;
+}
+
+/**
+ * PromQL sub-query properties.
+ */
+export interface PromQLQuery {
+  /**
+   * GCP project to execute the query against.
+   */
+  projectName: string;
+  /**
+   * PromQL expression/query to be executed.
+   */
+  expr: string;
+  /**
+   * PromQL min step
+   */
+  step: string;
+}
+
+/**
+ * Defines the supported queryTypes.
+ */
+export type QueryType = "timeSeriesList" | "timeSeriesQuery" | "slo" | "annotation" | "promQL";
+
+/**
+ * @deprecated This type is for migration purposes only. Replaced by TimeSeriesList Metric sub-query properties.
+ */
+export interface MetricQuery {
+  /**
+   * GCP project to execute the query against.
+   */
+  projectName: string;
+  /**
+   * Alignment function to be used. Defaults to ALIGN_MEAN.
+   */
+  perSeriesAligner?: string;
+  /**
+   * Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.
+   */
+  alignmentPeriod?: string;
+  /**
+   * Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.
+   */
+  aliasBy?: string;
+  editorMode: string;
+  metricType: string;
+  /**
+   * Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.
+   */
+  crossSeriesReducer: string;
+  /**
+   * Array of labels to group data by.
+   */
+  groupBys?: string[];
+  /**
+   * Array of filters to query data by. Labels that can be filtered on are defined by the metric.
+   */
+  filters?: string[];
+  metricKind?: MetricKind;
+  valueType?: string;
+  view?: string;
+  /**
+   * MQL query to be executed.
+   */
+  query: string;
+  /**
+   * Preprocessor is not part of the API, but is used to store the preprocessor and not affect the UI for the rest of parameters
+   */
+  preprocessor?: PreprocessorType;
+  /**
+   * To disable the graphPeriod, it should explictly be set to 'disabled'.
+   */
+  graphPeriod?: string;
+}
+
+export type MetricKind = "METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE";
+
+export type ValueTypes = "VALUE_TYPE_UNSPECIFIED" | "BOOL" | "INT64" | "DOUBLE" | "STRING" | "DISTRIBUTION" | "MONEY";
+
+export type AlignmentTypes = "ALIGN_DELTA" | "ALIGN_RATE" | "ALIGN_INTERPOLATE" | "ALIGN_NEXT_OLDER" | "ALIGN_MIN" | "ALIGN_MAX" | "ALIGN_MEAN" | "ALIGN_COUNT" | "ALIGN_SUM" | "ALIGN_STDDEV" | "ALIGN_COUNT_TRUE" | "ALIGN_COUNT_FALSE" | "ALIGN_FRACTION_TRUE" | "ALIGN_PERCENTILE_99" | "ALIGN_PERCENTILE_95" | "ALIGN_PERCENTILE_50" | "ALIGN_PERCENTILE_05" | "ALIGN_PERCENT_CHANGE" | "ALIGN_NONE";
+
+/**
+ * @deprecated Use TimeSeriesList instead. Legacy annotation query properties for migration purposes.
+ */
+export interface LegacyCloudMonitoringAnnotationQuery {
+  /**
+   * GCP project to execute the query against.
+   */
+  projectName: string;
+  metricType: string;
+  /**
+   * Query refId.
+   */
+  refId: string;
+  /**
+   * Array of filters to query data by. Labels that can be filtered on are defined by the metric.
+   */
+  filters: string[];
+  metricKind: MetricKind;
+  valueType: string;
+  /**
+   * Annotation title.
+   */
+  title: string;
+  /**
+   * Annotation text.
+   */
+  text: string;
+}
+
+/**
+ * Query filter representation.
+ */
+export interface Filter {
+  /**
+   * Filter key.
+   */
+  key: string;
+  /**
+   * Filter operator.
+   */
+  operator: string;
+  /**
+   * Filter value.
+   */
+  value: string;
+  /**
+   * Filter condition.
+   */
+  condition?: string;
+}
+
+export type MetricFindQueryTypes = "projects" | "services" | "defaultProject" | "metricTypes" | "labelKeys" | "labelValues" | "resourceTypes" | "aggregations" | "aligners" | "alignmentPeriods" | "selectors" | "sloServices" | "slo";
+
+export interface DataSourceRef {
+  /**
+   * The plugin type-id
+   */
+  type?: string;
+  /**
+   * Specific datasource instance
+   */
+  uid?: string;
+}

package/src/schema/grafanapyroscope.gen.ts

@@ -0,0 +1,66 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/grafanapyroscope.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export type PyroscopeQueryType = "metrics" | "profile" | "both";
+
+export interface Dataquery {
+  /**
+   * Specifies the query label selectors.
+   */
+  labelSelector: string;
+  /**
+   * Specifies the query span selectors.
+   */
+  spanSelector?: string[];
+  /**
+   * Specifies the type of profile to query.
+   */
+  profileTypeId: string;
+  /**
+   * Allows to group the results.
+   */
+  groupBy: string[];
+  /**
+   * Sets the maximum number of time series.
+   */
+  limit?: number;
+  /**
+   * Sets the maximum number of nodes in the flamegraph.
+   */
+  maxNodes?: number;
+  /**
+   * 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;
+}
+
+export interface DataSourceRef {
+  /**
+   * The plugin type-id
+   */
+  type?: string;
+  /**
+   * Specific datasource instance
+   */
+  uid?: string;
+}

package/src/schema/heatmap.gen.ts

@@ -1,5 +1,6 @@
 // Code generated by chant generate from the vendored Grafana schema
-// src/spec/schemas/heatmap.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+// src/spec/schemas/heatmap.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
 /* eslint-disable */
 
 /**

package/src/schema/histogram.gen.ts

@@ -0,0 +1,151 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/histogram.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Options {
+  /**
+   * Bucket count (approx)
+   */
+  bucketCount?: number;
+  /**
+   * Size of each bucket
+   */
+  bucketSize?: number;
+  /**
+   * Offset buckets by this amount
+   */
+  bucketOffset?: number;
+  legend: VizLegendOptions;
+  tooltip: VizTooltipOptions;
+  /**
+   * Combines multiple series into a single histogram
+   */
+  combine?: boolean;
+}
+
+export interface FieldConfig {
+  /**
+   * Controls line width of the bars.
+   */
+  lineWidth?: number;
+  /**
+   * Controls the fill opacity of the bars.
+   */
+  fillOpacity?: number;
+  axisPlacement?: AxisPlacement;
+  axisColorMode?: AxisColorMode;
+  axisLabel?: string;
+  axisWidth?: number;
+  axisSoftMin?: number;
+  axisSoftMax?: number;
+  axisGridShow?: boolean;
+  scaleDistribution?: ScaleDistributionConfig;
+  axisCenteredZero?: boolean;
+  hideFrom?: HideSeriesConfig;
+  stacking?: StackingConfig;
+  /**
+   * Set the mode of the gradient fill. Fill gradient is based on the line color. To change the color, use the standard color scheme field option.
+   * Gradient appearance is influenced by the Fill opacity setting.
+   */
+  gradientMode?: GraphGradientMode;
+  axisBorderShow?: boolean;
+}
+
+/**
+ * TODO docs
+ */
+export interface VizLegendOptions {
+  displayMode: LegendDisplayMode;
+  placement: LegendPlacement;
+  showLegend: boolean;
+  asTable?: boolean;
+  isVisible?: boolean;
+  sortBy?: string;
+  sortDesc?: boolean;
+  width?: number;
+  calcs: string[];
+}
+
+/**
+ * TODO docs
+ */
+export interface VizTooltipOptions {
+  mode: TooltipDisplayMode;
+  sort: SortOrder;
+  maxWidth?: number;
+  maxHeight?: number;
+  hideZeros?: boolean;
+}
+
+/**
+ * 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 interface HideSeriesConfig {
+  tooltip: boolean;
+  legend: boolean;
+  viz: boolean;
+}
+
+/**
+ * TODO docs
+ */
+export interface StackingConfig {
+  mode?: StackingMode;
+  group?: string;
+}
+
+/**
+ * TODO docs
+ */
+export type GraphGradientMode = "none" | "opacity" | "hue" | "scheme";
+
+/**
+ * TODO docs
+ * Note: "hidden" needs to remain as an option for plugins compatibility
+ */
+export type LegendDisplayMode = "list" | "table" | "hidden";
+
+/**
+ * TODO docs
+ */
+export type LegendPlacement = "bottom" | "right";
+
+/**
+ * TODO docs
+ */
+export type TooltipDisplayMode = "single" | "multi" | "none";
+
+/**
+ * TODO docs
+ */
+export type SortOrder = "asc" | "desc" | "none";
+
+/**
+ * TODO docs
+ */
+export type ScaleDistribution = "linear" | "log" | "ordinal" | "symlog";
+
+/**
+ * TODO docs
+ */
+export type StackingMode = "none" | "normal" | "percent";

package/src/schema/index.ts

@@ -11,7 +11,25 @@ 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 barchart from "./barchart.gen";
+export * as bargauge from "./bargauge.gen";
+export * as piechart from "./piechart.gen";
+export * as statetimeline from "./statetimeline.gen";
+export * as statushistory from "./statushistory.gen";
+export * as histogram from "./histogram.gen";
+export * as nodegraph from "./nodegraph.gen";
+export * as xychart from "./xychart.gen";
+export * as trend from "./trend.gen";
+export * as canvas from "./canvas.gen";
+export * as geomap from "./geomap.gen";
 export * as prometheus from "./prometheus.gen";
 export * as tempo from "./tempo.gen";
 export * as loki from "./loki.gen";
+export * as elasticsearch from "./elasticsearch.gen";
+export * as cloudwatch from "./cloudwatch.gen";
+export * as azuremonitor from "./azuremonitor.gen";
+export * as googlecloudmonitoring from "./googlecloudmonitoring.gen";
+export * as bigquery from "./bigquery.gen";
+export * as grafanapyroscope from "./grafanapyroscope.gen";
+export * as expr from "./expr.gen";
 export { DASHBOARD_SCHEMA_VERSION } from "./dashboard.gen";

package/src/schema/logs.gen.ts

@@ -1,5 +1,6 @@
 // Code generated by chant generate from the vendored Grafana schema
-// src/spec/schemas/logs.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+// src/spec/schemas/logs.jsonschema.json (see src/pin.ts) and its correction
+// overlay in src/spec/overlay/ (see src/spec/overlay.ts). DO NOT EDIT.
 /* eslint-disable */
 
 export interface Options {
@@ -27,6 +28,7 @@ export interface Options {
   syntaxHighlighting?: boolean;
   fontSize?: "default" | "small";
   detailsMode?: "inline" | "sidebar";
+  unwrappedColumns?: boolean;
 }
 
 export type LogsSortOrder = "Descending" | "Ascending";