Skip to content

Commit 15e54df

Browse files
authored
Pyroscope: Remove "phlare" from variable, types, strings etc (grafana#75140)
1 parent d1296f7 commit 15e54df

29 files changed

+143
-148
lines changed

.github/commands.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@
149149
},
150150
{
151151
"type":"label",
152-
"name":"datasource/Phlare",
152+
"name":"datasource/grafana-pyroscope",
153153
"action":"addToProject",
154154
"addToProject":{
155155
"url":"https://github.com/orgs/grafana/projects/221"

packages/grafana-schema/src/raw/composable/grafanapyroscope/dataquery/x/GrafanaPyroscopeDataQuery_types.gen.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import * as common from '@grafana/schema';
1313

1414
export const pluginVersion = "10.2.0-pre";
1515

16-
export type PhlareQueryType = ('metrics' | 'profile' | 'both');
16+
export type PyroscopeQueryType = ('metrics' | 'profile' | 'both');
1717

18-
export const defaultPhlareQueryType: PhlareQueryType = 'both';
18+
export const defaultPyroscopeQueryType: PyroscopeQueryType = 'both';
1919

2020
export interface GrafanaPyroscopeDataQuery extends common.DataQuery {
2121
/**

pkg/services/pluginsintegration/plugins_integration_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ func TestIntegrationPluginManager(t *testing.T) {
9595
ms := mssql.ProvideService(cfg)
9696
sv2 := searchV2.ProvideService(cfg, db.InitTestDB(t), nil, nil, tracer, features, nil, nil, nil)
9797
graf := grafanads.ProvideService(sv2, nil)
98-
phlare := pyroscope.ProvideService(hcp, acimpl.ProvideAccessControl(cfg))
98+
pyroscope := pyroscope.ProvideService(hcp, acimpl.ProvideAccessControl(cfg))
9999
parca := parca.ProvideService(hcp)
100-
coreRegistry := coreplugin.ProvideCoreRegistry(am, cw, cm, es, grap, idb, lk, otsdb, pr, tmpo, td, pg, my, ms, graf, phlare, parca)
100+
coreRegistry := coreplugin.ProvideCoreRegistry(am, cw, cm, es, grap, idb, lk, otsdb, pr, tmpo, td, pg, my, ms, graf, pyroscope, parca)
101101

102102
testCtx := CreateIntegrationTestCtx(t, cfg, coreRegistry)
103103

pkg/tsdb/grafana-pyroscope-datasource/instance.go

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package phlare
1+
package pyroscope
22

33
import (
44
"context"
@@ -16,10 +16,10 @@ import (
1616
)
1717

1818
var (
19-
_ backend.QueryDataHandler = (*PhlareDatasource)(nil)
20-
_ backend.CallResourceHandler = (*PhlareDatasource)(nil)
21-
_ backend.CheckHealthHandler = (*PhlareDatasource)(nil)
22-
_ backend.StreamHandler = (*PhlareDatasource)(nil)
19+
_ backend.QueryDataHandler = (*PyroscopeDatasource)(nil)
20+
_ backend.CallResourceHandler = (*PyroscopeDatasource)(nil)
21+
_ backend.CheckHealthHandler = (*PyroscopeDatasource)(nil)
22+
_ backend.StreamHandler = (*PyroscopeDatasource)(nil)
2323
)
2424

2525
type ProfilingClient interface {
@@ -30,16 +30,16 @@ type ProfilingClient interface {
3030
GetProfile(ctx context.Context, profileTypeID string, labelSelector string, start int64, end int64, maxNodes *int64) (*ProfileResponse, error)
3131
}
3232

33-
// PhlareDatasource is a datasource for querying application performance profiles.
34-
type PhlareDatasource struct {
33+
// PyroscopeDatasource is a datasource for querying application performance profiles.
34+
type PyroscopeDatasource struct {
3535
httpClient *http.Client
3636
client ProfilingClient
3737
settings backend.DataSourceInstanceSettings
3838
ac accesscontrol.AccessControl
3939
}
4040

41-
// NewPhlareDatasource creates a new datasource instance.
42-
func NewPhlareDatasource(httpClientProvider httpclient.Provider, settings backend.DataSourceInstanceSettings, ac accesscontrol.AccessControl) (instancemgmt.Instance, error) {
41+
// NewPyroscopeDatasource creates a new datasource instance.
42+
func NewPyroscopeDatasource(httpClientProvider httpclient.Provider, settings backend.DataSourceInstanceSettings, ac accesscontrol.AccessControl) (instancemgmt.Instance, error) {
4343
opt, err := settings.HTTPClientOptions()
4444
if err != nil {
4545
return nil, err
@@ -49,15 +49,15 @@ func NewPhlareDatasource(httpClientProvider httpclient.Provider, settings backen
4949
return nil, err
5050
}
5151

52-
return &PhlareDatasource{
52+
return &PyroscopeDatasource{
5353
httpClient: httpClient,
54-
client: NewPhlareClient(httpClient, settings.URL),
54+
client: NewPyroscopeClient(httpClient, settings.URL),
5555
settings: settings,
5656
ac: ac,
5757
}, nil
5858
}
5959

60-
func (d *PhlareDatasource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
60+
func (d *PyroscopeDatasource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
6161
logger.Debug("CallResource", "Path", req.Path, "Method", req.Method, "Body", req.Body)
6262
if req.Path == "profileTypes" {
6363
return d.profileTypes(ctx, req, sender)
@@ -73,7 +73,7 @@ func (d *PhlareDatasource) CallResource(ctx context.Context, req *backend.CallRe
7373
})
7474
}
7575

76-
func (d *PhlareDatasource) profileTypes(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
76+
func (d *PyroscopeDatasource) profileTypes(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
7777
types, err := d.client.ProfileTypes(ctx)
7878
if err != nil {
7979
return err
@@ -89,7 +89,7 @@ func (d *PhlareDatasource) profileTypes(ctx context.Context, req *backend.CallRe
8989
return nil
9090
}
9191

92-
func (d *PhlareDatasource) labelNames(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
92+
func (d *PyroscopeDatasource) labelNames(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
9393
res, err := d.client.LabelNames(ctx)
9494
if err != nil {
9595
return fmt.Errorf("error calling LabelNames: %v", err)
@@ -112,7 +112,7 @@ type LabelValuesPayload struct {
112112
End int64
113113
}
114114

115-
func (d *PhlareDatasource) labelValues(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
115+
func (d *PyroscopeDatasource) labelValues(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
116116
u, err := url.Parse(req.URL)
117117
if err != nil {
118118
return err
@@ -138,7 +138,7 @@ func (d *PhlareDatasource) labelValues(ctx context.Context, req *backend.CallRes
138138
// req contains the queries []DataQuery (where each query contains RefID as a unique identifier).
139139
// The QueryDataResponse contains a map of RefID to the response for each query, and each response
140140
// contains Frames ([]*Frame).
141-
func (d *PhlareDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
141+
func (d *PyroscopeDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
142142
logger.Debug("QueryData called", "Queries", req.Queries)
143143

144144
// create response struct
@@ -160,7 +160,7 @@ func (d *PhlareDatasource) QueryData(ctx context.Context, req *backend.QueryData
160160
// The main use case for these health checks is the test button on the
161161
// datasource configuration page which allows users to verify that
162162
// a datasource is working as expected.
163-
func (d *PhlareDatasource) CheckHealth(ctx context.Context, _ *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
163+
func (d *PyroscopeDatasource) CheckHealth(ctx context.Context, _ *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
164164
logger.Debug("CheckHealth called")
165165

166166
status := backend.HealthStatusOk
@@ -179,7 +179,7 @@ func (d *PhlareDatasource) CheckHealth(ctx context.Context, _ *backend.CheckHeal
179179

180180
// SubscribeStream is called when a client wants to connect to a stream. This callback
181181
// allows sending the first message.
182-
func (d *PhlareDatasource) SubscribeStream(_ context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
182+
func (d *PyroscopeDatasource) SubscribeStream(_ context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
183183
logger.Debug("SubscribeStream called")
184184

185185
status := backend.SubscribeStreamStatusPermissionDenied
@@ -194,7 +194,7 @@ func (d *PhlareDatasource) SubscribeStream(_ context.Context, req *backend.Subsc
194194

195195
// RunStream is called once for any open channel. Results are shared with everyone
196196
// subscribed to the same channel.
197-
func (d *PhlareDatasource) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
197+
func (d *PyroscopeDatasource) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
198198
logger.Debug("RunStream called")
199199

200200
// Create the same data frame as for query data.
@@ -231,7 +231,7 @@ func (d *PhlareDatasource) RunStream(ctx context.Context, req *backend.RunStream
231231
}
232232

233233
// PublishStream is called when a client sends a message to the stream.
234-
func (d *PhlareDatasource) PublishStream(_ context.Context, _ *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
234+
func (d *PyroscopeDatasource) PublishStream(_ context.Context, _ *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
235235
logger.Debug("PublishStream called")
236236

237237
// Do not allow publishing at all.

pkg/tsdb/grafana-pyroscope-datasource/instance_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package phlare
1+
package pyroscope
22

33
import (
44
"context"
@@ -10,7 +10,7 @@ import (
1010

1111
// This is where the tests for the datasource backend live.
1212
func Test_QueryData(t *testing.T) {
13-
ds := PhlareDatasource{}
13+
ds := PyroscopeDatasource{}
1414

1515
resp, err := ds.QueryData(
1616
context.Background(),
@@ -30,7 +30,7 @@ func Test_QueryData(t *testing.T) {
3030
}
3131

3232
func Test_CallResource(t *testing.T) {
33-
ds := &PhlareDatasource{
33+
ds := &PyroscopeDatasource{
3434
client: &FakeClient{},
3535
}
3636

pkg/tsdb/grafana-pyroscope-datasource/kinds/dataquery/types_dataquery_gen.go

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/tsdb/grafana-pyroscope-datasource/phlareClient.go pkg/tsdb/grafana-pyroscope-datasource/pyroscopeClient.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package phlare
1+
package pyroscope
22

33
import (
44
"context"
@@ -54,17 +54,17 @@ type SeriesResponse struct {
5454
Label string
5555
}
5656

57-
type PhlareClient struct {
57+
type PyroscopeClient struct {
5858
connectClient querierv1connect.QuerierServiceClient
5959
}
6060

61-
func NewPhlareClient(httpClient *http.Client, url string) *PhlareClient {
62-
return &PhlareClient{
61+
func NewPyroscopeClient(httpClient *http.Client, url string) *PyroscopeClient {
62+
return &PyroscopeClient{
6363
connectClient: querierv1connect.NewQuerierServiceClient(httpClient, url),
6464
}
6565
}
6666

67-
func (c *PhlareClient) ProfileTypes(ctx context.Context) ([]*ProfileType, error) {
67+
func (c *PyroscopeClient) ProfileTypes(ctx context.Context) ([]*ProfileType, error) {
6868
res, err := c.connectClient.ProfileTypes(ctx, connect.NewRequest(&querierv1.ProfileTypesRequest{}))
6969
if err != nil {
7070
return nil, err
@@ -84,7 +84,7 @@ func (c *PhlareClient) ProfileTypes(ctx context.Context) ([]*ProfileType, error)
8484
}
8585
}
8686

87-
func (c *PhlareClient) GetSeries(ctx context.Context, profileTypeID string, labelSelector string, start int64, end int64, groupBy []string, step float64) (*SeriesResponse, error) {
87+
func (c *PyroscopeClient) GetSeries(ctx context.Context, profileTypeID string, labelSelector string, start int64, end int64, groupBy []string, step float64) (*SeriesResponse, error) {
8888
req := connect.NewRequest(&querierv1.SelectSeriesRequest{
8989
ProfileTypeID: profileTypeID,
9090
LabelSelector: labelSelector,
@@ -133,7 +133,7 @@ func (c *PhlareClient) GetSeries(ctx context.Context, profileTypeID string, labe
133133
}, nil
134134
}
135135

136-
func (c *PhlareClient) GetProfile(ctx context.Context, profileTypeID, labelSelector string, start, end int64, maxNodes *int64) (*ProfileResponse, error) {
136+
func (c *PyroscopeClient) GetProfile(ctx context.Context, profileTypeID, labelSelector string, start, end int64, maxNodes *int64) (*ProfileResponse, error) {
137137
req := &connect.Request[querierv1.SelectMergeStacktracesRequest]{
138138
Msg: &querierv1.SelectMergeStacktracesRequest{
139139
ProfileTypeID: profileTypeID,
@@ -179,7 +179,7 @@ func getUnits(profileTypeID string) string {
179179
return unit
180180
}
181181

182-
func (c *PhlareClient) LabelNames(ctx context.Context) ([]string, error) {
182+
func (c *PyroscopeClient) LabelNames(ctx context.Context) ([]string, error) {
183183
resp, err := c.connectClient.LabelNames(ctx, connect.NewRequest(&querierv1.LabelNamesRequest{}))
184184
if err != nil {
185185
return nil, fmt.Errorf("error seding LabelNames request %v", err)
@@ -195,7 +195,7 @@ func (c *PhlareClient) LabelNames(ctx context.Context) ([]string, error) {
195195
return filtered, nil
196196
}
197197

198-
func (c *PhlareClient) LabelValues(ctx context.Context, label string) ([]string, error) {
198+
func (c *PyroscopeClient) LabelValues(ctx context.Context, label string) ([]string, error) {
199199
resp, err := c.connectClient.LabelValues(ctx, connect.NewRequest(&querierv1.LabelValuesRequest{Name: label}))
200200
if err != nil {
201201
return nil, err

pkg/tsdb/grafana-pyroscope-datasource/phlareClient_test.go pkg/tsdb/grafana-pyroscope-datasource/pyroscopeClient_test.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package phlare
1+
package pyroscope
22

33
import (
44
"context"
@@ -11,9 +11,9 @@ import (
1111
"github.com/stretchr/testify/require"
1212
)
1313

14-
func Test_PhlareClient(t *testing.T) {
15-
connectClient := &FakePhlareConnectClient{}
16-
client := &PhlareClient{
14+
func Test_PyroscopeClient(t *testing.T) {
15+
connectClient := &FakePyroscopeConnectClient{}
16+
client := &PyroscopeClient{
1717
connectClient: connectClient,
1818
}
1919

@@ -53,27 +53,27 @@ func Test_PhlareClient(t *testing.T) {
5353
})
5454
}
5555

56-
type FakePhlareConnectClient struct {
56+
type FakePyroscopeConnectClient struct {
5757
Req any
5858
}
5959

60-
func (f *FakePhlareConnectClient) ProfileTypes(ctx context.Context, c *connect.Request[querierv1.ProfileTypesRequest]) (*connect.Response[querierv1.ProfileTypesResponse], error) {
60+
func (f *FakePyroscopeConnectClient) ProfileTypes(ctx context.Context, c *connect.Request[querierv1.ProfileTypesRequest]) (*connect.Response[querierv1.ProfileTypesResponse], error) {
6161
panic("implement me")
6262
}
6363

64-
func (f *FakePhlareConnectClient) LabelValues(ctx context.Context, c *connect.Request[querierv1.LabelValuesRequest]) (*connect.Response[querierv1.LabelValuesResponse], error) {
64+
func (f *FakePyroscopeConnectClient) LabelValues(ctx context.Context, c *connect.Request[querierv1.LabelValuesRequest]) (*connect.Response[querierv1.LabelValuesResponse], error) {
6565
panic("implement me")
6666
}
6767

68-
func (f *FakePhlareConnectClient) LabelNames(context.Context, *connect.Request[querierv1.LabelNamesRequest]) (*connect.Response[querierv1.LabelNamesResponse], error) {
68+
func (f *FakePyroscopeConnectClient) LabelNames(context.Context, *connect.Request[querierv1.LabelNamesRequest]) (*connect.Response[querierv1.LabelNamesResponse], error) {
6969
panic("implement me")
7070
}
7171

72-
func (f *FakePhlareConnectClient) Series(ctx context.Context, c *connect.Request[querierv1.SeriesRequest]) (*connect.Response[querierv1.SeriesResponse], error) {
72+
func (f *FakePyroscopeConnectClient) Series(ctx context.Context, c *connect.Request[querierv1.SeriesRequest]) (*connect.Response[querierv1.SeriesResponse], error) {
7373
panic("implement me")
7474
}
7575

76-
func (f *FakePhlareConnectClient) SelectMergeStacktraces(ctx context.Context, c *connect.Request[querierv1.SelectMergeStacktracesRequest]) (*connect.Response[querierv1.SelectMergeStacktracesResponse], error) {
76+
func (f *FakePyroscopeConnectClient) SelectMergeStacktraces(ctx context.Context, c *connect.Request[querierv1.SelectMergeStacktracesRequest]) (*connect.Response[querierv1.SelectMergeStacktracesResponse], error) {
7777
f.Req = c
7878
return &connect.Response[querierv1.SelectMergeStacktracesResponse]{
7979
Msg: &querierv1.SelectMergeStacktracesResponse{
@@ -91,7 +91,7 @@ func (f *FakePhlareConnectClient) SelectMergeStacktraces(ctx context.Context, c
9191
}, nil
9292
}
9393

94-
func (f *FakePhlareConnectClient) SelectSeries(ctx context.Context, req *connect.Request[querierv1.SelectSeriesRequest]) (*connect.Response[querierv1.SelectSeriesResponse], error) {
94+
func (f *FakePyroscopeConnectClient) SelectSeries(ctx context.Context, req *connect.Request[querierv1.SelectSeriesRequest]) (*connect.Response[querierv1.SelectSeriesResponse], error) {
9595
f.Req = req
9696
return &connect.Response[querierv1.SelectSeriesResponse]{
9797
Msg: &querierv1.SelectSeriesResponse{
@@ -105,6 +105,6 @@ func (f *FakePhlareConnectClient) SelectSeries(ctx context.Context, req *connect
105105
}, nil
106106
}
107107

108-
func (f *FakePhlareConnectClient) SelectMergeProfile(ctx context.Context, c *connect.Request[querierv1.SelectMergeProfileRequest]) (*connect.Response[googlev1.Profile], error) {
108+
func (f *FakePyroscopeConnectClient) SelectMergeProfile(ctx context.Context, c *connect.Request[querierv1.SelectMergeProfileRequest]) (*connect.Response[googlev1.Profile], error) {
109109
panic("implement me")
110110
}

pkg/tsdb/grafana-pyroscope-datasource/query.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package phlare
1+
package pyroscope
22

33
import (
44
"context"
@@ -27,13 +27,13 @@ type dsJsonModel struct {
2727
}
2828

2929
const (
30-
queryTypeProfile = string(dataquery.PhlareQueryTypeProfile)
31-
queryTypeMetrics = string(dataquery.PhlareQueryTypeMetrics)
32-
queryTypeBoth = string(dataquery.PhlareQueryTypeBoth)
30+
queryTypeProfile = string(dataquery.PyroscopeQueryTypeProfile)
31+
queryTypeMetrics = string(dataquery.PyroscopeQueryTypeMetrics)
32+
queryTypeBoth = string(dataquery.PyroscopeQueryTypeBoth)
3333
)
3434

35-
// query processes single Phlare query transforming the response to data.Frame packaged in DataResponse
36-
func (d *PhlareDatasource) query(ctx context.Context, pCtx backend.PluginContext, query backend.DataQuery) backend.DataResponse {
35+
// query processes single Pyroscope query transforming the response to data.Frame packaged in DataResponse
36+
func (d *PyroscopeDatasource) query(ctx context.Context, pCtx backend.PluginContext, query backend.DataQuery) backend.DataResponse {
3737
var qm queryModel
3838
response := backend.DataResponse{}
3939

@@ -118,7 +118,7 @@ func (d *PhlareDatasource) query(ctx context.Context, pCtx backend.PluginContext
118118
return response
119119
}
120120

121-
// responseToDataFrames turns Phlare response to data.Frame. We encode the data into a nested set format where we have
121+
// responseToDataFrames turns Pyroscope response to data.Frame. We encode the data into a nested set format where we have
122122
// [level, value, label] columns and by ordering the items in a depth first traversal order we can recreate the whole
123123
// tree back.
124124
func responseToDataFrames(resp *ProfileResponse) *data.Frame {
@@ -151,7 +151,7 @@ type ProfileTree struct {
151151
}
152152

153153
// levelsToTree converts flamebearer format into a tree. This is needed to then convert it into nested set format
154-
// dataframe. This should be temporary, and ideally we should get some sort of tree struct directly from Phlare API.
154+
// dataframe. This should be temporary, and ideally we should get some sort of tree struct directly from Pyroscope API.
155155
func levelsToTree(levels []*Level, names []string) *ProfileTree {
156156
if len(levels) == 0 {
157157
return nil

0 commit comments

Comments
 (0)