@intentius/chant-lexicon-grafana 0.96.0

package/src/schema/stat.gen.ts

@@ -0,0 +1,86 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/stat.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Options {
+  graphMode: BigValueGraphMode;
+  colorMode: BigValueColorMode;
+  justifyMode: BigValueJustifyMode;
+  textMode: BigValueTextMode;
+  wideLayout: boolean;
+  showPercentChange: boolean;
+  reduceOptions: ReduceDataOptions;
+  text?: VizTextDisplayOptions;
+  percentChangeColorMode: PercentChangeColorMode;
+  orientation: VizOrientation;
+}
+
+/**
+ * TODO docs
+ */
+export type BigValueGraphMode = "none" | "line" | "area";
+
+/**
+ * TODO docs
+ */
+export type BigValueColorMode = "value" | "background" | "background_solid" | "none";
+
+/**
+ * TODO docs
+ */
+export type BigValueJustifyMode = "auto" | "center";
+
+/**
+ * TODO docs
+ */
+export type BigValueTextMode = "auto" | "value" | "value_and_name" | "name" | "none";
+
+/**
+ * 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 PercentChangeColorMode = "standard" | "inverted" | "same_as_value";
+
+/**
+ * TODO docs
+ */
+export type VizOrientation = "auto" | "vertical" | "horizontal";

package/src/schema/table.gen.ts

@@ -0,0 +1,334 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/table.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Options {
+  /**
+   * Represents the index of the selected frame
+   */
+  frameIndex: number;
+  /**
+   * Controls whether the panel should show the header
+   */
+  showHeader: boolean;
+  /**
+   * Controls whether the header should show icons for the column types
+   */
+  showTypeIcons?: boolean;
+  /**
+   * Used to control row sorting
+   */
+  sortBy?: TableSortByFieldState[];
+  /**
+   * Controls footer options
+   */
+  footer?: TableFooterOptions;
+  /**
+   * Controls the height of the rows
+   */
+  cellHeight?: TableCellHeight;
+}
+
+export type FieldConfig = TableFieldOptions;
+
+/**
+ * Sort by field state
+ */
+export interface TableSortByFieldState {
+  /**
+   * Sets the display name of the field to sort by
+   */
+  displayName: string;
+  /**
+   * Flag used to indicate descending sort order
+   */
+  desc?: boolean;
+}
+
+/**
+ * Footer options
+ */
+export interface TableFooterOptions {
+  show: boolean;
+  /**
+   * actually 1 value
+   */
+  reducer: string[];
+  fields?: string[];
+  enablePagination?: boolean;
+  countRows?: boolean;
+}
+
+/**
+ * Height of a table cell
+ */
+export type TableCellHeight = "sm" | "md" | "lg" | "auto";
+
+/**
+ * Field options for each field within a table (e.g 10, "The String", 64.20, etc.)
+ * Generally defines alignment, filtering capabilties, display options, etc.
+ */
+export interface TableFieldOptions {
+  width?: number;
+  minWidth?: number;
+  align: FieldTextAlignment;
+  /**
+   * This field is deprecated in favor of using cellOptions
+   */
+  displayMode?: TableCellDisplayMode;
+  cellOptions?: TableCellOptions | null;
+  /**
+   * ?? default is missing or false ??
+   */
+  hidden?: boolean;
+  inspect: boolean;
+  filterable?: boolean;
+  /**
+   * Hides any header for a column, useful for columns that show some static content or buttons.
+   */
+  hideHeader?: boolean;
+}
+
+/**
+ * TODO -- should not be table specific!
+ * TODO docs
+ */
+export type FieldTextAlignment = "auto" | "left" | "right" | "center";
+
+/**
+ * Internally, this is the "type" of cell that's being displayed
+ * in the table such as colored text, JSON, gauge, etc.
+ * The color-background-solid, gradient-gauge, and lcd-gauge
+ * modes are deprecated in favor of new cell subOptions
+ */
+export type TableCellDisplayMode = "auto" | "color-text" | "color-background" | "color-background-solid" | "gradient-gauge" | "lcd-gauge" | "json-view" | "basic" | "image" | "gauge" | "sparkline" | "data-links" | "custom" | "actions";
+
+/**
+ * Table cell options. Each cell has a display mode
+ * and other potential options for that display.
+ */
+export type TableCellOptions = TableAutoCellOptions | TableSparklineCellOptions | TableBarGaugeCellOptions | TableColoredBackgroundCellOptions | TableColorTextCellOptions | TableImageCellOptions | TableDataLinksCellOptions | TableActionsCellOptions | TableJsonViewCellOptions;
+
+/**
+ * Auto mode table cell options
+ */
+export interface TableAutoCellOptions {
+  type: TableCellDisplayMode;
+  wrapText?: boolean;
+}
+
+/**
+ * Sparkline cell options
+ */
+export interface TableSparklineCellOptions {
+  type: TableCellDisplayMode;
+  drawStyle?: GraphDrawStyle;
+  gradientMode?: GraphGradientMode;
+  thresholdsStyle?: GraphThresholdsStyleConfig;
+  transform?: GraphTransform;
+  lineColor?: string;
+  lineWidth?: number;
+  lineInterpolation?: LineInterpolation;
+  lineStyle?: LineStyle;
+  fillColor?: string;
+  fillOpacity?: number;
+  showPoints?: VisibilityMode;
+  pointSize?: number;
+  pointColor?: string;
+  axisPlacement?: AxisPlacement;
+  axisColorMode?: AxisColorMode;
+  axisLabel?: string;
+  axisWidth?: number;
+  axisSoftMin?: number;
+  axisSoftMax?: number;
+  axisGridShow?: boolean;
+  scaleDistribution?: ScaleDistributionConfig;
+  axisCenteredZero?: boolean;
+  barAlignment?: BarAlignment;
+  barWidthFactor?: number;
+  stacking?: StackingConfig;
+  hideFrom?: HideSeriesConfig;
+  hideValue?: boolean;
+  insertNulls?: boolean | number;
+  /**
+   * Indicate if null values should be treated as gaps or connected.
+   * When the value is a number, it represents the maximum delta in the
+   * X axis that should be considered connected.  For timeseries, this is milliseconds
+   */
+  spanNulls?: boolean | number;
+  fillBelowTo?: string;
+  pointSymbol?: string;
+  axisBorderShow?: boolean;
+  barMaxWidth?: number;
+}
+
+/**
+ * Gauge cell options
+ */
+export interface TableBarGaugeCellOptions {
+  type: TableCellDisplayMode;
+  mode?: BarGaugeDisplayMode;
+  valueDisplayMode?: BarGaugeValueMode;
+}
+
+/**
+ * Colored background cell options
+ */
+export interface TableColoredBackgroundCellOptions {
+  type: TableCellDisplayMode;
+  mode?: TableCellBackgroundDisplayMode;
+  applyToRow?: boolean;
+  wrapText?: boolean;
+}
+
+/**
+ * Colored text cell options
+ */
+export interface TableColorTextCellOptions {
+  type: TableCellDisplayMode;
+  wrapText?: boolean;
+}
+
+/**
+ * Json view cell options
+ */
+export interface TableImageCellOptions {
+  type: TableCellDisplayMode;
+  alt?: string;
+  title?: string;
+}
+
+/**
+ * Show data links in the cell
+ */
+export interface TableDataLinksCellOptions {
+  type: TableCellDisplayMode;
+}
+
+/**
+ * Show actions in the cell
+ */
+export interface TableActionsCellOptions {
+  type: TableCellDisplayMode;
+}
+
+/**
+ * Json view cell options
+ */
+export interface TableJsonViewCellOptions {
+  type: TableCellDisplayMode;
+}
+
+/**
+ * TODO docs
+ */
+export type GraphDrawStyle = "line" | "bars" | "points";
+
+/**
+ * TODO docs
+ */
+export type GraphGradientMode = "none" | "opacity" | "hue" | "scheme";
+
+/**
+ * TODO docs
+ */
+export interface GraphThresholdsStyleConfig {
+  mode: GraphThresholdsStyleMode;
+}
+
+/**
+ * TODO docs
+ */
+export type GraphTransform = "constant" | "negative-Y";
+
+/**
+ * TODO docs
+ */
+export type LineInterpolation = "linear" | "smooth" | "stepBefore" | "stepAfter";
+
+/**
+ * TODO docs
+ */
+export interface LineStyle {
+  fill?: "solid" | "dash" | "dot" | "square";
+  dash?: number[];
+}
+
+/**
+ * TODO docs
+ */
+export type VisibilityMode = "auto" | "never" | "always";
+
+/**
+ * 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 BarAlignment = -1 | 0 | 1;
+
+/**
+ * TODO docs
+ */
+export interface StackingConfig {
+  mode?: StackingMode;
+  group?: string;
+}
+
+/**
+ * TODO docs
+ */
+export interface HideSeriesConfig {
+  tooltip: boolean;
+  legend: boolean;
+  viz: boolean;
+}
+
+/**
+ * Enum expressing the possible display modes
+ * for the bar gauge component of Grafana UI
+ */
+export type BarGaugeDisplayMode = "basic" | "lcd" | "gradient";
+
+/**
+ * Allows for the table cell gauge display type to set the gauge mode.
+ */
+export type BarGaugeValueMode = "color" | "text" | "hidden";
+
+/**
+ * Display mode to the "Colored Background" display
+ * mode for table cells. Either displays a solid color (basic mode)
+ * or a gradient.
+ */
+export type TableCellBackgroundDisplayMode = "basic" | "gradient";
+
+/**
+ * TODO docs
+ */
+export type GraphThresholdsStyleMode = "off" | "line" | "dashed" | "area" | "line+area" | "dashed+area" | "series";
+
+/**
+ * TODO docs
+ */
+export type ScaleDistribution = "linear" | "log" | "ordinal" | "symlog";
+
+/**
+ * TODO docs
+ */
+export type StackingMode = "none" | "normal" | "percent";

package/src/schema/tempo.gen.ts

@@ -0,0 +1,146 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/tempo.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export interface Dataquery {
+  /**
+   * 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;
+  /**
+   * TraceQL query or trace ID
+   */
+  query?: string;
+  /**
+   * @deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true
+   */
+  search?: string;
+  /**
+   * @deprecated Query traces by service name
+   */
+  serviceName?: string;
+  /**
+   * @deprecated Query traces by span name
+   */
+  spanName?: string;
+  /**
+   * @deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms
+   */
+  minDuration?: string;
+  /**
+   * @deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms
+   */
+  maxDuration?: string;
+  /**
+   * Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.
+   */
+  serviceMapQuery?: string | string[];
+  /**
+   * Use service.namespace in addition to service.name to uniquely identify a service.
+   */
+  serviceMapIncludeNamespace?: boolean;
+  /**
+   * Defines the maximum number of traces that are returned from Tempo
+   */
+  limit?: number;
+  /**
+   * Defines the maximum number of spans per spanset that are returned from Tempo
+   */
+  spss?: number;
+  filters: TraceqlFilter[];
+  /**
+   * Filters that are used to query the metrics summary
+   */
+  groupBy?: TraceqlFilter[];
+  /**
+   * The type of the table that is used to display the search results
+   */
+  tableType?: SearchTableType;
+  /**
+   * For metric queries, the step size to use
+   */
+  step?: string;
+  /**
+   * For metric queries, how many exemplars to request, 0 means no exemplars
+   */
+  exemplars?: number;
+  /**
+   * 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;
+  /**
+   * For metric queries, whether to run instant or range queries
+   */
+  metricsQueryType?: MetricsQueryType;
+}
+
+export interface TraceqlFilter {
+  /**
+   * Uniquely identify the filter, will not be used in the query generation
+   */
+  id: string;
+  /**
+   * The tag for the search filter, for example: .http.status_code, .service.name, status
+   */
+  tag?: string;
+  /**
+   * The operator that connects the tag to the value, for example: =, >, !=, =~
+   */
+  operator?: string;
+  /**
+   * The value for the search filter
+   */
+  value?: string | string[];
+  /**
+   * The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query
+   */
+  valueType?: string;
+  /**
+   * The scope of the filter, can either be unscoped/all scopes, resource or span
+   */
+  scope?: TraceqlSearchScope;
+}
+
+/**
+ * static fields are pre-set in the UI, dynamic fields are added by the user
+ */
+export type TraceqlSearchScope = "intrinsic" | "unscoped" | "event" | "instrumentation" | "link" | "resource" | "span";
+
+/**
+ * The type of the table that is used to display the search results
+ */
+export type SearchTableType = "traces" | "spans" | "raw";
+
+export type MetricsQueryType = "range" | "instant";
+
+export type TempoQueryType = "traceql" | "traceqlSearch" | "serviceMap" | "upload" | "nativeSearch" | "traceId" | "clear";
+
+/**
+ * The state of the TraceQL streaming search query
+ */
+export type SearchStreamingState = "pending" | "streaming" | "done" | "error";
+
+export interface DataSourceRef {
+  /**
+   * The plugin type-id
+   */
+  type?: string;
+  /**
+   * Specific datasource instance
+   */
+  uid?: string;
+}

package/src/schema/text.gen.ts

@@ -0,0 +1,22 @@
+// Code generated by chant generate from the vendored Grafana schema
+// src/spec/schemas/text.jsonschema.json (see src/pin.ts). DO NOT EDIT.
+/* eslint-disable */
+
+export type TextMode = "html" | "markdown" | "code";
+
+export type CodeLanguage = "json" | "yaml" | "xml" | "typescript" | "sql" | "go" | "markdown" | "html" | "plaintext";
+
+export interface CodeOptions {
+  /**
+   * The language passed to monaco code editor
+   */
+  language: CodeLanguage;
+  showLineNumbers: boolean;
+  showMiniMap: boolean;
+}
+
+export interface Options {
+  mode: TextMode;
+  code?: CodeOptions;
+  content: string;
+}