ref(insights): replace spanIndexedFields with spanFields (#95664)

Author: DominikB2014

static/app/components/performance/spanSearchQueryBuilder.tsx

@@ -27,7 +27,7 @@ import {
 import {useTraceItemTags} from 'sentry/views/explore/contexts/spanTagsContext';
 import {TraceItemDataset} from 'sentry/views/explore/types';
 import {SPANS_FILTER_KEY_SECTIONS} from 'sentry/views/insights/constants';
-import {SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 import {
   useSpanFieldCustomTags,
   useSpanFieldSupportedTags,
@@ -218,7 +218,7 @@ export function useEAPSpanSearchQueryBuilderProps(props: EAPSpanSearchQueryBuild
 
   const numberAttributes = numberTags;
   const stringAttributes = useMemo(() => {
-    if (stringTags.hasOwnProperty(SpanIndexedField.RELEASE)) {
+    if (stringTags.hasOwnProperty(SpanFields.RELEASE)) {
       return {
         ...stringTags,
         ...STATIC_SEMVER_TAGS,

static/app/utils/fields/index.ts

@@ -1,7 +1,7 @@
 import {t} from 'sentry/locale';
 import type {TagCollection} from 'sentry/types/group';
 import {CONDITIONS_ARGUMENTS, WEB_VITALS_QUALITY} from 'sentry/utils/discover/types';
-import {SpanFields, SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 // Don't forget to update https://docs.sentry.io/product/sentry-basics/search/searchable-properties/ for any changes made here
 
 export enum FieldKind {
@@ -826,9 +826,9 @@ export const AGGREGATION_FIELDS: Record<AggregationKey, FieldDefinition> = {
 };
 
 // TODO: Extend the two lists below with more options upon backend support
-export const ALLOWED_EXPLORE_VISUALIZE_FIELDS: SpanIndexedField[] = [
-  SpanIndexedField.SPAN_DURATION, // DO NOT RE-ORDER: the first element is used as the default
-  SpanIndexedField.SPAN_SELF_TIME,
+export const ALLOWED_EXPLORE_VISUALIZE_FIELDS: SpanFields[] = [
+  SpanFields.SPAN_DURATION, // DO NOT RE-ORDER: the first element is used as the default
+  SpanFields.SPAN_SELF_TIME,
 ];
 
 export const ALLOWED_EXPLORE_VISUALIZE_AGGREGATES: AggregationKey[] = [
@@ -859,7 +859,7 @@ const SPAN_AGGREGATION_FIELDS: Record<AggregationKey, FieldDefinition> = {
         kind: 'column',
         columnTypes: function ({key, valueType}) {
           return (
-            key === SpanIndexedField.SPAN_DURATION &&
+            key === SpanFields.SPAN_DURATION &&
             (valueType === FieldValueType.DURATION || valueType === FieldValueType.NUMBER)
           );
         },
@@ -1192,92 +1192,92 @@ const SPAN_OP_FIELDS: Record<SpanOpBreakdown, FieldDefinition> = {
 };
 
 type TraceFields =
-  | SpanIndexedField.IS_TRANSACTION
-  | SpanIndexedField.SPAN_ACTION
-  | SpanIndexedField.SPAN_DESCRIPTION
-  | SpanIndexedField.SPAN_DOMAIN
-  | SpanIndexedField.SPAN_DURATION
-  | SpanIndexedField.SPAN_GROUP
-  | SpanIndexedField.SPAN_CATEGORY
-  | SpanIndexedField.SPAN_OP
-  | SpanIndexedField.NORMALIZED_DESCRIPTION
+  | SpanFields.IS_TRANSACTION
+  | SpanFields.SPAN_ACTION
+  | SpanFields.SPAN_DESCRIPTION
+  | SpanFields.SPAN_DOMAIN
+  | SpanFields.SPAN_DURATION
+  | SpanFields.SPAN_GROUP
+  | SpanFields.SPAN_CATEGORY
+  | SpanFields.SPAN_OP
+  | SpanFields.NORMALIZED_DESCRIPTION
   // TODO: Remove self time field when it is deprecated
-  | SpanIndexedField.SPAN_SELF_TIME
-  | SpanIndexedField.SPAN_STATUS
-  | SpanIndexedField.RESPONSE_CODE
-  | SpanIndexedField.CACHE_HIT;
+  | SpanFields.SPAN_SELF_TIME
+  | SpanFields.SPAN_STATUS
+  | SpanFields.SPAN_STATUS_CODE
+  | SpanFields.CACHE_HIT;
 
 const TRACE_FIELD_DEFINITIONS: Record<TraceFields, FieldDefinition> = {
   /** Indexed Fields */
-  [SpanIndexedField.SPAN_ACTION]: {
+  [SpanFields.SPAN_ACTION]: {
     desc: t(
       'The Sentry Insights span action, e.g `SELECT` for a SQL span or `POST` for an HTTP client span'
     ),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.SPAN_DESCRIPTION]: {
+  [SpanFields.SPAN_DESCRIPTION]: {
     desc: t('Description of the span’s operation'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.NORMALIZED_DESCRIPTION]: {
+  [SpanFields.NORMALIZED_DESCRIPTION]: {
     desc: t(
       'Parameterized and normalized description of the span, commonly used for grouping within insights'
     ),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.SPAN_DOMAIN]: {
+  [SpanFields.SPAN_DOMAIN]: {
     desc: t(
       'General scope of the span’s action, i.e. the tables involved in a `db` span or the host name in an `http` span'
     ),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.SPAN_DURATION]: {
+  [SpanFields.SPAN_DURATION]: {
     desc: t('The total time taken by the span'),
     kind: FieldKind.METRICS,
     valueType: FieldValueType.DURATION,
   },
-  [SpanIndexedField.SPAN_GROUP]: {
+  [SpanFields.SPAN_GROUP]: {
     desc: t('Unique hash of the span’s description'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.SPAN_CATEGORY]: {
+  [SpanFields.SPAN_CATEGORY]: {
     desc: t(
       'The prefix of the span operation, e.g if `span.op` is `http.client`, then `span.category` is `http`'
     ),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.SPAN_OP]: {
+  [SpanFields.SPAN_OP]: {
     desc: t('The operation of the span, e.g `http.client`, `middleware`'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.SPAN_SELF_TIME]: {
+  [SpanFields.SPAN_SELF_TIME]: {
     desc: t('The duration of the span excluding the duration of its child spans'),
     kind: FieldKind.METRICS,
     valueType: FieldValueType.DURATION,
   },
-  [SpanIndexedField.SPAN_STATUS]: {
+  [SpanFields.SPAN_STATUS]: {
     desc: t('Status of the operation the span represents'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.RESPONSE_CODE]: {
+  [SpanFields.SPAN_STATUS_CODE]: {
     desc: t('The HTTP response status code'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanIndexedField.IS_TRANSACTION]: {
+  [SpanFields.IS_TRANSACTION]: {
     desc: t('The span is also a transaction'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.BOOLEAN,
   },
-  [SpanIndexedField.CACHE_HIT]: {
+  [SpanFields.CACHE_HIT]: {
     desc: t('`true` if the  cache was hit, `false` otherwise'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.BOOLEAN,
@@ -1928,7 +1928,7 @@ const SPAN_FIELD_DEFINITIONS: Record<string, FieldDefinition> = {
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,
   },
-  [SpanFields.STATUS]: {
+  [SpanFields.SPAN_STATUS]: {
     desc: t('Span status. Indicates whether the span operation was successful.'),
     kind: FieldKind.FIELD,
     valueType: FieldValueType.STRING,

static/app/views/dashboards/widgets/common/types.tsx

@@ -71,7 +71,7 @@ export type TabularMeta<TFields extends string = string> = {
 
 export type TabularRow<TFields extends string = string> = Record<
   TFields,
-  number | string | string[] | null
+  number | string | string[] | boolean | null
 >;
 
 export type TabularData<TFields extends string = string> = {

static/app/views/explore/components/schemaHints/schemaHintsList.tsx

@@ -40,7 +40,7 @@ import {
 } from 'sentry/views/explore/contexts/logs/logsPageParams';
 import {LOGS_FILTER_KEY_SECTIONS} from 'sentry/views/explore/logs/constants';
 import {SPANS_FILTER_KEY_SECTIONS} from 'sentry/views/insights/constants';
-import {SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 
 const SCHEMA_HINTS_DRAWER_WIDTH = '350px';
 
@@ -75,9 +75,9 @@ function getTagsFromKeys(keys: string[], tags: TagCollection): Tag[] {
     .map(key => {
       if (key === USER_IDENTIFIER_KEY) {
         return (
-          tags[SpanIndexedField.USER_EMAIL] ||
-          tags[SpanIndexedField.USER_USERNAME] ||
-          tags[SpanIndexedField.USER_ID]
+          tags[SpanFields.USER_EMAIL] ||
+          tags[SpanFields.USER_USERNAME] ||
+          tags[SpanFields.USER_ID]
         );
       }
       return tags[key];

static/app/views/explore/components/schemaHints/schemaHintsUtils.tsx

@@ -1,22 +1,22 @@
 import type {TagCollection} from 'sentry/types/group';
 import {FieldKey} from 'sentry/utils/fields';
 import {OurLogKnownFieldKey} from 'sentry/views/explore/logs/types';
-import {SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 
 export const USER_IDENTIFIER_KEY = 'user.key';
 
-const FRONTEND_HINT_KEYS = [SpanIndexedField.BROWSER_NAME, USER_IDENTIFIER_KEY];
+const FRONTEND_HINT_KEYS = [SpanFields.BROWSER_NAME, USER_IDENTIFIER_KEY];
 
 const MOBILE_HINT_KEYS = [FieldKey.OS_NAME, FieldKey.DEVICE_FAMILY, USER_IDENTIFIER_KEY];
 
 const COMMON_HINT_KEYS = [
-  SpanIndexedField.IS_TRANSACTION,
-  SpanIndexedField.SPAN_OP,
-  SpanIndexedField.SPAN_DESCRIPTION,
-  SpanIndexedField.SPAN_DURATION,
-  SpanIndexedField.TRANSACTION,
+  SpanFields.IS_TRANSACTION,
+  SpanFields.SPAN_OP,
+  SpanFields.SPAN_DESCRIPTION,
+  SpanFields.SPAN_DURATION,
+  SpanFields.TRANSACTION,
   FieldKey.HTTP_STATUS_CODE,
-  SpanIndexedField.RELEASE,
+  SpanFields.RELEASE,
   'url',
 ];
 

static/app/views/explore/constants.tsx

@@ -1,59 +1,59 @@
 import {OurLogKnownFieldKey} from 'sentry/views/explore/logs/types';
-import {SpanFields, SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 
 export const SENTRY_SEARCHABLE_SPAN_STRING_TAGS: string[] = [
   // NOTE: intentionally choose to not expose transaction id
   // as we're moving toward span ids
 
   'id', // SpanIndexedField.SPAN_ID is actually `span_id`
   'profile.id', // SpanIndexedField.PROFILE_ID is actually `profile_id`
-  SpanIndexedField.BROWSER_NAME,
-  SpanIndexedField.ENVIRONMENT,
-  SpanIndexedField.ORIGIN_TRANSACTION,
-  SpanIndexedField.PROJECT,
-  SpanIndexedField.RAW_DOMAIN,
-  SpanIndexedField.RELEASE,
-  SpanIndexedField.SDK_NAME,
-  SpanIndexedField.SDK_VERSION,
-  SpanIndexedField.SPAN_ACTION,
-  SpanIndexedField.SPAN_CATEGORY,
-  SpanIndexedField.SPAN_DESCRIPTION,
-  SpanIndexedField.SPAN_DOMAIN,
-  SpanIndexedField.SPAN_GROUP,
-  SpanIndexedField.SPAN_OP,
-  SpanIndexedField.SPAN_STATUS,
-  SpanIndexedField.TIMESTAMP,
-  SpanIndexedField.TRACE,
-  SpanIndexedField.TRANSACTION,
-  SpanIndexedField.TRANSACTION_METHOD,
-  SpanIndexedField.TRANSACTION_OP,
-  SpanIndexedField.USER,
-  SpanIndexedField.USER_EMAIL,
-  SpanIndexedField.USER_GEO_SUBREGION,
-  SpanIndexedField.USER_ID,
-  SpanIndexedField.USER_IP,
-  SpanIndexedField.USER_USERNAME,
-  SpanIndexedField.IS_TRANSACTION, // boolean field but we can expose it as a string
-  SpanIndexedField.NORMALIZED_DESCRIPTION,
-  SpanIndexedField.CACHE_HIT,
+  SpanFields.BROWSER_NAME,
+  SpanFields.ENVIRONMENT,
+  SpanFields.ORIGIN_TRANSACTION,
+  SpanFields.PROJECT,
+  SpanFields.RAW_DOMAIN,
+  SpanFields.RELEASE,
+  SpanFields.SDK_NAME,
+  SpanFields.SDK_VERSION,
+  SpanFields.SPAN_ACTION,
+  SpanFields.SPAN_CATEGORY,
+  SpanFields.SPAN_DESCRIPTION,
+  SpanFields.SPAN_DOMAIN,
+  SpanFields.SPAN_GROUP,
+  SpanFields.SPAN_OP,
+  SpanFields.SPAN_STATUS,
+  SpanFields.TIMESTAMP,
+  SpanFields.TRACE,
+  SpanFields.TRANSACTION,
+  SpanFields.TRANSACTION_METHOD,
+  SpanFields.TRANSACTION_OP,
+  SpanFields.USER,
+  SpanFields.USER_EMAIL,
+  SpanFields.USER_GEO_SUBREGION,
+  SpanFields.USER_ID,
+  SpanFields.USER_IP,
+  SpanFields.USER_USERNAME,
+  SpanFields.IS_TRANSACTION, // boolean field but we can expose it as a string
+  SpanFields.NORMALIZED_DESCRIPTION,
+  SpanFields.CACHE_HIT,
 ];
 
 export const SENTRY_SEARCHABLE_SPAN_NUMBER_TAGS: string[] = [
-  SpanIndexedField.SPAN_DURATION,
-  SpanIndexedField.SPAN_SELF_TIME,
+  SpanFields.SPAN_DURATION,
+  SpanFields.SPAN_SELF_TIME,
 ];
 
 export const SENTRY_SPAN_STRING_TAGS: string[] = [
   'id', // SpanIndexedField.SPAN_ID is actually `span_id`
-  SpanIndexedField.PROJECT,
-  SpanIndexedField.SPAN_DESCRIPTION,
-  SpanIndexedField.SPAN_OP,
-  SpanIndexedField.TIMESTAMP,
-  SpanIndexedField.TRANSACTION,
-  SpanIndexedField.TRACE,
-  SpanIndexedField.IS_TRANSACTION, // boolean field but we can expose it as a string
-  SpanIndexedField.NORMALIZED_DESCRIPTION,
-  SpanIndexedField.RELEASE, // temporary as orgs with >1k keys still want releases
+  SpanFields.PROJECT,
+  SpanFields.SPAN_DESCRIPTION,
+  SpanFields.SPAN_OP,
+  SpanFields.TIMESTAMP,
+  SpanFields.TRANSACTION,
+  SpanFields.TRACE,
+  SpanFields.IS_TRANSACTION, // boolean field but we can expose it as a string
+  SpanFields.NORMALIZED_DESCRIPTION,
+  SpanFields.RELEASE, // temporary as orgs with >1k keys still want releases
   SpanFields.PROJECT_ID,
   SpanFields.SPAN_SYSTEM,
   SpanFields.SPAN_CATEGORY,

static/app/views/explore/contexts/pageParamsContext/visualizes.tsx

@@ -16,7 +16,7 @@ import {
 } from 'sentry/utils/fields';
 import {decodeList} from 'sentry/utils/queryString';
 import {ChartType} from 'sentry/views/insights/common/components/chart';
-import {SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 
 export const MAX_VISUALIZES = 4;
 
@@ -168,7 +168,7 @@ export function updateVisualizeAggregate({
     // and carry the argument if it's the same type, reset to a default
     // if it's not the same type. Just hard coding it for now for simplicity
     // as `count_unique` is the only aggregate that takes a string.
-    return `${newAggregate}(${SpanIndexedField.SPAN_OP})`;
+    return `${newAggregate}(${SpanFields.SPAN_OP})`;
   }
 
   if (NO_ARGUMENT_SPAN_AGGREGATES.includes(newAggregate as AggregationKey)) {

static/app/views/explore/hooks/useVisualizeFields.tsx

@@ -13,7 +13,7 @@ import {
 } from 'sentry/utils/fields';
 import {AttributeDetails} from 'sentry/views/explore/components/attributeDetails';
 import {TypeBadge} from 'sentry/views/explore/components/typeBadge';
-import {SpanIndexedField} from 'sentry/views/insights/types';
+import {SpanFields} from 'sentry/views/insights/types';
 
 interface UseVisualizeFieldsProps {
   numberTags: TagCollection;
@@ -29,9 +29,9 @@ export function useVisualizeFields({
   const [kind, tags]: [FieldKind, TagCollection] = useMemo(() => {
     if (parsedFunction?.name === AggregationKey.COUNT) {
       const countTags: TagCollection = {
-        [SpanIndexedField.SPAN_DURATION]: {
+        [SpanFields.SPAN_DURATION]: {
           name: t('spans'),
-          key: SpanIndexedField.SPAN_DURATION,
+          key: SpanFields.SPAN_DURATION,
         },
       };
       return [FieldKind.MEASUREMENT, countTags];

static/app/views/explore/tables/tracesTable/fieldRenderers.tsx

@@ -23,7 +23,7 @@ import useProjects from 'sentry/utils/useProjects';
 import type {TraceResult} from 'sentry/views/explore/hooks/useTraces';
 import {BREAKDOWN_SLICES} from 'sentry/views/explore/hooks/useTraces';
 import type {SpanResult} from 'sentry/views/explore/hooks/useTraceSpans';
-import type {SpanIndexedField, SpanIndexedResponse} from 'sentry/views/insights/types';
+import type {EAPSpanResponse, SpanFields} from 'sentry/views/insights/types';
 import {TraceViewSources} from 'sentry/views/performance/newTraceDetails/traceHeader/breadcrumbs';
 import {getTraceDetailsUrl} from 'sentry/views/performance/traceDetails/utils';
 
@@ -482,7 +482,7 @@ export function SpanTimeRenderer({
   );
 }
 
-type SpanStatus = SpanIndexedResponse[SpanIndexedField.SPAN_STATUS];
+type SpanStatus = EAPSpanResponse[SpanFields.SPAN_STATUS];
 
 const STATUS_TO_TAG_TYPE: Record<SpanStatus, keyof Theme['tag']> = {
   ok: 'success',