chore: metrics explorer fixes and improvements (#7334)

This commit is contained in:
Amlan Kumar Nandy 2025-03-18 16:27:14 +05:30 committed by GitHub
parent 5b6b5bf359
commit b3fa1ad60e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 226 additions and 107 deletions

View File

@ -27,8 +27,8 @@ export interface MetricDetails {
}
export enum Temporality {
CUMULATIVE = 'cumulative',
DELTA = 'delta',
CUMULATIVE = 'Cumulative',
DELTA = 'Delta',
}
export interface MetricDetailsAttribute {

View File

@ -30,8 +30,8 @@ export interface MetricsListItemData {
description: string;
type: MetricType;
unit: string;
[TreemapViewType.CARDINALITY]: number;
[TreemapViewType.DATAPOINTS]: number;
[TreemapViewType.TIMESERIES]: number;
[TreemapViewType.SAMPLES]: number;
lastReceived: string;
}

View File

@ -14,18 +14,18 @@ export interface MetricsTreeMapPayload {
export interface MetricsTreeMapResponse {
status: string;
data: {
[TreemapViewType.CARDINALITY]: CardinalityData[];
[TreemapViewType.DATAPOINTS]: DatapointsData[];
[TreemapViewType.TIMESERIES]: TimeseriesData[];
[TreemapViewType.SAMPLES]: SamplesData[];
};
}
export interface CardinalityData {
export interface TimeseriesData {
percentage: number;
total_value: number;
metric_name: string;
}
export interface DatapointsData {
export interface SamplesData {
percentage: number;
metric_name: string;
}

View File

@ -6,7 +6,6 @@ import { MetricType } from './getMetricsList';
export interface UpdateMetricMetadataProps {
description: string;
unit: string;
metricType: MetricType;
temporality: Temporality;
isMonotonic?: boolean;
@ -21,7 +20,7 @@ const updateMetricMetadata = async (
metricName: string,
props: UpdateMetricMetadataProps,
): Promise<SuccessResponse<UpdateMetricMetadataResponse> | ErrorResponse> => {
const response = await axios.put(`/metrics/${metricName}/metadata`, {
const response = await axios.post(`/metrics/${metricName}/metadata`, {
...props,
});

View File

@ -11,7 +11,10 @@ import { useNotifications } from 'hooks/useNotifications';
import { Edit2, Save } from 'lucide-react';
import { useCallback, useMemo, useState } from 'react';
import { METRIC_TYPE_LABEL_MAP } from '../Summary/constants';
import {
METRIC_TYPE_LABEL_MAP,
METRIC_TYPE_VALUES_MAP,
} from '../Summary/constants';
import { MetricTypeRenderer } from '../Summary/utils';
import { METRIC_METADATA_KEYS } from './constants';
import { MetadataProps } from './types';
@ -29,7 +32,6 @@ function Metadata({
] = useState<UpdateMetricMetadataProps>({
metricType: metadata?.metric_type || MetricType.SUM,
description: metadata?.description || '',
unit: metadata?.unit || '',
temporality: metadata?.temporality || Temporality.CUMULATIVE,
});
const { notifications } = useNotifications();
@ -82,7 +84,7 @@ function Metadata({
ellipsis: true,
className: 'metric-metadata-value',
render: (field: { value: string; key: string }): JSX.Element => {
if (!isEditing) {
if (!isEditing || field.key === 'unit') {
if (field.key === 'metric_type') {
return (
<div>
@ -95,9 +97,9 @@ function Metadata({
if (field.key === 'metric_type') {
return (
<Select
options={Object.entries(METRIC_TYPE_LABEL_MAP).map(([key, value]) => ({
options={Object.entries(METRIC_TYPE_VALUES_MAP).map(([key]) => ({
value: key,
label: value,
label: METRIC_TYPE_LABEL_MAP[key as MetricType],
}))}
value={metricMetadata.metricType}
onChange={(value): void => {
@ -167,13 +169,15 @@ function Metadata({
setIsEditing(false);
} else {
notifications.error({
message: 'Failed to update metadata',
message:
'Failed to update metadata, please try again. If the issue persists, please contact support.',
});
}
},
onError: (): void =>
notifications.error({
message: 'Failed to update metadata',
message:
'Failed to update metadata, please try again. If the issue persists, please contact support.',
}),
},
);

View File

@ -31,7 +31,7 @@
.labels-row,
.values-row {
display: grid;
grid-template-columns: 1fr 1fr 2fr 2fr;
grid-template-columns: 1fr 1fr 2fr;
gap: 30px;
align-items: center;
}

View File

@ -18,10 +18,10 @@ import { useSafeNavigate } from 'hooks/useSafeNavigate';
import { Compass, X } from 'lucide-react';
import { useCallback, useMemo } from 'react';
import { formatNumberIntoHumanReadableFormat } from '../Summary/utils';
import AllAttributes from './AllAttributes';
import DashboardsAndAlertsPopover from './DashboardsAndAlertsPopover';
import Metadata from './Metadata';
import TopAttributes from './TopAttributes';
import { MetricDetailsProps } from './types';
import {
formatNumberToCompactFormat,
@ -60,7 +60,16 @@ function MetricDetails({
if (!metric) return null;
const timeSeriesActive = formatNumberToCompactFormat(metric.timeSeriesActive);
const timeSeriesTotal = formatNumberToCompactFormat(metric.timeSeriesTotal);
return `${timeSeriesActive}${timeSeriesTotal} active`;
return (
<Tooltip
title="Active time series are those that have received data points in the last 1
hour."
placement="top"
>
<span>{`${timeSeriesTotal}${timeSeriesActive} active`}</span>
</Tooltip>
);
}, [metric]);
const goToMetricsExplorerwithSelectedMetric = useCallback(() => {
@ -73,17 +82,6 @@ function MetricDetails({
}
}, [metricName, safeNavigate]);
const top5Attributes = useMemo(() => {
if (!metric) return [];
const totalSum =
metric?.attributes.reduce((acc, curr) => acc + curr.valueCount, 0) || 0;
return metric?.attributes.slice(0, 5).map((attr) => ({
key: attr.key,
count: attr.valueCount,
percentage: totalSum === 0 ? 0 : (attr.valueCount / totalSum) * 100,
}));
}, [metric]);
const isMetricDetailsError = metricDetailsError || !metric;
return (
@ -99,6 +97,8 @@ function MetricDetails({
onClick={goToMetricsExplorerwithSelectedMetric}
icon={<Compass size={16} />}
disabled={!metricName}
target="_blank"
rel="noopener noreferrer"
>
Open in Explorer
</Button>
@ -124,7 +124,7 @@ function MetricDetails({
<div className="metric-details-content-grid">
<div className="labels-row">
<Typography.Text type="secondary" className="metric-details-grid-label">
DATAPOINTS
SAMPLES
</Typography.Text>
<Typography.Text type="secondary" className="metric-details-grid-label">
TIME SERIES
@ -135,8 +135,8 @@ function MetricDetails({
</div>
<div className="values-row">
<Typography.Text className="metric-details-grid-value">
<Tooltip title={metric?.samples}>
{metric?.samples.toLocaleString()}
<Tooltip title={metric?.samples.toLocaleString()}>
{formatNumberIntoHumanReadableFormat(metric?.samples)}
</Tooltip>
</Typography.Text>
<Typography.Text className="metric-details-grid-value">
@ -151,7 +151,6 @@ function MetricDetails({
dashboards={metric.dashboards}
alerts={metric.alerts}
/>
<TopAttributes items={top5Attributes} title="Top 5 Attributes" />
<Metadata
metricName={metric?.name}
metadata={metric.metadata}

View File

@ -7,17 +7,29 @@ import { DataSource } from 'types/common/queryBuilder';
export function formatTimestampToReadableDate(timestamp: string): string {
const date = new Date(timestamp);
// Extracting date components
const day = String(date.getDate()).padStart(2, '0');
const month = String(date.getMonth() + 1).padStart(2, '0'); // Months are 0-based
const year = String(date.getFullYear()).slice(-2); // Get last two digits of year
const now = new Date();
const diffInSeconds = Math.floor((now.getTime() - date.getTime()) / 1000);
// Extracting time components
const hours = String(date.getHours()).padStart(2, '0');
const minutes = String(date.getMinutes()).padStart(2, '0');
const seconds = String(date.getSeconds()).padStart(2, '0');
if (diffInSeconds < 60) return 'Few seconds ago';
return `${day}.${month}.${year}${hours}:${minutes}:${seconds}`;
const diffInMinutes = Math.floor(diffInSeconds / 60);
if (diffInMinutes < 60)
return `${diffInMinutes} minute${diffInMinutes > 1 ? 's' : ''} ago`;
const diffInHours = Math.floor(diffInMinutes / 60);
if (diffInHours < 24)
return `${diffInHours} hour${diffInHours > 1 ? 's' : ''} ago`;
const diffInDays = Math.floor(diffInHours / 24);
if (diffInDays === 1) {
return `Yesterday at ${date
.getHours()
.toString()
.padStart(2, '0')}:${date.getMinutes().toString().padStart(2, '0')}`;
}
if (diffInDays < 7) return `${diffInDays} days ago`;
return date.toLocaleDateString();
}
export function formatNumberToCompactFormat(num: number): string {
@ -31,7 +43,10 @@ export function determineIsMonotonic(
metricType: MetricType,
temporality: Temporality,
): boolean {
if (metricType === MetricType.HISTOGRAM) {
if (
metricType === MetricType.HISTOGRAM ||
metricType === MetricType.EXPONENTIAL_HISTOGRAM
) {
return true;
}
if (metricType === MetricType.GAUGE || metricType === MetricType.SUMMARY) {
@ -55,7 +70,7 @@ export function getMetricDetailsQuery(
...initialQueriesMap[DataSource.METRICS].builder.queryData[0],
aggregateAttribute: {
key: metricName,
type: DataTypes.String,
type: '',
id: `${metricName}----string--`,
},
timeAggregation: 'rate',

View File

@ -1,7 +1,7 @@
import { Select } from 'antd';
import { Select, Tooltip } from 'antd';
import QueryBuilderSearch from 'container/QueryBuilder/filters/QueryBuilderSearch';
import DateTimeSelectionV2 from 'container/TopNav/DateTimeSelectionV2';
import { HardHat } from 'lucide-react';
import { HardHat, Info } from 'lucide-react';
import { TREEMAP_VIEW_OPTIONS } from './constants';
import { MetricsSearchProps } from './types';
@ -27,12 +27,20 @@ function MetricsSearch({
hideShareModal
/>
</div>
<QueryBuilderSearch
query={query}
onChange={onChange}
suffixIcon={<HardHat size={16} />}
isMetricsExplorer
/>
<div className="qb-search-container">
<Tooltip
title="Use filters to refine metrics based on attributes. Example: service_name=api - Shows all metrics associated with the API service"
placement="right"
>
<Info size={16} />
</Tooltip>
<QueryBuilderSearch
query={query}
onChange={onChange}
suffixIcon={<HardHat size={16} />}
isMetricsExplorer
/>
</div>
</div>
);
}

View File

@ -4,9 +4,11 @@ import {
Table,
TablePaginationConfig,
TableProps,
Tooltip,
Typography,
} from 'antd';
import { SorterResult } from 'antd/es/table/interface';
import { Info } from 'lucide-react';
import { useCallback } from 'react';
import { MetricsListItemRowData, MetricsTableProps } from './types';
@ -37,8 +39,8 @@ function MetricsTable({
});
} else {
setOrderBy({
columnName: 'type',
order: 'asc',
columnName: 'samples',
order: 'desc',
});
}
},
@ -47,6 +49,17 @@ function MetricsTable({
return (
<div className="metrics-table-container">
<div className="metrics-table-title">
<Typography.Title level={4} className="metrics-table-title">
List View
</Typography.Title>
<Tooltip
title="The table displays all metrics in the selected time range. Each row represents a unique metric, and its metric name, and metadata like description, type, unit, and samples/timeseries cardinality observed in the selected time range."
placement="right"
>
<Info size={16} />
</Tooltip>
</div>
<Table
loading={{
spinning: isLoading,
@ -62,7 +75,6 @@ function MetricsTable({
alt="thinking-emoji"
className="empty-state-svg"
/>
<Typography.Text className="no-metrics-message">
This query had no results. Edit your query and try again!
</Typography.Text>

View File

@ -1,7 +1,8 @@
import { Group } from '@visx/group';
import { Treemap } from '@visx/hierarchy';
import { Empty, Skeleton, Tooltip } from 'antd';
import { Empty, Skeleton, Tooltip, Typography } from 'antd';
import { stratify, treemapBinary } from 'd3-hierarchy';
import { Info } from 'lucide-react';
import { useMemo } from 'react';
import { useWindowSize } from 'react-use';
@ -36,9 +37,9 @@ function MetricsTreemap({
const treemapData = useMemo(() => {
const extracedTreemapData =
(viewType === TreemapViewType.CARDINALITY
? data?.data?.[TreemapViewType.CARDINALITY]
: data?.data?.[TreemapViewType.DATAPOINTS]) || [];
(viewType === TreemapViewType.TIMESERIES
? data?.data?.[TreemapViewType.TIMESERIES]
: data?.data?.[TreemapViewType.SAMPLES]) || [];
return transformTreemapData(extracedTreemapData, viewType);
}, [data, viewType]);
@ -71,8 +72,21 @@ function MetricsTreemap({
}
return (
<div className="metrics-treemap">
<svg width={treemapWidth} height={TREEMAP_HEIGHT}>
<div className="metrics-treemap-container">
<div className="metrics-treemap-title">
<Typography.Title level={4}>Proportion View</Typography.Title>
<Tooltip
title="The treemap displays the proportion of samples/timeseries in the selected time range. Each tile represents a unique metric, and its size indicates the percentage of samples/timeseries it contributes to the total."
placement="right"
>
<Info size={16} />
</Tooltip>
</div>
<svg
width={treemapWidth}
height={TREEMAP_HEIGHT}
className="metrics-treemap"
>
<rect
width={treemapWidth}
height={TREEMAP_HEIGHT}

View File

@ -4,6 +4,23 @@
gap: 16px;
padding: 16px 0;
.metrics-table-title,
.metrics-treemap-title {
display: flex;
align-items: center;
gap: 8px;
margin-bottom: 16px;
.ant-typography {
margin-top: 0;
margin-bottom: 0;
}
.lucide-info {
cursor: pointer;
}
}
.metrics-search-container {
display: flex;
flex-direction: column;
@ -13,13 +30,27 @@
display: flex;
justify-content: space-between;
}
.qb-search-container {
display: flex;
align-items: center;
gap: 8px;
.lucide-info {
cursor: pointer;
}
.query-builder-search-container {
width: 100%;
}
}
}
.metrics-table-container {
margin-left: -16px;
margin-right: -16px;
.ant-table {
margin-left: -16px;
margin-right: -16px;
max-height: 500px;
overflow-y: auto;
.ant-table-thead > tr > th {
@ -61,6 +92,12 @@
background: var(--bg-ink-400);
}
.metric-description-column-value {
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.metric-name-column-value {
color: var(--bg-vanilla-100);
font-family: 'Geist Mono';
@ -150,6 +187,11 @@
}
}
.metrics-treemap {
margin-left: -12px;
margin-right: -12px;
}
.no-metrics-message-container {
display: flex;
flex-direction: column;

View File

@ -7,7 +7,7 @@ import { useGetMetricsTreeMap } from 'hooks/metricsExplorer/useGetMetricsTreeMap
import { useQueryBuilder } from 'hooks/queryBuilder/useQueryBuilder';
import { useQueryOperations } from 'hooks/queryBuilder/useQueryBuilderOperations';
import ErrorBoundaryFallback from 'pages/ErrorBoundaryFallback/ErrorBoundaryFallback';
import { useCallback, useEffect, useMemo, useState } from 'react';
import { useCallback, useMemo, useState } from 'react';
import { useSelector } from 'react-redux';
import { AppState } from 'store/reducers';
import { TagFilter } from 'types/api/queryBuilder/queryBuilderData';
@ -28,11 +28,11 @@ function Summary(): JSX.Element {
const { pageSize, setPageSize } = usePageSize('metricsExplorer');
const [currentPage, setCurrentPage] = useState(1);
const [orderBy, setOrderBy] = useState<OrderByPayload>({
columnName: 'type',
order: 'asc',
columnName: 'samples',
order: 'desc',
});
const [heatmapView, setHeatmapView] = useState<TreemapViewType>(
TreemapViewType.CARDINALITY,
TreemapViewType.TIMESERIES,
);
const [isMetricDetailsOpen, setIsMetricDetailsOpen] = useState(false);
const [selectedMetricName, setSelectedMetricName] = useState<string | null>(
@ -99,15 +99,6 @@ function Summary(): JSX.Element {
enabled: !!metricsTreemapQuery,
});
// Reset the filters when the component mounts
useEffect(() => {
handleChangeQueryData('filters', {
op: 'AND',
items: [],
});
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
const handleFilterChange = useCallback(
(value: TagFilter) => {
handleChangeQueryData('filters', value);

View File

@ -8,11 +8,11 @@ export const TREEMAP_VIEW_OPTIONS: {
value: TreemapViewType;
label: string;
}[] = [
{ value: TreemapViewType.CARDINALITY, label: 'Cardinality' },
{ value: TreemapViewType.DATAPOINTS, label: 'Datapoints' },
{ value: TreemapViewType.TIMESERIES, label: 'Time Series' },
{ value: TreemapViewType.SAMPLES, label: 'Samples' },
];
export const TREEMAP_HEIGHT = 300;
export const TREEMAP_HEIGHT = 200;
export const TREEMAP_SQUARE_PADDING = 5;
export const TREEMAP_MARGINS = { TOP: 10, LEFT: 10, RIGHT: 10, BOTTOM: 10 };
@ -24,3 +24,11 @@ export const METRIC_TYPE_LABEL_MAP = {
[MetricType.SUMMARY]: 'Summary',
[MetricType.EXPONENTIAL_HISTOGRAM]: 'Exp. Histogram',
};
export const METRIC_TYPE_VALUES_MAP = {
[MetricType.SUM]: 'Sum',
[MetricType.GAUGE]: 'Gauge',
[MetricType.HISTOGRAM]: 'Histogram',
[MetricType.SUMMARY]: 'Summary',
[MetricType.EXPONENTIAL_HISTOGRAM]: 'ExponentialHistogram',
};

View File

@ -46,8 +46,8 @@ export interface MetricsListItemRowData {
}
export enum TreemapViewType {
CARDINALITY = 'timeseries',
DATAPOINTS = 'samples',
TIMESERIES = 'timeseries',
SAMPLES = 'samples',
}
export interface TreemapTile {

View File

@ -7,8 +7,8 @@ import {
MetricType,
} from 'api/metricsExplorer/getMetricsList';
import {
CardinalityData,
DatapointsData,
SamplesData,
TimeseriesData,
} from 'api/metricsExplorer/getMetricsTreeMap';
import {
BarChart,
@ -37,6 +37,11 @@ export const metricsTableColumns: ColumnType<MetricsListItemRowData>[] = [
title: 'DESCRIPTION',
dataIndex: 'description',
width: 400,
render: (value: string): React.ReactNode => (
<Tooltip title={value}>
<div className="metric-description-column-value">{value}</div>
</Tooltip>
),
},
{
title: 'TYPE',
@ -50,14 +55,14 @@ export const metricsTableColumns: ColumnType<MetricsListItemRowData>[] = [
width: 150,
},
{
title: 'DATAPOINTS',
dataIndex: TreemapViewType.DATAPOINTS,
title: 'SAMPLES',
dataIndex: TreemapViewType.SAMPLES,
width: 150,
sorter: true,
},
{
title: 'CARDINALITY',
dataIndex: TreemapViewType.CARDINALITY,
title: 'TIME SERIES',
dataIndex: TreemapViewType.TIMESERIES,
width: 150,
sorter: true,
},
@ -138,6 +143,26 @@ function ValidateRowValueWrapper({
return <div>{children}</div>;
}
export const formatNumberIntoHumanReadableFormat = (num: number): string => {
function format(num: number, divisor: number, suffix: string): string {
const value = num / divisor;
return value % 1 === 0
? `${value}${suffix}+`
: `${value.toFixed(1).replace(/\.0$/, '')}${suffix}+`;
}
if (num >= 1_000_000_000) {
return format(num, 1_000_000_000, 'B');
}
if (num >= 1_000_000) {
return format(num, 1_000_000, 'M');
}
if (num >= 1_000) {
return format(num, 1_000, 'K');
}
return num.toString();
};
export const formatDataForMetricsTable = (
data: MetricsListItemData[],
): MetricsListItemRowData[] =>
@ -159,25 +184,28 @@ export const formatDataForMetricsTable = (
{metric.unit}
</ValidateRowValueWrapper>
),
[TreemapViewType.DATAPOINTS]: (
<ValidateRowValueWrapper value={metric[TreemapViewType.DATAPOINTS]}>
{metric[TreemapViewType.DATAPOINTS].toLocaleString()}
[TreemapViewType.SAMPLES]: (
<ValidateRowValueWrapper value={metric[TreemapViewType.SAMPLES]}>
<Tooltip title={metric[TreemapViewType.SAMPLES].toLocaleString()}>
{formatNumberIntoHumanReadableFormat(metric[TreemapViewType.SAMPLES])}
</Tooltip>
</ValidateRowValueWrapper>
),
[TreemapViewType.CARDINALITY]: (
<ValidateRowValueWrapper value={metric[TreemapViewType.CARDINALITY]}>
{metric[TreemapViewType.CARDINALITY]}
[TreemapViewType.TIMESERIES]: (
<ValidateRowValueWrapper value={metric[TreemapViewType.TIMESERIES]}>
<Tooltip title={metric[TreemapViewType.TIMESERIES].toLocaleString()}>
{formatNumberIntoHumanReadableFormat(metric[TreemapViewType.TIMESERIES])}
</Tooltip>
</ValidateRowValueWrapper>
),
}));
export const transformTreemapData = (
data: CardinalityData[] | DatapointsData[],
data: TimeseriesData[] | SamplesData[],
viewType: TreemapViewType,
): TreemapTile[] => {
const totalSize = (data as (CardinalityData | DatapointsData)[]).reduce(
(acc: number, item: CardinalityData | DatapointsData) =>
acc + item.percentage,
const totalSize = (data as (TimeseriesData | SamplesData)[]).reduce(
(acc: number, item: TimeseriesData | SamplesData) => acc + item.percentage,
0,
);

View File

@ -100,13 +100,12 @@ const menuItems: SidebarItem[] = [
label: 'Logs',
icon: <ScrollText size={16} />,
},
// TODO - Enable this when the metrics explorer feature is read for release
// {
// key: ROUTES.METRICS_EXPLORER,
// label: 'Metrics',
// icon: <BarChart2 size={16} />,
// isNew: true,
// },
{
key: ROUTES.METRICS_EXPLORER,
label: 'Metrics',
icon: <BarChart2 size={16} />,
isNew: true,
},
{
key: ROUTES.INFRASTRUCTURE_MONITORING_HOSTS,
label: 'Infra Monitoring',