Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Aggregated metrics: Use sum_over_time query for aggregated metric queries #789

Merged
merged 5 commits into from
Sep 20, 2024
Merged

Aggregated metrics: Use sum_over_time query for aggregated metric queries #789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a97a501
chore: rebuild body with sum_over_time query when aggregated metric i…
gtk-grafana Sep 19, 2024
903c473
chore: hardcode service name so queries aren't fired and cancelled be…
gtk-grafana Sep 19, 2024
d0b2b58
chore: no need to drop errors in these queries
gtk-grafana Sep 19, 2024
4db7901
Merge remote-tracking branch 'origin/main' into gtk-grafana/aggregate…
gtk-grafana Sep 19, 2024
1ca94c0
chore: rename `serviceName` to `serviceLabel`
svennergr Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 35 additions & 15 deletions src/Components/ServiceSelectionScene/ServiceSelectionScene.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ import { getFavoriteServicesFromStorage } from 'services/store';
import {
getDataSourceVariable,
getLabelsVariable,
getServiceNameVariable,
getServiceLabelVariable,
getServiceSelectionStringVariable,
LEVEL_VARIABLE_VALUE,
SERVICE_NAME,
SERVICE_NAME_EXPR,
SERVICE_NAME_VAR,
SERVICE_LABEL_EXPR,
SERVICE_LABEL_VAR,
VAR_SERVICE,
VAR_SERVICE_EXPR,
} from 'services/variables';
Expand Down Expand Up @@ -85,9 +85,9 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
value: '',
skipUrlSync: true,
}),
// Service name variable
// variable to store the service label to use
new CustomConstantVariable({
name: SERVICE_NAME_VAR,
name: SERVICE_LABEL_VAR,
label: '',
hide: VariableHide.hideLabel,
value: SERVICE_NAME,
Expand All @@ -106,7 +106,7 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
],
}),
$data: getSceneQueryRunner({
queries: [buildResourceQuery(`{${SERVICE_NAME_EXPR}=~\`.*${VAR_SERVICE_EXPR}.*\`}`, 'volume')],
queries: [buildResourceQuery(`{${SERVICE_LABEL_EXPR}=~\`.*${VAR_SERVICE_EXPR}.*\`}`, 'volume')],
runQueriesMode: 'manual',
}),
serviceLevel: new Map<string, string[]>(),
Expand Down Expand Up @@ -176,6 +176,20 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
}
})
);

// agg metrics need parser and unwrap, have to tear down and rebuild panels when the variable changes
this._subs.add(
getServiceLabelVariable(this).subscribeToState((newState, prevState) => {
if (newState.value !== prevState.value) {
// Clear the body panels
this.setState({
body: new SceneCSSGridLayout({ children: [] }),
});
// And re-init with the new query
this.updateBody();
}
})
);
}
}

Expand Down Expand Up @@ -218,12 +232,11 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
const aggregatedMetricsActive =
!toolbar?.state.options.aggregatedMetrics.disabled && toolbar?.state.options.aggregatedMetrics.active;

const serviceLabelVar = getServiceLabelVariable(this);
if ((!this.isTimeRangeTooEarlyForAggMetrics() || !aggregatedMetricsEnabled) && aggregatedMetricsActive) {
const serviceName = getServiceNameVariable(this);
serviceName.changeValueTo(AGGREGATED_SERVICE_NAME);
serviceLabelVar.changeValueTo(AGGREGATED_SERVICE_NAME);
} else {
const serviceName = getServiceNameVariable(this);
serviceName.changeValueTo(SERVICE_NAME);
serviceLabelVar.changeValueTo(SERVICE_NAME);
}
this.state.$data.runQueries();
}
Expand All @@ -238,6 +251,7 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
const newChildren: SceneCSSGridItem[] = [];
const existingChildren: SceneCSSGridItem[] = this.state.body.state.children as SceneCSSGridItem[];
const timeRange = sceneGraph.getTimeRange(this).state.value;
const serviceLabelVar = getServiceLabelVariable(this);

for (const service of servicesToQuery.slice(0, SERVICES_LIMIT)) {
const existing = existingChildren.filter((child) => {
Expand All @@ -250,7 +264,10 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
newChildren.push(existing[0], existing[1]);
} else {
// for each service, we create a layout with timeseries and logs panel
newChildren.push(this.buildServiceLayout(service, timeRange), this.buildServiceLogsLayout(service));
newChildren.push(
this.buildServiceLayout(service, timeRange, serviceLabelVar),
this.buildServiceLogsLayout(service)
);
}
}

Expand Down Expand Up @@ -292,8 +309,11 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
return `{${SERVICE_NAME}=\`${service}\`}${levelFilter}`;
}

private getMetricExpression(service: string) {
return `sum by (${LEVEL_VARIABLE_VALUE}) (count_over_time({${SERVICE_NAME_EXPR}=\`${service}\`} | drop __error__ [$__auto]))`;
private getMetricExpression(service: string, serviceLabelVar: CustomConstantVariable) {
if (serviceLabelVar.state.value === AGGREGATED_SERVICE_NAME) {
return `sum by (${LEVEL_VARIABLE_VALUE}) (sum_over_time({${AGGREGATED_SERVICE_NAME}=\`${service}\`} | logfmt | unwrap count [$__auto]))`;
}
return `sum by (${LEVEL_VARIABLE_VALUE}) (count_over_time({${SERVICE_NAME}=\`${service}\`} [$__auto]))`;
}

private extendTimeSeriesLegendBus = (service: string, context: PanelContext, panel: VizPanel) => {
Expand All @@ -311,7 +331,7 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
};

// Creates a layout with timeseries panel
buildServiceLayout(service: string, timeRange: TimeRange) {
buildServiceLayout(service: string, timeRange: TimeRange, serviceLabelVar: CustomConstantVariable) {
let splitDuration;
if (timeRange.to.diff(timeRange.from, 'hours') >= 4 && timeRange.to.diff(timeRange.from, 'hours') <= 26) {
splitDuration = '2h';
Expand All @@ -321,7 +341,7 @@ export class ServiceSelectionScene extends SceneObjectBase<ServiceSelectionScene
.setTitle(service)
.setData(
getQueryRunner([
buildDataQuery(this.getMetricExpression(service), {
buildDataQuery(this.getMetricExpression(service, serviceLabelVar), {
legendFormat: `{{${LEVEL_VARIABLE_VALUE}}}`,
splitDuration,
refId: `ts-${service}`,
Expand Down
10 changes: 5 additions & 5 deletions src/services/variables.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ export const EXPLORATION_DS = { uid: VAR_DATASOURCE_EXPR };
export const ALL_VARIABLE_VALUE = '$__all';
export const LEVEL_VARIABLE_VALUE = 'detected_level';
export const SERVICE_NAME = 'service_name';
export const SERVICE_NAME_VAR = 'service_name_var';
export const SERVICE_NAME_EXPR = '${service_name_var}';
export const SERVICE_LABEL_VAR = 'service_label_var';
export const SERVICE_LABEL_EXPR = '${service_label_var}';
export const EMPTY_VARIABLE_VALUE = '""';

export type ParserType = 'logfmt' | 'json' | 'mixed' | 'structuredMetadata';
Expand Down Expand Up @@ -108,10 +108,10 @@ export function getLabelGroupByVariable(scene: SceneObject) {
return variable;
}

export function getServiceNameVariable(scene: SceneObject) {
const variable = sceneGraph.lookupVariable(SERVICE_NAME_VAR, scene);
export function getServiceLabelVariable(scene: SceneObject) {
const variable = sceneGraph.lookupVariable(SERVICE_LABEL_VAR, scene);
if (!(variable instanceof CustomConstantVariable)) {
throw new Error('SERVICE_NAME_VAR not found');
throw new Error('SERVICE_LABEL_VAR not found');
}
return variable;
}
Expand Down
Loading