Skip to content

[ENHANCEMENT] Add request jitter to prevent bursts #48

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

Open
abelyakin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[ENHANCEMENT] Add request jitter to prevent bursts #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions plugin-system/src/runtime/log-queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { useDatasourceStore } from './datasources';
import { usePluginRegistry } from './plugin-registry';
import { useTimeRange } from './TimeRangeProvider';
import { useVariableValues } from './variables';
import { jitterDelay } from './utils';

export type LogQueryDefinition<PluginSpec = UnknownSpec> = QueryDefinition<'LogQuery', PluginSpec>;
export const LOG_QUERY_KEY = 'LogQuery';
Expand Down Expand Up @@ -46,6 +47,7 @@ export function useLogQueries(definitions: LogQueryDefinition[]): Array<UseQuery
refetchOnReconnect: false,
staleTime: Infinity,
queryFn: async ({ signal }: { signal?: AbortSignal }): Promise<LogQueryResult> => {
await jitterDelay();
const plugin = await getPlugin(LOG_QUERY_KEY, logQueryKind);
const data = await plugin.getLogData(definition.spec.plugin.spec, context, signal);
return data;
Expand Down
2 changes: 2 additions & 0 deletions plugin-system/src/runtime/profile-queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { useQueries, UseQueryResult } from '@tanstack/react-query';
import { useDatasourceStore } from './datasources';
import { usePluginRegistry } from './plugin-registry';
import { useTimeRange } from './TimeRangeProvider';
import { jitterDelay } from './utils';
export type ProfileQueryDefinition<PluginSpec = UnknownSpec> = QueryDefinition<'ProfileQuery', PluginSpec>;
export const PROFILE_QUERY_KEY = 'ProfileQuery';

Expand Down Expand Up @@ -46,6 +47,7 @@ export function useProfileQueries(definitions: ProfileQueryDefinition[]): Array<
refetchOnReconnect: false,
staleTime: Infinity,
queryFn: async ({ signal }: { signal?: AbortSignal }): Promise<ProfileData> => {
await jitterDelay();
const plugin = await getPlugin(PROFILE_QUERY_KEY, profileQueryKind);
const data = await plugin.getProfileData(definition.spec.plugin.spec, context, signal);
return data;
Expand Down
3 changes: 2 additions & 1 deletion plugin-system/src/runtime/time-series-queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import { TimeSeriesDataQuery, TimeSeriesQueryContext, TimeSeriesQueryMode, TimeS
import { useTimeRange } from './TimeRangeProvider';
import { useDatasourceStore } from './datasources';
import { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';
import { filterVariableStateMap, getVariableValuesKey } from './utils';
import { filterVariableStateMap, getVariableValuesKey, jitterDelay } from './utils';
import { useAllVariableValues } from './variables';

export interface UseTimeSeriesQueryOptions {
Expand Down Expand Up @@ -139,6 +139,7 @@ export function useTimeSeriesQueries(
staleTime: Infinity,
queryKey: queryKey,
queryFn: async ({ signal }: { signal: AbortSignal }): Promise<TimeSeriesData> => {
await jitterDelay();
const plugin = await getPlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, context, signal);
return data;
Expand Down
3 changes: 2 additions & 1 deletion plugin-system/src/runtime/trace-queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { useDatasourceStore } from './datasources';
import { usePluginRegistry, usePlugins } from './plugin-registry';
import { useTimeRange } from './TimeRangeProvider';
import { useAllVariableValues } from './variables';
import { filterVariableStateMap, getVariableValuesKey } from './utils';
import { filterVariableStateMap, getVariableValuesKey, jitterDelay } from './utils';
export type TraceQueryDefinition<PluginSpec = UnknownSpec> = QueryDefinition<'TraceQuery', PluginSpec>;
export const TRACE_QUERY_KEY = 'TraceQuery';

Expand Down Expand Up @@ -51,6 +51,7 @@ export function useTraceQueries(definitions: TraceQueryDefinition[]): Array<UseQ
refetchOnReconnect: false,
staleTime: Infinity,
queryFn: async ({ signal }: { signal?: AbortSignal }): Promise<TraceData> => {
await jitterDelay();
const plugin = await getPlugin(TRACE_QUERY_KEY, traceQueryKind);
const data = await plugin.getTraceData(definition.spec.plugin.spec, context, signal);
return data;
Expand Down
18 changes: 18 additions & 0 deletions plugin-system/src/runtime/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,21 @@ export function getVariableValuesKey(v: VariableStateMap): string {
.map((v) => JSON.stringify(v.value))
.join(',');
}

/**
* Adds a random jitter delay to distribute query requests over time.
* This helps reduce server load by preventing all panels from firing queries in bursts.
*/
export function jitterDelay(minMs = 0, maxMs = 500): Promise<void> {
const safeMin = Number.isFinite(minMs) ? minMs : 0;
const safeMax = Number.isFinite(maxMs) ? maxMs : 0;
const normalizedMin = Math.max(0, Math.min(safeMin, safeMax));
const normalizedMax = Math.max(0, Math.max(safeMin, safeMax));

if (normalizedMax === 0) {
return Promise.resolve();
}

const delay = Math.floor(Math.random() * (normalizedMax - normalizedMin + 1)) + normalizedMin;
return new Promise((resolve) => setTimeout(resolve, delay));
}