@parca/profile 0.16.198 → 0.16.200

package/src/ProfileIcicleGraph/IcicleGraphArrow/utils.ts

@@ -0,0 +1,51 @@
+// Copyright 2022 The Parca Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import {Table} from 'apache-arrow';
+
+import {EVERYTHING_ELSE, FEATURE_TYPES, type Feature} from '@parca/store';
+import {getLastItem} from '@parca/utilities';
+
+import {hexifyAddress} from '../../utils';
+import {FIELD_FUNCTION_NAME, FIELD_LOCATION_ADDRESS, FIELD_MAPPING_FILE} from './index';
+
+export function nodeLabel(table: Table<any>, row: number, showBinaryName: boolean): string {
+  const functionName: string | null = table.getChild(FIELD_FUNCTION_NAME)?.get(row);
+  if (functionName !== null && functionName !== '') {
+    return functionName;
+  }
+
+  let mappingString = '';
+  if (showBinaryName) {
+    const mappingFile: string | null = table.getChild(FIELD_MAPPING_FILE)?.get(row) ?? '';
+    const binary: string | undefined = getLastItem(mappingFile ?? undefined);
+    if (binary != null) mappingString = `[${binary}]`;
+  }
+
+  const addressBigInt: bigint = table.getChild(FIELD_LOCATION_ADDRESS)?.get(row);
+  const address = hexifyAddress(addressBigInt);
+  const fallback = `${mappingString}${address}`;
+  return fallback === '' ? '<unknown>' : fallback;
+}
+
+export const extractFeature = (mapping: string): Feature => {
+  if (mapping.startsWith('runtime') || mapping === 'root') {
+    return {name: 'runtime', type: FEATURE_TYPES.Runtime};
+  }
+
+  if (mapping != null && mapping !== '') {
+    return {name: mapping, type: FEATURE_TYPES.Binary};
+  }
+
+  return {name: EVERYTHING_ELSE, type: FEATURE_TYPES.Misc};
+};

package/src/ProfileIcicleGraph/index.tsx

@@ -13,13 +13,16 @@
 
 import {useEffect, useMemo} from 'react';
 
+import {Table} from 'apache-arrow';
+
 import {Flamegraph} from '@parca/client';
 import {Button} from '@parca/components';
 import {useContainerDimensions} from '@parca/hooks';
 import {divide, selectQueryParam, type NavigateFunction} from '@parca/utilities';
 
 import DiffLegend from '../components/DiffLegend';
-import {IcicleGraph} from './IcicleGraph';
+import IcicleGraph from './IcicleGraph';
+import IcicleGraphArrow from './IcicleGraphArrow';
 
 const numberFormatter = new Intl.NumberFormat('en-US');
 
@@ -27,7 +30,8 @@ export type ResizeHandler = (width: number, height: number) => void;
 
 interface ProfileIcicleGraphProps {
   width?: number;
-  graph: Flamegraph | undefined;
+  graph?: Flamegraph;
+  table?: Table<any>;
   total: bigint;
   filtered: bigint;
   sampleUnit: string;
@@ -40,6 +44,7 @@ interface ProfileIcicleGraphProps {
 
 const ProfileIcicleGraph = ({
   graph,
+  table,
   total,
   filtered,
   curPath,
@@ -66,7 +71,8 @@ const ProfileIcicleGraph = ({
       return ['0', '0', false, '0', '0', false, '0', '0'];
     }
 
-    const trimmed = graph.trimmed;
+    // const trimmed = graph.trimmed;
+    const trimmed = 0n;
 
     const totalUnfiltered = total + filtered;
     // safeguard against division by zero
@@ -101,7 +107,7 @@ const ProfileIcicleGraph = ({
     );
   }, [setNewCurPath, curPath, setActionButtons]);
 
-  if (graph === undefined) return <div>no data...</div>;
+  if (graph === undefined && table === undefined) return <div>no data...</div>;
 
   if (total === 0n && !loading) return <>Profile has no samples</>;
 
@@ -113,16 +119,30 @@ const ProfileIcicleGraph = ({
     <div className="relative">
       {compareMode && <DiffLegend />}
       <div ref={ref}>
-        <IcicleGraph
-          width={dimensions?.width}
-          graph={graph}
-          total={total}
-          filtered={filtered}
-          curPath={curPath}
-          setCurPath={setNewCurPath}
-          sampleUnit={sampleUnit}
-          navigateTo={navigateTo}
-        />
+        {graph !== undefined && (
+          <IcicleGraph
+            width={dimensions?.width}
+            graph={graph}
+            total={total}
+            filtered={filtered}
+            curPath={curPath}
+            setCurPath={setNewCurPath}
+            sampleUnit={sampleUnit}
+            navigateTo={navigateTo}
+          />
+        )}
+        {table !== undefined && (
+          <IcicleGraphArrow
+            width={dimensions?.width}
+            table={table}
+            total={total}
+            filtered={filtered}
+            curPath={curPath}
+            setCurPath={setNewCurPath}
+            sampleUnit={sampleUnit}
+            navigateTo={navigateTo}
+          />
+        )}
       </div>
       <p className="my-2 text-xs">
         Showing {totalFormatted}{' '}

package/src/ProfileMetricsGraph/index.tsx

@@ -22,8 +22,21 @@ import {getStepDuration} from '@parca/utilities';
 
 import {MergedProfileSelection, ProfileSelection} from '..';
 import MetricsGraph from '../MetricsGraph';
+import {useMetricsGraphDimensions} from '../MetricsGraph/useMetricsGraphDimensions';
 import useDelayedLoader from '../useDelayedLoader';
 
+interface ProfileMetricsEmptyStateProps {
+  message: string;
+}
+
+export const ProfileMetricsEmptyState = ({message}: ProfileMetricsEmptyStateProps): JSX.Element => {
+  return (
+    <div className="flex h-full w-full flex-col items-center justify-center">
+      <p>{message}</p>
+    </div>
+  );
+};
+
 interface ProfileMetricsGraphProps {
   queryClient: QueryServiceClient;
   queryExpression: string;
@@ -52,15 +65,12 @@ export const useQueryRange = (
     isLoading: true,
     error: null,
   });
+  const [isLoading, setLoading] = useState<boolean>(true);
   const metadata = useGrpcMetadata();
 
   useEffect(() => {
     void (async () => {
-      setState({
-        response: null,
-        isLoading: true,
-        error: null,
-      });
+      setLoading(true);
 
       const stepDuration = getStepDuration(start, end);
       const call = client.queryRange(
@@ -75,12 +85,19 @@ export const useQueryRange = (
       );
 
       call.response
-        .then(response => setState({response, isLoading: false, error: null}))
-        .catch(error => setState({response: null, isLoading: false, error}));
+        .then(response => {
+          setState({response, isLoading: false, error: null});
+          setLoading(false);
+          return null;
+        })
+        .catch(error => {
+          setState({response: null, isLoading: false, error});
+          setLoading(false);
+        });
     })();
   }, [client, queryExpression, start, end, metadata]);
 
-  return state;
+  return {...state, isLoading};
 };
 
 const ProfileMetricsGraph = ({
@@ -96,6 +113,7 @@ const ProfileMetricsGraph = ({
   const {isLoading, response, error} = useQueryRange(queryClient, queryExpression, from, to);
   const isLoaderVisible = useDelayedLoader(isLoading);
   const {loader, onError, perf} = useParcaContext();
+  const {width, height, margin, marginRight} = useMetricsGraphDimensions();
 
   useEffect(() => {
     if (error !== null) {
@@ -111,7 +129,10 @@ const ProfileMetricsGraph = ({
     perf?.markInteraction('Metrics graph render', response.series[0].samples.length);
   }, [perf, response]);
 
-  if (isLoaderVisible) {
+  const series = response?.series;
+  const dataAvailable = series !== null && series !== undefined && series?.length > 0;
+
+  if (isLoaderVisible || (isLoading && !dataAvailable)) {
     return <>{loader}</>;
   }
 
@@ -127,15 +148,14 @@ const ProfileMetricsGraph = ({
     );
   }
 
-  const series = response?.series;
-  if (series !== null && series !== undefined && series?.length > 0) {
+  if (dataAvailable) {
     const handleSampleClick = (timestamp: number, _value: number, labels: Label[]): void => {
       onPointClick(timestamp, labels, queryExpression);
     };
 
     return (
       <div
-        className="rounded border-gray-300 dark:border-gray-500 dark:bg-gray-700"
+        className="h-full w-full rounded border-gray-300 dark:border-gray-500 dark:bg-gray-700"
         style={{borderWidth: 1}}
       >
         <MetricsGraph
@@ -146,19 +166,17 @@ const ProfileMetricsGraph = ({
           setTimeRange={setTimeRange}
           onSampleClick={handleSampleClick}
           onLabelClick={addLabelMatcher}
-          width={0}
           sampleUnit={Query.parse(queryExpression).profileType().sampleUnit}
+          height={height}
+          width={width}
+          margin={margin}
+          marginRight={marginRight}
         />
       </div>
     );
   }
-  return (
-    <div className="grid grid-cols-1">
-      <div className="flex justify-center py-20">
-        <p className="m-0">No data found. Try a different query.</p>
-      </div>
-    </div>
-  );
+
+  return <ProfileMetricsEmptyState message="No data found. Try a different query." />;
 };
 
 export default ProfileMetricsGraph;

package/src/ProfileSelector/index.tsx

@@ -31,9 +31,11 @@ import {getStepDuration, getStepDurationInMilliseconds} from '@parca/utilities';
 
 import {MergedProfileSelection, ProfileSelection} from '..';
 import MatchersInput from '../MatchersInput/index';
-import ProfileMetricsGraph from '../ProfileMetricsGraph';
+import {useMetricsGraphDimensions} from '../MetricsGraph/useMetricsGraphDimensions';
+import ProfileMetricsGraph, {ProfileMetricsEmptyState} from '../ProfileMetricsGraph';
 import ProfileTypeSelector from '../ProfileTypeSelector/index';
 import CompareButton from './CompareButton';
+import {useAutoQuerySelector} from './useAutoQuerySelector';
 
 export interface QuerySelection {
   expression: string;
@@ -98,6 +100,7 @@ const ProfileSelector = ({
     data: profileTypesData,
     error,
   } = useProfileTypes(queryClient);
+  const {heightStyle} = useMetricsGraphDimensions();
 
   const [timeRangeSelection, setTimeRangeSelection] = useState(
     DateTimeRange.fromRangeKey(querySelection.timeSelection)
@@ -179,6 +182,13 @@ const ProfileSelector = ({
     }
   };
 
+  useAutoQuerySelector({
+    selectedProfileName,
+    profileTypesData,
+    setProfileName,
+    setQueryExpression,
+  });
+
   const handleCompareClick = (): void => onCompareProfile();
 
   const searchDisabled =
@@ -236,61 +246,63 @@ const ProfileSelector = ({
       </Card.Header>
       {
         <Card.Body>
-          {querySelection.expression !== undefined &&
-          querySelection.expression.length > 0 &&
-          querySelection.from !== undefined &&
-          querySelection.to !== undefined ? (
-            <ProfileMetricsGraph
-              queryClient={queryClient}
-              queryExpression={querySelection.expression}
-              from={querySelection.from}
-              to={querySelection.to}
-              profile={profileSelection}
-              setTimeRange={(range: DateTimeRange) => {
-                const from = range.getFromMs();
-                const to = range.getToMs();
-                let mergedProfileParams = {};
-                if (query.profileType().delta) {
-                  mergedProfileParams = {mergeFrom: from, mergeTo: to};
-                }
-                setTimeRangeSelection(range);
-                selectQuery({
-                  expression: queryExpressionString,
-                  from,
-                  to,
-                  timeSelection: range.getRangeKey(),
-                  ...mergedProfileParams,
-                });
-              }}
-              addLabelMatcher={addLabelMatcher}
-              onPointClick={(timestamp, labels, queryExpression) => {
-                // TODO: Pass the query object via click rather than queryExpression
-                let query = Query.parse(queryExpression);
-                labels.forEach(l => {
-                  const [newQuery, updated] = query.setMatcher(l.name, l.value);
-                  if (updated) {
-                    query = newQuery;
+          <div style={{height: heightStyle}}>
+            {querySelection.expression !== undefined &&
+            querySelection.expression.length > 0 &&
+            querySelection.from !== undefined &&
+            querySelection.to !== undefined ? (
+              <ProfileMetricsGraph
+                queryClient={queryClient}
+                queryExpression={querySelection.expression}
+                from={querySelection.from}
+                to={querySelection.to}
+                profile={profileSelection}
+                setTimeRange={(range: DateTimeRange) => {
+                  const from = range.getFromMs();
+                  const to = range.getToMs();
+                  let mergedProfileParams = {};
+                  if (query.profileType().delta) {
+                    mergedProfileParams = {mergeFrom: from, mergeTo: to};
                   }
-                });
+                  setTimeRangeSelection(range);
+                  selectQuery({
+                    expression: queryExpressionString,
+                    from,
+                    to,
+                    timeSelection: range.getRangeKey(),
+                    ...mergedProfileParams,
+                  });
+                }}
+                addLabelMatcher={addLabelMatcher}
+                onPointClick={(timestamp, labels, queryExpression) => {
+                  // TODO: Pass the query object via click rather than queryExpression
+                  let query = Query.parse(queryExpression);
+                  labels.forEach(l => {
+                    const [newQuery, updated] = query.setMatcher(l.name, l.value);
+                    if (updated) {
+                      query = newQuery;
+                    }
+                  });
 
-                const stepDuration = getStepDuration(querySelection.from, querySelection.to);
-                const stepDurationInMilliseconds = getStepDurationInMilliseconds(stepDuration);
-                const mergeFrom = timestamp;
-                const mergeTo = query.profileType().delta
-                  ? mergeFrom + stepDurationInMilliseconds
-                  : mergeFrom;
-                selectProfile(new MergedProfileSelection(mergeFrom, mergeTo, query));
-              }}
-            />
-          ) : (
-            <>
-              {profileSelection == null && (
-                <div className="my-20 text-center">
-                  <p>Run a query, and the result will be displayed here.</p>
-                </div>
-              )}
-            </>
-          )}
+                  const stepDuration = getStepDuration(querySelection.from, querySelection.to);
+                  const stepDurationInMilliseconds = getStepDurationInMilliseconds(stepDuration);
+                  const mergeFrom = timestamp;
+                  const mergeTo = query.profileType().delta
+                    ? mergeFrom + stepDurationInMilliseconds
+                    : mergeFrom;
+                  selectProfile(new MergedProfileSelection(mergeFrom, mergeTo, query));
+                }}
+              />
+            ) : (
+              <>
+                {profileSelection == null ? (
+                  <ProfileMetricsEmptyState
+                    message={`Please select a profile type and click "Search" to begin.`}
+                  />
+                ) : null}
+              </>
+            )}
+          </div>
         </Card.Body>
       }
     </Card>

package/src/ProfileSelector/useAutoQuerySelector.ts

@@ -0,0 +1,87 @@
+// Copyright 2022 The Parca Authors
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import {useEffect} from 'react';
+
+import {ProfileTypesResponse} from '@parca/client';
+import {selectAutoQuery, setAutoQuery, useAppDispatch, useAppSelector} from '@parca/store';
+
+import {constructProfileName} from '../ProfileTypeSelector';
+
+interface Props {
+  selectedProfileName: string;
+  profileTypesData: ProfileTypesResponse | undefined;
+  setProfileName: (name: string) => void;
+  setQueryExpression: () => void;
+}
+
+export const useAutoQuerySelector = ({
+  selectedProfileName,
+  profileTypesData,
+  setProfileName,
+  setQueryExpression,
+}: Props): void => {
+  const autoQuery = useAppSelector(selectAutoQuery);
+  const dispatch = useAppDispatch();
+
+  // Effect to load some initial data on load when is no selection
+  useEffect(() => {
+    void (async () => {
+      if (selectedProfileName.length > 0) {
+        return;
+      }
+      if (profileTypesData?.types == null || profileTypesData.types.length < 1) {
+        return;
+      }
+      if (autoQuery === 'true') {
+        // Autoquery already enabled.
+        return;
+      }
+      dispatch(setAutoQuery('true'));
+      let profileType = profileTypesData.types.find(type => type.name === 'parca_agent_cpu');
+      if (profileType == null) {
+        profileType = profileTypesData.types[0];
+      }
+      setProfileName(constructProfileName(profileType));
+    })();
+  }, [
+    profileTypesData,
+    selectedProfileName,
+    autoQuery,
+    dispatch,
+    setQueryExpression,
+    setProfileName,
+  ]);
+
+  useEffect(() => {
+    void (async () => {
+      if (
+        autoQuery !== 'true' ||
+        profileTypesData?.types == null ||
+        profileTypesData.types.length < 1 ||
+        selectedProfileName.length === 0
+      ) {
+        return;
+      }
+      setQueryExpression();
+      dispatch(setAutoQuery('false'));
+    })();
+  }, [
+    profileTypesData,
+    setQueryExpression,
+    autoQuery,
+    setProfileName,
+    dispatch,
+    selectedProfileName,
+  ]);
+};

package/src/ProfileTypeSelector/index.tsx

@@ -128,17 +128,16 @@ export function profileSelectElement(
   };
 }
 
+export const constructProfileName = (type: ProfileType): string => {
+  return `${type.name}:${type.sampleType}:${type.sampleUnit}:${type.periodType}:${type.periodUnit}${
+    type.delta ? ':delta' : ''
+  }`;
+};
+
 export const normalizeProfileTypesData = (types: ProfileType[]): string[] => {
-  return types
-    .map(
-      type =>
-        `${type.name}:${type.sampleType}:${type.sampleUnit}:${type.periodType}:${type.periodUnit}${
-          type.delta ? ':delta' : ''
-        }`
-    )
-    .sort((a: string, b: string): number => {
-      return a.localeCompare(b);
-    });
+  return types.map(constructProfileName).sort((a: string, b: string): number => {
+    return a.localeCompare(b);
+  });
 };
 
 interface Props {

package/src/ProfileView/index.tsx

@@ -13,6 +13,7 @@
 
 import {Profiler, ProfilerProps, useEffect, useMemo, useState} from 'react';
 
+import {Table} from 'apache-arrow';
 import cx from 'classnames';
 import {scaleLinear} from 'd3';
 import graphviz from 'graphviz-wasm';
@@ -53,6 +54,7 @@ type NavigateFunction = (path: string, queryParams: any, options?: {replace?: bo
 export interface FlamegraphData {
   loading: boolean;
   data?: Flamegraph;
+  table?: Table<any>;
   total?: bigint;
   filtered?: bigint;
   error?: any;
@@ -113,7 +115,7 @@ export const ProfileView = ({
 }: ProfileViewProps): JSX.Element => {
   const {ref, dimensions} = useContainerDimensions();
   const [curPath, setCurPath] = useState<string[]>([]);
-  const [rawDashboardItems, setDashboardItems] = useURLState({
+  const [rawDashboardItems = ['icicle'], setDashboardItems] = useURLState({
     param: 'dashboard_items',
     navigateTo,
   });
@@ -230,7 +232,7 @@ export const ProfileView = ({
   }): JSX.Element => {
     switch (type) {
       case 'icicle': {
-        return flamegraphData?.data != null ? (
+        return flamegraphData?.table !== undefined || flamegraphData.data !== undefined ? (
           <ConditionalWrapper<ProfilerProps>
             condition={perf?.onRender != null}
             WrapperComponent={Profiler}
@@ -242,6 +244,7 @@ export const ProfileView = ({
             <ProfileIcicleGraph
               curPath={curPath}
               setNewCurPath={setNewCurPath}
+              table={flamegraphData.table}
               graph={flamegraphData.data}
               total={total}
               filtered={filtered}

package/src/ProfileViewWithData.tsx

@@ -13,9 +13,11 @@
 
 import {useEffect, useMemo, useState} from 'react';
 
+import {tableFromIPC} from 'apache-arrow';
+
 import {QueryRequest_ReportType, QueryServiceClient} from '@parca/client';
 import {useGrpcMetadata, useParcaContext, useURLState} from '@parca/components';
-import {USER_PREFERENCES, useUserPreference} from '@parca/hooks';
+import {USER_PREFERENCES, useUIFeatureFlag, useUserPreference} from '@parca/hooks';
 import {saveAsBlob, type NavigateFunction} from '@parca/utilities';
 
 import {ProfileSource} from './ProfileSource';
@@ -36,8 +38,10 @@ export const ProfileViewWithData = ({
   navigateTo,
 }: ProfileViewWithDataProps): JSX.Element => {
   const metadata = useGrpcMetadata();
-  const [dashboardItems] = useURLState({param: 'dashboard_items', navigateTo});
+  const [dashboardItems = ['icicle']] = useURLState({param: 'dashboard_items', navigateTo});
+
   const [enableTrimming] = useUserPreference<boolean>(USER_PREFERENCES.ENABLE_GRAPH_TRIMMING.key);
+  const [arrowFlamegraphEnabled] = useUIFeatureFlag('flamegraph-arrow');
   const [pprofDownloading, setPprofDownloading] = useState<boolean>(false);
 
   const nodeTrimThreshold = useMemo(() => {
@@ -53,11 +57,15 @@ export const ProfileViewWithData = ({
     return (1 / width) * 100;
   }, [enableTrimming]);
 
+  const reportType = arrowFlamegraphEnabled
+    ? QueryRequest_ReportType.FLAMEGRAPH_ARROW
+    : QueryRequest_ReportType.FLAMEGRAPH_TABLE;
+
   const {
     isLoading: flamegraphLoading,
     response: flamegraphResponse,
     error: flamegraphError,
-  } = useQuery(queryClient, profileSource, QueryRequest_ReportType.FLAMEGRAPH_TABLE, {
+  } = useQuery(queryClient, profileSource, reportType, {
     skip: !dashboardItems.includes('icicle'),
     nodeTrimThreshold,
   });
@@ -80,16 +88,19 @@ export const ProfileViewWithData = ({
   });
 
   useEffect(() => {
-    if (!flamegraphLoading && flamegraphResponse?.report.oneofKind === 'flamegraph') {
-      perf?.markInteraction('Flamegraph render', flamegraphResponse.report.flamegraph.total);
+    if (
+      (!flamegraphLoading && flamegraphResponse?.report.oneofKind === 'flamegraph') ||
+      flamegraphResponse?.report.oneofKind === 'flamegraphArrow'
+    ) {
+      perf?.markInteraction('Flamegraph render', flamegraphResponse.total);
     }
 
     if (!topTableLoading && topTableResponse?.report.oneofKind === 'top') {
-      perf?.markInteraction('Top table render', topTableResponse?.report?.top.total);
+      perf?.markInteraction('Top table render', topTableResponse.total);
     }
 
     if (!callgraphLoading && callgraphResponse?.report.oneofKind === 'callgraph') {
-      perf?.markInteraction('Callgraph render', callgraphResponse?.report?.callgraph.cumulative);
+      perf?.markInteraction('Callgraph render', callgraphResponse.total);
     }
   }, [
     flamegraphLoading,
@@ -144,6 +155,10 @@ export const ProfileViewWithData = ({
           flamegraphResponse?.report.oneofKind === 'flamegraph'
             ? flamegraphResponse?.report?.flamegraph
             : undefined,
+        table:
+          flamegraphResponse?.report.oneofKind === 'flamegraphArrow'
+            ? tableFromIPC(flamegraphResponse?.report?.flamegraphArrow.record)
+            : undefined,
         total: BigInt(flamegraphResponse?.total ?? '0'),
         filtered: BigInt(flamegraphResponse?.filtered ?? '0'),
         error: flamegraphError,