Phlare: Use data query schema (#62112)

* Create cue file and gen ts/go types

* Use generated schema in ts/go

* Run make den-cue to update report

* Manually extend Phlare query

* Updates

* Add default queryType

* Run make gen-cue to Update report.json

docs/sources/developers/kinds/composable/phlaredataquery/schema-reference.md

@@ -0,0 +1,22 @@
+---
+keywords:
+  - grafana
+  - schema
+title: PhlareDataQuery kind
+---
+> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
+
+# PhlareDataQuery kind
+
+## Maturity: experimental
+## Version: 0.0
+
+## Properties
+
+| Property        | Type     | Required | Description                                         |
+|-----------------|----------|----------|-----------------------------------------------------|
+| `groupBy`       | string[] | No       | Allows to group the results.                        |
+| `labelSelector` | string   | No       | Specifies the query label selectors. Default: `{}`. |
+| `profileTypeId` | string   | No       | Specifies the type of profile to query.             |
+
+

pkg/kindsys/report.json

@@ -1105,7 +1105,9 @@
     },
     "phlaredataquery": {
       "category": "composable",
-      "codeowners": [],
+      "codeowners": [
+        "grafana/observability-traces-and-profiling"
+      ],
       "currentVersion": [
         0,
         0
@@ -1113,13 +1115,13 @@
       "grafanaMaturityCount": 0,
       "lineageIsGroup": false,
       "links": {
-        "docs": "n/a",
-        "go": "n/a",
-        "schema": "n/a",
-        "ts": "n/a"
+        "docs": "https://grafana.com/docs/grafana/next/developers/kinds/composable/phlaredataquery/schema-reference",
+        "go": "https://github.com/grafana/grafana/tree/main/pkg/tsdb/phlare/kinds/dataquery/types_dataquery_gen.go",
+        "schema": "https://github.com/grafana/grafana/tree/main/public/app/plugins/datasource/phlare/dataquery.cue",
+        "ts": "https://github.com/grafana/grafana/tree/main/public/app/plugins/datasource/phlare/dataquery.gen.ts"
       },
       "machineName": "phlaredataquery",
-      "maturity": "planned",
+      "maturity": "experimental",
       "name": "PhlareDataQuery",
       "pluralMachineName": "phlaredataquerys",
       "pluralName": "PhlareDataQuerys",
@@ -1909,6 +1911,7 @@
           "librarypanel",
           "newspanelcfg",
           "nodegraphpanelcfg",
+          "phlaredataquery",
           "piechartpanelcfg",
           "statetimelinepanelcfg",
           "statpanelcfg",
@@ -1918,7 +1921,7 @@
           "textpanelcfg",
           "xychartpanelcfg"
         ],
-        "count": 18
+        "count": 19
       },
       "mature": {
         "name": "mature",
@@ -1978,7 +1981,6 @@
           "mysqldatasourcecfg",
           "parcadataquery",
           "parcadatasourcecfg",
-          "phlaredataquery",
           "phlaredatasourcecfg",
           "postgresqldataquery",
           "postgresqldatasourcecfg",
@@ -1996,7 +1998,7 @@
           "zipkindataquery",
           "zipkindatasourcecfg"
         ],
-        "count": 55
+        "count": 54
       },
       "stable": {
         "name": "stable",

pkg/tsdb/phlare/kinds/dataquery/types_dataquery_gen.go

@@ -0,0 +1,53 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     public/app/plugins/gen.go
+// Using jennies:
+//     PluginGoTypesJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+package dataquery
+
+// Defines values for PhlareQueryType.
+const (
+	PhlareQueryTypeBoth PhlareQueryType = "both"
+
+	PhlareQueryTypeMetrics PhlareQueryType = "metrics"
+
+	PhlareQueryTypeProfile PhlareQueryType = "profile"
+)
+
+// PhlareDataQuery defines model for PhlareDataQuery.
+type PhlareDataQuery struct {
+	// 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 *interface{} `json:"datasource,omitempty"`
+
+	// Allows to group the results.
+	GroupBy []string `json:"groupBy"`
+
+	// true if query is disabled (ie should not be returned to the dashboard)
+	Hide *bool `json:"hide,omitempty"`
+
+	// Unique, guid like, string used in explore mode
+	Key *string `json:"key,omitempty"`
+
+	// Specifies the query label selectors.
+	LabelSelector string `json:"labelSelector"`
+
+	// Specifies the type of profile to query.
+	ProfileTypeId string `json:"profileTypeId"`
+
+	// Specify the query flavor
+	// TODO make this required and give it a default
+	QueryType *string `json:"queryType,omitempty"`
+
+	// A - Z
+	RefId string `json:"refId"`
+}
+
+// PhlareQueryType defines model for PhlareQueryType.
+type PhlareQueryType string

pkg/tsdb/phlare/query.go

@@ -13,26 +13,23 @@ import (
 	"github.com/grafana/grafana-plugin-sdk-go/backend/gtime"
 	"github.com/grafana/grafana-plugin-sdk-go/data"
 	"github.com/grafana/grafana-plugin-sdk-go/live"
+	"github.com/grafana/grafana/pkg/tsdb/phlare/kinds/dataquery"
 	querierv1 "github.com/grafana/phlare/api/gen/proto/go/querier/v1"
 )
 
 type queryModel struct {
 	WithStreaming bool
-	ProfileTypeID string   `json:"profileTypeId"`
-	LabelSelector string   `json:"labelSelector"`
-	GroupBy       []string `json:"groupBy"`
+	dataquery.PhlareDataQuery
 }
 
 type dsJsonModel struct {
 	MinStep string `json:"minStep"`
 }
 
-// These constants need to match the ones in the frontend.
-const queryTypeProfile = "profile"
-
 const (
-	queryTypeMetrics = "metrics"
-	queryTypeBoth    = "both"
+	queryTypeProfile = string(dataquery.PhlareQueryTypeProfile)
+	queryTypeMetrics = string(dataquery.PhlareQueryTypeMetrics)
+	queryTypeBoth    = string(dataquery.PhlareQueryTypeBoth)
 )
 
 // query processes single Phlare query transforming the response to data.Frame packaged in DataResponse
@@ -63,7 +60,7 @@ func (d *PhlareDatasource) query(ctx context.Context, pCtx backend.PluginContext
 			}
 		}
 		req := connect.NewRequest(&querierv1.SelectSeriesRequest{
-			ProfileTypeID: qm.ProfileTypeID,
+			ProfileTypeID: qm.ProfileTypeId,
 			LabelSelector: qm.LabelSelector,
 			Start:         query.TimeRange.From.UnixMilli(),
 			End:           query.TimeRange.To.UnixMilli(),
@@ -79,7 +76,7 @@ func (d *PhlareDatasource) query(ctx context.Context, pCtx backend.PluginContext
 			return response
 		}
 		// add the frames to the response.
-		response.Frames = append(response.Frames, seriesToDataFrames(seriesResp, qm.ProfileTypeID)...)
+		response.Frames = append(response.Frames, seriesToDataFrames(seriesResp, qm.ProfileTypeId)...)
 	}
 
 	if query.QueryType == queryTypeProfile || query.QueryType == queryTypeBoth {
@@ -91,7 +88,7 @@ func (d *PhlareDatasource) query(ctx context.Context, pCtx backend.PluginContext
 			response.Error = err
 			return response
 		}
-		frame := responseToDataFrames(resp, qm.ProfileTypeID)
+		frame := responseToDataFrames(resp, qm.ProfileTypeId)
 		response.Frames = append(response.Frames, frame)
 
 		// If query called with streaming on then return a channel
@@ -113,7 +110,7 @@ func (d *PhlareDatasource) query(ctx context.Context, pCtx backend.PluginContext
 func makeRequest(qm queryModel, query backend.DataQuery) *connect.Request[querierv1.SelectMergeStacktracesRequest] {
 	return &connect.Request[querierv1.SelectMergeStacktracesRequest]{
 		Msg: &querierv1.SelectMergeStacktracesRequest{
-			ProfileTypeID: qm.ProfileTypeID,
+			ProfileTypeID: qm.ProfileTypeId,
 			LabelSelector: qm.LabelSelector,
 			Start:         query.TimeRange.From.UnixMilli(),
 			End:           query.TimeRange.To.UnixMilli(),

public/app/plugins/datasource/phlare/QueryEditor/QueryEditor.tsx

@@ -5,8 +5,9 @@ import { useAsync } from 'react-use';
 import { CoreApp, QueryEditorProps } from '@grafana/data';
 import { ButtonCascader, CascaderOption } from '@grafana/ui';
 
+import { defaultPhlare, defaultPhlareQueryType, Phlare } from '../dataquery.gen';
 import { PhlareDataSource } from '../datasource';
-import { defaultQuery, PhlareDataSourceOptions, ProfileTypeMessage, Query } from '../types';
+import { PhlareDataSourceOptions, ProfileTypeMessage, Query } from '../types';
 
 import { EditorRow } from './EditorRow';
 import { EditorRows } from './EditorRows';
@@ -15,6 +16,11 @@ import { QueryOptions } from './QueryOptions';
 
 export type Props = QueryEditorProps<PhlareDataSource, Query, PhlareDataSourceOptions>;
 
+export const defaultQuery: Partial<Phlare> = {
+  ...defaultPhlare,
+  queryType: defaultPhlareQueryType,
+};
+
 export function QueryEditor(props: Props) {
   const profileTypes = useProfileTypes(props.datasource);
 

public/app/plugins/datasource/phlare/dataquery.cue

@@ -0,0 +1,48 @@
+// Copyright 2023 Grafana Labs
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package grafanaplugin
+
+import (
+	"github.com/grafana/grafana/packages/grafana-schema/src/common"
+	"github.com/grafana/grafana/pkg/plugins/pfs"
+)
+
+// This file (with its sibling .cue files) implements pfs.GrafanaPlugin
+pfs.GrafanaPlugin
+
+composableKinds: DataQuery: {
+	maturity: "experimental"
+
+	lineage: {
+		seqs: [
+			{
+				schemas: [
+					// v0.0
+					{
+						common.DataQuery
+
+						// Specifies the query label selectors.
+						labelSelector: string | *"{}"
+						// Specifies the type of profile to query.
+						profileTypeId: string
+						// Allows to group the results.
+						groupBy: [...string]
+						#PhlareQueryType: "metrics" | "profile" | *"both" @cuetsy(kind="type")
+					},
+				]
+			},
+		]
+	}
+}

public/app/plugins/datasource/phlare/dataquery.gen.ts

@@ -0,0 +1,37 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     public/app/plugins/gen.go
+// Using jennies:
+//     TSTypesJenny
+//     PluginTSTypesJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+import * as common from '@grafana/schema';
+
+export const DataQueryModelVersion = Object.freeze([0, 0]);
+
+export type PhlareQueryType = ('metrics' | 'profile' | 'both');
+
+export const defaultPhlareQueryType: PhlareQueryType = 'both';
+
+export interface Phlare extends common.DataQuery {
+  /**
+   * Allows to group the results.
+   */
+  groupBy: Array<string>;
+  /**
+   * Specifies the query label selectors.
+   */
+  labelSelector: string;
+  /**
+   * Specifies the type of profile to query.
+   */
+  profileTypeId: string;
+}
+
+export const defaultPhlare: Partial<Phlare> = {
+  groupBy: [],
+  labelSelector: '{}',
+};

public/app/plugins/datasource/phlare/types.ts

@@ -1,10 +1,9 @@
-import { DataQuery, DataSourceJsonData } from '@grafana/data';
+import { DataSourceJsonData } from '@grafana/data';
 
-export interface Query extends DataQuery {
-  labelSelector: string;
-  profileTypeId: string;
-  queryType: 'metrics' | 'profile' | 'both';
-  groupBy: string[];
+import { Phlare as PhlareBase, PhlareQueryType } from './dataquery.gen';
+
+export interface Query extends PhlareBase {
+  queryType: PhlareQueryType;
 }
 
 export interface ProfileTypeMessage {
@@ -18,12 +17,6 @@ export interface ProfileTypeMessage {
 
 export type SeriesMessage = Array<{ labels: Array<{ name: string; value: string }> }>;
 
-export const defaultQuery: Partial<Query> = {
-  labelSelector: '{}',
-  queryType: 'both',
-  groupBy: [],
-};
-
 /**
  * These are options configured for each DataSource instance.
  */