IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Zipkin: Remove frontend query running code (#99557)

Browse Source 
* Zipkin: Remove frontend query running code

* Fix lint
This commit is contained in:
Ivana Huckova 2025-01-28 15:11:10 +01:00 committed by GitHub
parent 52a6c27d99
commit 058d3946b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 48 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.betterer.results
View File

@ -7550,8 +7550,7 @@ exports[`better eslint`] = {
[0, 0, 0, "Unexpected any. Specify a different type.", "2"]
],
"public/app/plugins/datasource/zipkin/datasource.ts:5381": [
[0, 0, 0, "Do not use any type assertions.", "0"],
[0, 0, 0, "Unexpected any. Specify a different type.", "1"]
[0, 0, 0, "Do not use any type assertions.", "0"]
],
"public/app/plugins/datasource/zipkin/utils/transforms.ts:5381": [
[0, 0, 0, "Unexpected any. Specify a different type.", "0"]

1
docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md
View File

@ -81,7 +81,6 @@ Most [generally available](https://grafana.com/docs/release-life-cycle/#general-
| `userStorageAPI` | Enables the user storage API | Yes |
| `azureMonitorDisableLogLimit` | Disables the log limit restriction for Azure Monitor when true. The limit is enabled by default. | |
| `preinstallAutoUpdate` | Enables automatic updates for pre-installed plugins | Yes |
| `zipkinBackendMigration` | Enables querying Zipkin data source without the proxy | Yes |
| `reportingUseRawTimeRange` | Uses the original report or dashboard time range instead of making an absolute transformation | Yes |
| `alertingUIOptimizeReducer` | Enables removing the reducer from the alerting UI when creating a new alert rule and using instant query | Yes |
| `azureMonitorEnableUserAuth` | Enables user auth for Azure Monitor datasource only | Yes |

1
packages/grafana-data/src/types/featureToggles.gen.ts
View File

@ -229,7 +229,6 @@ export interface FeatureToggles {
exploreMetricsRelatedLogs?: boolean;
prometheusSpecialCharsInLabelValues?: boolean;
enableExtensionsAdminPage?: boolean;
zipkinBackendMigration?: boolean;
enableSCIM?: boolean;
crashDetection?: boolean;
jaegerBackendMigration?: boolean;

7
pkg/services/featuremgmt/registry.go
View File

@ -1587,13 +1587,6 @@ var (
Owner: grafanaPluginsPlatformSquad,
RequiresRestart: true,
},
{
Name: "zipkinBackendMigration",
Description: "Enables querying Zipkin data source without the proxy",
Stage: FeatureStageGeneralAvailability,
Owner: grafanaOSSBigTent,
Expression: "true", // enabled by default
},
{
Name: "enableSCIM",
Description: "Enables SCIM support for user and group management",

1
pkg/services/featuremgmt/toggles_gen.csv
View File

@ -210,7 +210,6 @@ passwordlessMagicLinkAuthentication,experimental,@grafana/identity-access-team,f
exploreMetricsRelatedLogs,experimental,@grafana/observability-metrics,false,false,true
prometheusSpecialCharsInLabelValues,experimental,@grafana/oss-big-tent,false,false,true
enableExtensionsAdminPage,experimental,@grafana/plugins-platform-backend,false,true,false
zipkinBackendMigration,GA,@grafana/oss-big-tent,false,false,false
enableSCIM,experimental,@grafana/identity-access-team,false,false,false
crashDetection,experimental,@grafana/observability-traces-and-profiling,false,false,true
jaegerBackendMigration,experimental,@grafana/oss-big-tent,false,false,false

1 Name Stage Owner requiresDevMode RequiresRestart FrontendOnly
210 exploreMetricsRelatedLogs experimental @grafana/observability-metrics false false true
211 prometheusSpecialCharsInLabelValues experimental @grafana/oss-big-tent false false true
212 enableExtensionsAdminPage experimental @grafana/plugins-platform-backend false true false
zipkinBackendMigration GA @grafana/oss-big-tent false false false
213 enableSCIM experimental @grafana/identity-access-team false false false
214 crashDetection experimental @grafana/observability-traces-and-profiling false false true
215 jaegerBackendMigration experimental @grafana/oss-big-tent false false false

4
pkg/services/featuremgmt/toggles_gen.go
View File

@ -851,10 +851,6 @@ const (
// Enables the extension admin page regardless of development mode
FlagEnableExtensionsAdminPage = "enableExtensionsAdminPage"
// FlagZipkinBackendMigration
// Enables querying Zipkin data source without the proxy
FlagZipkinBackendMigration = "zipkinBackendMigration"
// FlagEnableSCIM
// Enables SCIM support for user and group management
FlagEnableSCIM = "enableSCIM"

1
pkg/services/featuremgmt/toggles_gen.json
View File

@ -4062,6 +4062,7 @@
"name": "zipkinBackendMigration",
"resourceVersion": "1733846643829",
"creationTimestamp": "2024-11-07T09:35:53Z",
"deletionTimestamp": "2025-01-27T11:47:54Z",
"annotations": {
"grafana.app/updatedTimestamp": "2024-12-10 16:04:03.82919 +0000 UTC"
}

77
public/app/plugins/datasource/zipkin/datasource.test.ts
View File

@ -1,5 +1,4 @@
import { lastValueFrom, of } from 'rxjs';
import { createFetchResponse } from 'test/helpers/createFetchResponse';
import {
DataFrameView,
@ -8,52 +7,49 @@ import {
DataSourcePluginMeta,
FieldType,
} from '@grafana/data';
import { BackendSrv, TemplateSrv } from '@grafana/runtime';
import { BackendSrv, getBackendSrv, setBackendSrv, TemplateSrv } from '@grafana/runtime';
import { addNodeGraphFramesToResponse, ZipkinDatasource } from './datasource';
import mockJson from './mocks/mockJsonResponse.json';
import { mockTraceDataFrame } from './mocks/mockTraceDataFrame';
import { ZipkinQuery, ZipkinSpan } from './types';
import { traceFrameFields, zipkinResponse } from './utils/testData';
import { ZipkinQuery } from './types';
export const backendSrv = { fetch: jest.fn() } as unknown as BackendSrv;
jest.mock('@grafana/runtime', () => ({
...jest.requireActual('@grafana/runtime'),
getBackendSrv: () => backendSrv,
}));
const templateSrv: TemplateSrv = {
replace: jest.fn().mockImplementation((value) => value),
getVariables: jest.fn(),
containsTemplate: jest.fn(),
updateTimeRange: jest.fn(),
};
describe('ZipkinDatasource', () => {
let origBackendSrv: BackendSrv;
let ds: ZipkinDatasource;
beforeEach(() => {
origBackendSrv = getBackendSrv();
setBackendSrv({ ...origBackendSrv, fetch: jest.fn().mockReturnValue(of({ data: {} })) });
ds = new ZipkinDatasource(defaultSettings, templateSrv);
});
afterEach(() => {
setBackendSrv(origBackendSrv);
jest.clearAllMocks();
});
describe('query', () => {
const templateSrv: TemplateSrv = {
replace: jest.fn(),
getVariables: jest.fn(),
containsTemplate: jest.fn(),
updateTimeRange: jest.fn(),
};
it('runs query', async () => {
setupBackendSrv(zipkinResponse);
const ds = new ZipkinDatasource(defaultSettings, templateSrv);
await expect(ds.query({ targets: [{ query: '12345' }] } as DataQueryRequest<ZipkinQuery>)).toEmitValuesWith(
(val) => {
expect(val[0].data[0].fields).toMatchObject(traceFrameFields);
}
);
});
const origBackendSrv = getBackendSrv();
setBackendSrv({
...origBackendSrv,
fetch: jest.fn().mockReturnValue(of({ data: [] })),
});
it('runs query with traceId that includes special characters', async () => {
setupBackendSrv(zipkinResponse);
const ds = new ZipkinDatasource(defaultSettings, templateSrv);
await expect(ds.query({ targets: [{ query: 'a/b' }] } as DataQueryRequest<ZipkinQuery>)).toEmitValuesWith(
(val) => {
expect(val[0].data[0].fields).toMatchObject(traceFrameFields);
}
);
const response = await lastValueFrom(ds.query({ targets: [{ query: 'test' }] } as DataQueryRequest<ZipkinQuery>));
expect(response).toEqual({
state: 'Done',
data: [],
});
});
it('should handle json file upload', async () => {
const ds = new ZipkinDatasource(defaultSettings);
ds.uploadedJson = JSON.stringify(mockJson);
const response = await lastValueFrom(
ds.query({
@ -67,7 +63,6 @@ describe('ZipkinDatasource', () => {
});
it('should fail on invalid json file upload', async () => {
const ds = new ZipkinDatasource(defaultSettings);
ds.uploadedJson = JSON.stringify({ key: 'value', arr: [] });
const response = await lastValueFrom(
ds.query({
@ -81,7 +76,10 @@ describe('ZipkinDatasource', () => {
describe('metadataRequest', () => {
it('runs query', async () => {
setupBackendSrv(['service 1', 'service 2'] as unknown as ZipkinSpan[]);
setBackendSrv({
...origBackendSrv,
fetch: jest.fn().mockReturnValue(of({ data: ['service 1', 'service 2'] })),
});
const ds = new ZipkinDatasource(defaultSettings);
const response = await ds.metadataRequest('services');
expect(response).toEqual(['service 1', 'service 2']);
@ -118,13 +116,6 @@ describe('addNodeGraphFramesToResponse', () => {
});
});
function setupBackendSrv(response: ZipkinSpan[]) {
const defaultMock = () => of(createFetchResponse(response));
const fetchMock = jest.spyOn(backendSrv, 'fetch');
fetchMock.mockImplementation(defaultMock);
}
const defaultSettings: DataSourceInstanceSettings = {
id: 1,
uid: '1',

66
public/app/plugins/datasource/zipkin/datasource.ts
View File

@ -1,4 +1,4 @@
import { lastValueFrom, Observable, of } from 'rxjs';
import { Observable, of } from 'rxjs';
import { map } from 'rxjs/operators';
import {
@ -9,26 +9,15 @@ import {
FieldType,
createDataFrame,
ScopedVars,
urlUtil,
toDataFrame,
} from '@grafana/data';
import { createNodeGraphFrames, NodeGraphOptions, SpanBarOptions } from '@grafana/o11y-ds-frontend';
import {
BackendSrvRequest,
config,
DataSourceWithBackend,
FetchResponse,
getBackendSrv,
getTemplateSrv,
TemplateSrv,
} from '@grafana/runtime';
import { DataSourceWithBackend, getTemplateSrv, TemplateSrv } from '@grafana/runtime';
import { ZipkinQuery, ZipkinSpan } from './types';
import { createGraphFrames } from './utils/graphTransform';
import { transformResponse } from './utils/transforms';
const apiPrefix = '/api/v2';
export interface ZipkinJsonData extends DataSourceJsonData {
nodeGraph?: NodeGraphOptions;
}
@ -38,7 +27,7 @@ export class ZipkinDatasource extends DataSourceWithBackend<ZipkinQuery, ZipkinJ
nodeGraph?: NodeGraphOptions;
spanBar?: SpanBarOptions;
constructor(
private instanceSettings: DataSourceInstanceSettings<ZipkinJsonData>,
instanceSettings: DataSourceInstanceSettings<ZipkinJsonData>,
private readonly templateSrv: TemplateSrv = getTemplateSrv()
) {
super(instanceSettings);
@ -61,40 +50,24 @@ export class ZipkinDatasource extends DataSourceWithBackend<ZipkinQuery, ZipkinJ
}
if (target.query) {
if (config.featureToggles.zipkinBackendMigration) {
return super.query(options).pipe(
map((response) => {
if (this.nodeGraph?.enabled) {
return addNodeGraphFramesToResponse(response);
}
return response;
})
);
}
const query = this.applyTemplateVariables(target, options.scopedVars);
return this.request<ZipkinSpan[]>(`${apiPrefix}/trace/${encodeURIComponent(query.query)}`).pipe(
map((res) => responseToDataQueryResponse(res, this.nodeGraph?.enabled))
return super.query(options).pipe(
map((response) => {
if (this.nodeGraph?.enabled) {
return addNodeGraphFramesToResponse(response);
}
return response;
})
);
}
return of(emptyDataQueryResponse);
}
async metadataRequest(url: string, params?: Record<string, unknown>) {
if (config.featureToggles.zipkinBackendMigration) {
return await this.getResource(url, params);
}
const urlWithPrefix = `${apiPrefix}/${url}`;
const res = await lastValueFrom(this.request(urlWithPrefix, params, { hideFromInspector: true }));
return res.data;
return await this.getResource(url, params);
}
async testDatasource(): Promise<{ status: string; message: string }> {
if (config.featureToggles.zipkinBackendMigration) {
return await super.testDatasource();
}
await this.metadataRequest('services');
return { status: 'success', message: 'Data source is working' };
return await super.testDatasource();
}
getQueryDisplayText(query: ZipkinQuery): string {
@ -123,21 +96,6 @@ export class ZipkinDatasource extends DataSourceWithBackend<ZipkinQuery, ZipkinJ
query: this.templateSrv.replace(query.query ?? '', scopedVars),
};
}
private request<T = any>(
apiUrl: string,
data?: unknown,
options?: Partial<BackendSrvRequest>
): Observable<FetchResponse<T>> {
const params = data ? urlUtil.serializeParams(data) : '';
const url = `${this.instanceSettings.url}${apiUrl}${params.length ? `?${params}` : ''}`;
const req = {
...options,
url,
};
return getBackendSrv().fetch<T>(req);
}
}
function responseToDataQueryResponse(response: { data: ZipkinSpan[] }, nodeGraph = false): DataQueryResponse {