Pyroscope: Add standalone build (#80222)

* Pyroscope standalone build

* Fix for tests

* Add missing packages

* Remove import

* Update trace to profiles

* Update test
This commit is contained in:
Joey 2024-01-16 12:46:15 +00:00 committed by GitHub
parent 96010eb21e
commit 6796e66fb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 316 additions and 22 deletions

View File

@ -4972,6 +4972,9 @@ exports[`better eslint`] = {
[0, 0, 0, "Styles should be written using objects.", "0"],
[0, 0, 0, "Styles should be written using objects.", "1"]
],
"public/app/plugins/datasource/grafana-pyroscope-datasource/utils.ts:5381": [
[0, 0, 0, "Do not use any type assertions.", "0"]
],
"public/app/plugins/datasource/grafana-testdata-datasource/QueryEditor.tsx:5381": [
[0, 0, 0, "Unexpected any. Specify a different type.", "0"],
[0, 0, 0, "Do not use any type assertions.", "1"],

View File

@ -96,6 +96,8 @@
},
{
"files": [
"public/app/plugins/datasource/grafana-pyroscope-datasource/*.{ts,tsx}",
"public/app/plugins/datasource/grafana-pyroscope-datasource/**/*.{ts,tsx}",
"public/app/plugins/datasource/grafana-testdata-datasource/*.{ts,tsx}",
"public/app/plugins/datasource/grafana-testdata-datasource/**/*.{ts,tsx}",
"public/app/plugins/datasource/azuremonitor/*.{ts,tsx}",

View File

@ -55,6 +55,8 @@ deny = [
{ pkg = "github.com/grafana/grafana/pkg/tsdb/intervalv2", desc = "Core plugins are not allowed to depend on Grafana core packages" },
]
files = [
"**/pkg/tsdb/grafana-pyroscope-datasource/*",
"**/pkg/tsdb/grafana-pyroscope-datasource/**/*",
"**/pkg/tsdb/grafana-testdata-datasource/*",
"**/pkg/tsdb/grafana-testdata-datasource/**/*",
"**/pkg/tsdb/azuremonitor/*",

View File

@ -244,6 +244,7 @@
"@floating-ui/react": "0.26.6",
"@glideapps/glide-data-grid": "^5.2.1",
"@grafana-plugins/grafana-azure-monitor-datasource": "workspace:*",
"@grafana-plugins/grafana-pyroscope-datasource": "workspace:*",
"@grafana-plugins/grafana-testdata-datasource": "workspace:*",
"@grafana-plugins/parca": "workspace:*",
"@grafana-plugins/tempo": "workspace:*",

View File

@ -11,7 +11,7 @@
import * as common from '@grafana/schema';
export const pluginVersion = "10.4.0-pre";
export const pluginVersion = "%VERSION%";
export type PyroscopeQueryType = ('metrics' | 'profile' | 'both');

View File

@ -160,7 +160,7 @@
"updated": ""
},
"dependencies": {
"grafanaDependency": ">=10.3.0",
"grafanaDependency": "\u003e=10.3.0",
"grafanaVersion": "*",
"plugins": []
},
@ -688,7 +688,7 @@
"updated": ""
},
"dependencies": {
"grafanaDependency": "",
"grafanaDependency": "\u003e=10.3.0-0",
"grafanaVersion": "*",
"plugins": []
},

View File

@ -0,0 +1,51 @@
package main
import (
"context"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt"
pyroscope "github.com/grafana/grafana/pkg/tsdb/grafana-pyroscope-datasource"
)
var (
_ backend.QueryDataHandler = (*Datasource)(nil)
_ backend.CheckHealthHandler = (*Datasource)(nil)
_ backend.CallResourceHandler = (*Datasource)(nil)
_ backend.StreamHandler = (*Datasource)(nil)
)
func NewDatasource(context.Context, backend.DataSourceInstanceSettings) (instancemgmt.Instance, error) {
return &Datasource{
Service: pyroscope.ProvideService(httpclient.NewProvider()),
}, nil
}
type Datasource struct {
Service *pyroscope.Service
}
func (d *Datasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
return d.Service.QueryData(ctx, req)
}
func (d *Datasource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
return d.Service.CallResource(ctx, req, sender)
}
func (d *Datasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
return d.Service.CheckHealth(ctx, req)
}
func (d *Datasource) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
return d.Service.SubscribeStream(ctx, req)
}
func (d *Datasource) PublishStream(ctx context.Context, req *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
return d.Service.PublishStream(ctx, req)
}
func (d *Datasource) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
return d.Service.RunStream(ctx, req, sender)
}

View File

@ -0,0 +1,23 @@
package main
import (
"os"
"github.com/grafana/grafana-plugin-sdk-go/backend/datasource"
"github.com/grafana/grafana-plugin-sdk-go/backend/log"
)
func main() {
// Start listening to requests sent from Grafana. This call is blocking so
// it won't finish until Grafana shuts down the process or the plugin choose
// to exit by itself using os.Exit. Manage automatically manages life cycle
// of datasource instances. It accepts datasource instance factory as first
// argument. This factory will be automatically called on incoming request
// from Grafana to create different instances of SampleDatasource (per datasource
// ID). When datasource configuration changed Dispose method will be called and
// new datasource instance created using NewSampleDatasource factory.
if err := datasource.Manage("grafana-pyroscope-datasource", NewDatasource, datasource.ManageOpts{}); err != nil {
log.DefaultLogger.Error(err.Error())
os.Exit(1)
}
}

View File

@ -9,11 +9,10 @@ import {
updateDatasourcePluginJsonDataOption,
} from '@grafana/data';
import { ConfigDescriptionLink, ConfigSection } from '@grafana/experimental';
import { getDataSourceSrv } from '@grafana/runtime';
import { DataSourceWithBackend, getDataSourceSrv } from '@grafana/runtime';
import { InlineField, InlineFieldRow, Input, InlineSwitch } from '@grafana/ui';
import { DataSourcePicker } from 'app/features/datasources/components/picker/DataSourcePicker';
import { ProfileTypesCascader } from 'app/plugins/datasource/grafana-pyroscope-datasource/QueryEditor/ProfileTypesCascader';
import { PyroscopeDataSource } from 'app/plugins/datasource/grafana-pyroscope-datasource/datasource';
import { ProfileTypeMessage } from 'app/plugins/datasource/grafana-pyroscope-datasource/types';
import { TagMappingInput } from '../TraceToLogs/TagMappingInput';
@ -47,20 +46,19 @@ export function TraceToProfilesSettings({ options, onOptionsChange }: Props) {
return await getDataSourceSrv().get(options.jsonData.tracesToProfiles?.datasourceUid);
}, [options.jsonData.tracesToProfiles?.datasourceUid]);
useEffect(() => {
const { value: pTypes } = useAsync(async () => {
if (
dataSource &&
dataSource instanceof PyroscopeDataSource &&
dataSource instanceof DataSourceWithBackend &&
supportedDataSourceTypes.includes(dataSource.type) &&
dataSource.uid === options.jsonData.tracesToProfiles?.datasourceUid
) {
dataSource.getAllProfileTypes().then((profileTypes) => {
setProfileTypes(profileTypes);
});
} else {
setProfileTypes([]);
return await dataSource?.getResource('profileTypes');
}
}, [dataSource, onOptionsChange, options, supportedDataSourceTypes]);
}, [dataSource]);
useEffect(() => {
setProfileTypes(pTypes ?? []);
}, [pTypes]);
return (
<div className={css({ width: '100%' })}>

View File

@ -13,12 +13,11 @@ import {
TimeZone,
} from '@grafana/data';
import { FlameGraph } from '@grafana/flamegraph';
import { config, getTemplateSrv } from '@grafana/runtime';
import { config, DataSourceWithBackend, getTemplateSrv } from '@grafana/runtime';
import { useStyles2 } from '@grafana/ui';
import { TraceToProfilesOptions } from 'app/core/components/TraceToProfiles/TraceToProfilesSettings';
import { getDatasourceSrv } from 'app/features/plugins/datasource_srv';
import { PyroscopeQueryType } from 'app/plugins/datasource/grafana-pyroscope-datasource/dataquery.gen';
import { PyroscopeDataSource } from 'app/plugins/datasource/grafana-pyroscope-datasource/datasource';
import { Query } from 'app/plugins/datasource/grafana-pyroscope-datasource/types';
import {
@ -79,7 +78,7 @@ export default function SpanFlameGraph(props: SpanFlameGraphProps) {
const getFlameGraphData = async (request: DataQueryRequest<Query>, datasourceUid: string) => {
const ds = await getDatasourceSrv().get(datasourceUid);
if (ds instanceof PyroscopeDataSource) {
if (ds instanceof DataSourceWithBackend) {
const result = await lastValueFrom(ds.query(request));
const frame = result.data.find((x: DataFrame) => {
return x.name === 'response';

View File

@ -37,7 +37,7 @@ const tempoPlugin = async () => await import(/* webpackChunkName: "tempoPlugin"
const alertmanagerPlugin = async () =>
await import(/* webpackChunkName: "alertmanagerPlugin" */ 'app/plugins/datasource/alertmanager/module');
const pyroscopePlugin = async () =>
await import(/* webpackChunkName: "pyroscopePlugin" */ 'app/plugins/datasource/grafana-pyroscope-datasource/module');
await import(/* webpackChunkName: "pyroscopePlugin" */ '@grafana-plugins/grafana-pyroscope-datasource/module');
const parcaPlugin = async () => await import(/* webpackChunkName: "parcaPlugin" */ '@grafana-plugins/parca/module');
import * as alertGroupsPanel from 'app/plugins/panel/alertGroups/module';

View File

@ -0,0 +1 @@
# Changelog

View File

@ -11,11 +11,10 @@ import {
} from '@grafana/data';
import { DataSourceWithBackend, getTemplateSrv, TemplateSrv } from '@grafana/runtime';
import { extractLabelMatchers, toPromLikeExpr } from '../prometheus/language_utils';
import { VariableSupport } from './VariableSupport';
import { defaultGrafanaPyroscope, defaultPyroscopeQueryType } from './dataquery.gen';
import { PyroscopeDataSourceOptions, Query, ProfileTypeMessage } from './types';
import { extractLabelMatchers, toPromLikeExpr } from './utils';
export class PyroscopeDataSource extends DataSourceWithBackend<Query, PyroscopeDataSourceOptions> {
constructor(

View File

@ -0,0 +1,49 @@
{
"name": "@grafana-plugins/grafana-pyroscope-datasource",
"description": "Continuous profiling for analysis of CPU and memory usage, down to the line number and throughout time. Saving infrastructure cost, improving performance, and increasing reliability.",
"private": true,
"version": "10.4.0-pre",
"dependencies": {
"@emotion/css": "11.11.2",
"@grafana/data": "10.4.0-pre",
"@grafana/runtime": "10.4.0-pre",
"@grafana/schema": "10.4.0-pre",
"@grafana/ui": "10.4.0-pre",
"fast-deep-equal": "^3.1.3",
"lodash": "4.17.21",
"monaco-editor": "0.34.0",
"prismjs": "1.29.0",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-use": "17.4.0",
"rxjs": "7.8.1",
"tslib": "2.6.0"
},
"devDependencies": {
"@grafana/plugin-configs": "10.4.0-pre",
"@testing-library/jest-dom": "6.1.4",
"@testing-library/react": "14.0.0",
"@testing-library/user-event": "14.5.1",
"@types/jest": "29.5.4",
"@types/lodash": "4.14.195",
"@types/prismjs": "1.26.0",
"@types/react": "18.2.15",
"@types/react-dom": "18.2.7",
"@types/testing-library__jest-dom": "5.14.8",
"css-loader": "6.8.1",
"jest": "29.7.0",
"style-loader": "3.3.3",
"ts-node": "10.9.1",
"typescript": "5.2.2",
"webpack": "5.89.0"
},
"peerDependencies": {
"@grafana/runtime": "*"
},
"scripts": {
"build": "webpack -c ./webpack.config.ts --env production",
"build:commit": "webpack -c ./webpack.config.ts --env production --env commit=$(git rev-parse --short HEAD)",
"dev": "webpack -w -c ./webpack.config.ts --env development"
},
"packageManager": "yarn@3.6.0"
}

View File

@ -2,6 +2,7 @@
"type": "datasource",
"name": "Grafana Pyroscope",
"id": "grafana-pyroscope-datasource",
"executable": "gpx_grafana-pyroscope-datasource",
"aliasIDs": ["phlare"],
"category": "profiling",
@ -29,6 +30,10 @@
"name": "GitHub Project",
"url": "https://github.com/grafana/pyroscope"
}
]
],
"version": "%VERSION%"
},
"dependencies": {
"grafanaDependency": ">=10.3.0-0"
}
}

View File

@ -0,0 +1,4 @@
{
"extends": "@grafana/plugin-configs/tsconfig.json",
"include": ["."]
}

View File

@ -0,0 +1,84 @@
import { invert } from 'lodash';
import { Token } from 'prismjs';
import { AbstractLabelMatcher, AbstractLabelOperator, AbstractQuery } from '@grafana/data';
export function extractLabelMatchers(tokens: Array<string | Token>): AbstractLabelMatcher[] {
const labelMatchers: AbstractLabelMatcher[] = [];
for (const token of tokens) {
if (!(token instanceof Token)) {
continue;
}
if (token.type === 'context-labels') {
let labelKey = '';
let labelValue = '';
let labelOperator = '';
const contentTokens = Array.isArray(token.content) ? token.content : [token.content];
for (let currentToken of contentTokens) {
if (typeof currentToken === 'string') {
let currentStr: string;
currentStr = currentToken;
if (currentStr === '=' || currentStr === '!=' || currentStr === '=~' || currentStr === '!~') {
labelOperator = currentStr;
}
} else if (currentToken instanceof Token) {
switch (currentToken.type) {
case 'label-key':
labelKey = getMaybeTokenStringContent(currentToken);
break;
case 'label-value':
labelValue = getMaybeTokenStringContent(currentToken);
labelValue = labelValue.substring(1, labelValue.length - 1);
const labelComparator = FromPromLikeMap[labelOperator];
if (labelComparator) {
labelMatchers.push({ name: labelKey, operator: labelComparator, value: labelValue });
}
break;
}
}
}
}
}
return labelMatchers;
}
export function toPromLikeExpr(labelBasedQuery: AbstractQuery): string {
const expr = labelBasedQuery.labelMatchers
.map((selector: AbstractLabelMatcher) => {
const operator = ToPromLikeMap[selector.operator];
if (operator) {
return `${selector.name}${operator}"${selector.value}"`;
} else {
return '';
}
})
.filter((e: string) => e !== '')
.join(', ');
return expr ? `{${expr}}` : '';
}
function getMaybeTokenStringContent(token: Token): string {
if (typeof token.content === 'string') {
return token.content;
}
return '';
}
const FromPromLikeMap: Record<string, AbstractLabelOperator> = {
'=': AbstractLabelOperator.Equal,
'!=': AbstractLabelOperator.NotEqual,
'=~': AbstractLabelOperator.EqualRegEx,
'!~': AbstractLabelOperator.NotEqualRegEx,
};
const ToPromLikeMap: Record<AbstractLabelOperator, string> = invert(FromPromLikeMap) as Record<
AbstractLabelOperator,
string
>;

View File

@ -0,0 +1,15 @@
import config from '@grafana/plugin-configs/webpack.config';
const configWithFallback = async (env: Record<string, unknown>) => {
const response = await config(env);
if (response !== undefined && response.resolve !== undefined) {
response.resolve.fallback = {
...response.resolve.fallback,
stream: false,
string_decoder: false,
};
}
return response;
};
export default configWithFallback;

View File

@ -2970,6 +2970,45 @@ __metadata:
languageName: unknown
linkType: soft
"@grafana-plugins/grafana-pyroscope-datasource@workspace:*, @grafana-plugins/grafana-pyroscope-datasource@workspace:public/app/plugins/datasource/grafana-pyroscope-datasource":
version: 0.0.0-use.local
resolution: "@grafana-plugins/grafana-pyroscope-datasource@workspace:public/app/plugins/datasource/grafana-pyroscope-datasource"
dependencies:
"@emotion/css": "npm:11.11.2"
"@grafana/data": "npm:10.4.0-pre"
"@grafana/plugin-configs": "npm:10.4.0-pre"
"@grafana/runtime": "npm:10.4.0-pre"
"@grafana/schema": "npm:10.4.0-pre"
"@grafana/ui": "npm:10.4.0-pre"
"@testing-library/jest-dom": "npm:6.1.4"
"@testing-library/react": "npm:14.0.0"
"@testing-library/user-event": "npm:14.5.1"
"@types/jest": "npm:29.5.4"
"@types/lodash": "npm:4.14.195"
"@types/prismjs": "npm:1.26.0"
"@types/react": "npm:18.2.15"
"@types/react-dom": "npm:18.2.7"
"@types/testing-library__jest-dom": "npm:5.14.8"
css-loader: "npm:6.8.1"
fast-deep-equal: "npm:^3.1.3"
jest: "npm:29.7.0"
lodash: "npm:4.17.21"
monaco-editor: "npm:0.34.0"
prismjs: "npm:1.29.0"
react: "npm:18.2.0"
react-dom: "npm:18.2.0"
react-use: "npm:17.4.0"
rxjs: "npm:7.8.1"
style-loader: "npm:3.3.3"
ts-node: "npm:10.9.1"
tslib: "npm:2.6.0"
typescript: "npm:5.2.2"
webpack: "npm:5.89.0"
peerDependencies:
"@grafana/runtime": "*"
languageName: unknown
linkType: soft
"@grafana-plugins/grafana-testdata-datasource@workspace:*, @grafana-plugins/grafana-testdata-datasource@workspace:public/app/plugins/datasource/grafana-testdata-datasource":
version: 0.0.0-use.local
resolution: "@grafana-plugins/grafana-testdata-datasource@workspace:public/app/plugins/datasource/grafana-testdata-datasource"
@ -7943,6 +7982,15 @@ __metadata:
languageName: node
linkType: hard
"@testing-library/user-event@npm:14.5.1":
version: 14.5.1
resolution: "@testing-library/user-event@npm:14.5.1"
peerDependencies:
"@testing-library/dom": ">=7.21.4"
checksum: 696e1328c230b0a7063a41d82b5350c6be926696106809a4d79d446d190ff56bebb850fe564ff0952cb74ae81e59a6f10534a88ecbb3792083271a249e04e728
languageName: node
linkType: hard
"@testing-library/user-event@npm:14.5.2":
version: 14.5.2
resolution: "@testing-library/user-event@npm:14.5.2"
@ -9415,6 +9463,15 @@ __metadata:
languageName: node
linkType: hard
"@types/testing-library__jest-dom@npm:5.14.8":
version: 5.14.8
resolution: "@types/testing-library__jest-dom@npm:5.14.8"
dependencies:
"@types/jest": "npm:*"
checksum: 26d768b3de5c71ecef683aa0e968ec2bb7f4626d78718132fa5a9c2064f9237836135e2551aa048c728407760d51d985a9d58a14528f2679a35d18d5ca200f08
languageName: node
linkType: hard
"@types/testing-library__jest-dom@npm:5.14.9":
version: 5.14.9
resolution: "@types/testing-library__jest-dom@npm:5.14.9"
@ -17143,6 +17200,7 @@ __metadata:
"@floating-ui/react": "npm:0.26.6"
"@glideapps/glide-data-grid": "npm:^5.2.1"
"@grafana-plugins/grafana-azure-monitor-datasource": "workspace:*"
"@grafana-plugins/grafana-pyroscope-datasource": "workspace:*"
"@grafana-plugins/grafana-testdata-datasource": "workspace:*"
"@grafana-plugins/parca": "workspace:*"
"@grafana-plugins/tempo": "workspace:*"