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

Prometheus: Fix ad-hoc filters (#66521)

Browse Source 
* refactor label names back to getTagKeys to fulfill contract with parent class required for ad-hoc functionality
This commit is contained in:
Galen Kistler 2023-04-13 15:05:20 -05:00 committed by GitHub
parent d208324331
commit 4a7f27489e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
public/app/plugins/datasource/prometheus/components/VariableQueryEditor.tsx
View File

@ -72,7 +72,7 @@ export const PromVariableQueryEditor = ({ onChange, query, datasource }: Props)
return;
}
datasource.getLabelNames().then((labelNames: Array<{ text: string }>) => {
datasource.getTagKeys().then((labelNames: Array<{ text: string }>) => {
setLabelOptions(labelNames.map(({ text }) => ({ label: text, value: text })));
});
}, [datasource, qryType]);

12
public/app/plugins/datasource/prometheus/datasource.test.ts
View File

@ -94,6 +94,16 @@ describe('PrometheusDatasource', () => {
ds = new PrometheusDatasource(instanceSettings, templateSrvStub, timeSrvStub);
});
// Some functions are required by the parent datasource class to provide functionality such as ad-hoc filters, which requires the definition of the getTagKeys, and getTagValues functions
describe('Datasource contract', () => {
it('has function called getTagKeys', () => {
expect(Object.getOwnPropertyNames(Object.getPrototypeOf(ds))).toContain('getTagKeys');
});
it('has function called getTagValues', () => {
expect(Object.getOwnPropertyNames(Object.getPrototypeOf(ds))).toContain('getTagValues');
});
});
describe('Query', () => {
it('returns empty array when no queries', async () => {
await expect(ds.query(createDataRequest([]))).toEmitValuesWith((response) => {
@ -167,7 +177,7 @@ describe('PrometheusDatasource', () => {
).rejects.toMatchObject({
message: expect.stringMatching('Browser access'),
});
await expect(directDs.getLabelNames()).rejects.toMatchObject({
await expect(directDs.getTagKeys()).rejects.toMatchObject({
message: expect.stringMatching('Browser access'),
});
await expect(directDs.getTagValues()).rejects.toMatchObject({

4
public/app/plugins/datasource/prometheus/datasource.tsx
View File

@ -934,10 +934,11 @@ export class PrometheusDatasource
);
}
// By implementing getTagKeys and getTagValues we add ad-hoc filters functionality
// this is used to get label keys, a.k.a label names
// it is used in metric_find_query.ts
// and in Tempo here grafana/public/app/plugins/datasource/tempo/QueryEditor/ServiceGraphSection.tsx
async getLabelNames(options?: any) {
async getTagKeys(options?: any) {
if (options?.series) {
// Get tags for the provided series only
const seriesLabels: Array<Record<string, string[]>> = await Promise.all(
@ -956,6 +957,7 @@ export class PrometheusDatasource
}
}
// By implementing getTagKeys and getTagValues we add ad-hoc filters functionality
async getTagValues(options: { key?: string } = {}) {
const params = this.getTimeRangeParams();
const result = await this.metadataRequest(`/api/v1/label/${options.key}/values`, params);

2
public/app/plugins/datasource/prometheus/metric_find_query.ts
View File

@ -25,7 +25,7 @@ export default class PrometheusMetricFindQuery {
const queryResultRegex = /^query_result\((.+)\)\s*$/;
const labelNamesQuery = this.query.match(labelNamesRegex);
if (labelNamesQuery) {
return this.datasource.getLabelNames();
return this.datasource.getTagKeys();
}
const labelValuesQuery = this.query.match(labelValuesRegex);

2
public/app/plugins/datasource/tempo/QueryEditor/ServiceGraphSection.tsx
View File

@ -29,7 +29,7 @@ export function ServiceGraphSection({
const [hasKeys, setHasKeys] = useState<boolean | undefined>(undefined);
useEffect(() => {
async function fn(ds: PrometheusDatasource) {
const keys = await ds.getLabelNames({
const keys = await ds.getTagKeys({
series: [
'traces_service_graph_request_server_seconds_sum',
'traces_service_graph_request_total',