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

Bug 2020483: Monitoring dashboards: Improve display text for interval variables #10472

Merged
merged 1 commit into from
May 19, 2022
Merged

Bug 2020483: Monitoring dashboards: Improve display text for interval variables #10472

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
51 changes: 33 additions & 18 deletions frontend/public/components/monitoring/dashboards/index.tsx
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@ import {
CardHeader,
CardTitle,
CardActions,
Tooltip,
} from '@patternfly/react-core';
import { AngleDownIcon, AngleRightIcon } from '@patternfly/react-icons';
import * as React from 'react';
Expand Down Expand Up @@ -70,6 +71,11 @@ import { getActivePerspective, getAllVariables } from './monitoring-dashboard-ut

const NUM_SAMPLES = 30;

const intervalVariableRegExps = ['__interval', '__rate_interval', '__auto_interval_[a-z]+'];

const isIntervalVariable = (itemKey: string): boolean =>
_.some(intervalVariableRegExps, (re) => itemKey?.match(new RegExp(`\\$${re}`, 'g')));

const evaluateTemplate = (
template: string,
variables: ImmutableMap<string, Variable>,
Expand All @@ -79,28 +85,26 @@ const evaluateTemplate = (
return undefined;
}

// Handle the special `$__interval` and `$__rate_interval` variables
const intervalMS = timespan / NUM_SAMPLES;
const intervalMinutes = Math.floor(intervalMS / 1000 / 60);
// Use a minimum of 5m to make sure we have enough data to perform `irate` calculations, which
// require 2 data points each. Otherwise, there could be gaps in the graph.
const interval: Variable = { value: `${Math.max(intervalMinutes, 5)}m` };
const range: Variable = { value: `${Math.floor(timespan / 1000)}s` };
const allVariables = {
...variables.toJS(),
__interval: interval,
__range: range,
/* eslint-disable camelcase */
__range_ms: range,
__range_s: range,
__rate_interval: interval,
/* eslint-enable camelcase */

// This is last to ensure it is applied after all other variable substitutions (because the
// other variable substitutions may result in "$__auto_interval_*" being inserted)
'__auto_interval_[a-z]+': interval,
};

// Handle the special "interval" variables
const intervalMS = timespan / NUM_SAMPLES;
const intervalMinutes = Math.floor(intervalMS / 1000 / 60);
// Use a minimum of 5m to make sure we have enough data to perform `irate` calculations, which
// require 2 data points each. Otherwise, there could be gaps in the graph.
const interval: Variable = { value: `${Math.max(intervalMinutes, 5)}m` };
// Add these last to ensure they are applied after other variable substitutions (because the other
// variable substitutions may result in interval variables like $__interval being inserted)
intervalVariableRegExps.forEach((k) => (allVariables[k] = interval));

let result = template;
_.each(allVariables, (v, k) => {
const re = new RegExp(`\\$${k}`, 'g');
Expand Down Expand Up @@ -163,7 +167,11 @@ const FilterSelect: React.FC<FilterSelectProps> = ({
onTypeaheadInputChanged={(v) => setFilterText(v.toLowerCase())}
placeholderText={
Object.keys(items).includes(selectedKey) ? (
items[selectedKey]
isIntervalVariable(selectedKey) ? (
'Auto interval'
) : (
items[selectedKey]
)
) : (
<>
<RedExclamationCircleIcon /> {t('public~Select a dashboard from the dropdown')}
Expand All @@ -178,11 +186,18 @@ const FilterSelect: React.FC<FilterSelectProps> = ({
);
};

const VariableOption = ({ itemKey }) => (
<SelectOption key={itemKey} value={itemKey}>
{itemKey === MONITORING_DASHBOARDS_VARIABLE_ALL_OPTION_KEY ? 'All' : itemKey}
</SelectOption>
);
const VariableOption = ({ itemKey }) =>
isIntervalVariable(itemKey) ? (
<Tooltip content={itemKey}>
<SelectOption key={itemKey} value={itemKey}>
Auto interval
</SelectOption>
</Tooltip>
) : (
<SelectOption key={itemKey} value={itemKey}>
{itemKey === MONITORING_DASHBOARDS_VARIABLE_ALL_OPTION_KEY ? 'All' : itemKey}
</SelectOption>
);

const VariableDropdown: React.FC<VariableDropdownProps> = ({ id, name, namespace }) => {
const { t } = useTranslation();
Expand Down