Merge branch 'main' into search-index-might-not-exist

Author: lerouxb

docs/tracking-plan.md

@@ -1,7 +1,7 @@
 
 # Compass Tracking Plan
 
-Generated on Mon, Oct 14, 2024 at 08:39 AM
+Generated on Mon, Oct 14, 2024 at 12:23 PM
 
 ## Table of Contents
 
@@ -113,6 +113,7 @@ Generated on Mon, Oct 14, 2024 at 08:39 AM
 
 ### Indexes
 - [Index Created](#event--IndexCreatedEvent)
+- [Index Create Failed](#event--IndexCreateFailedEvent)
 - [Index Create Opened](#event--IndexCreateOpenedEvent)
 - [Index Dropped](#event--IndexDroppedEvent)
 - [Index Edited](#event--IndexEditedEvent)
@@ -1462,6 +1463,35 @@ This event is fired when user creates an index.
 
 **Properties**:
 
+- **unique** (optional): `boolean | undefined`
+  - Indicates whether the index is unique.
+- **ttl** (optional): `any`
+  - Specifies the time-to-live (TTL) setting for the index.
+- **columnstore_index** (optional): `boolean | undefined`
+  - Indicates whether the index is a columnstore index.
+- **has_columnstore_projection** (optional): `any`
+  - Indicates if the index has a columnstore projection.
+- **has_wildcard_projection** (optional): `any`
+  - Indicates if the index includes a wildcard projection.
+- **custom_collation** (optional): `any`
+  - Specifies if the index uses a custom collation.
+- **geo** (optional): `boolean | undefined`
+  - Indicates whether the index is a geospatial index.
+- **atlas_search** (optional): `boolean | undefined`
+  - Indicates whether the index is an Atlas Search index.
+- **type** (optional): `string | undefined`
+  - Specifies the type of the index.
+- **connection_id** (optional): `string | undefined`
+  - The id of the connection associated to this event.
+
+<a name="event--IndexCreateFailedEvent"></a>
+
+### Index Create Failed
+
+This event is fired when user creates an index and it fails.
+
+**Properties**:
+
 - **unique** (optional): `boolean | undefined`
   - Indicates whether the index is unique.
 - **ttl** (optional): `any`

packages/compass-indexes/src/modules/regular-indexes.ts

@@ -582,6 +582,7 @@ export function createRegularIndex(
       await dispatch(refreshRegularIndexes());
     } catch (err) {
       dispatch(indexCreationFailed(inProgressIndexId, (err as Error).message));
+      track('Index Create Failed', trackEvent, connectionInfoRef.current);
     }
   };
 }

packages/compass-indexes/src/modules/search-indexes.ts

@@ -496,6 +496,14 @@ export const createIndex = ({
       dispatch(
         createSearchIndexFailed(ATLAS_SEARCH_SERVER_ERRORS[error] || error)
       );
+      track(
+        'Index Create Failed',
+        {
+          atlas_search: true,
+          type,
+        },
+        connectionInfoRef.current
+      );
       return;
     }
 

packages/compass-telemetry/src/telemetry-events.ts

@@ -1344,6 +1344,62 @@ type IndexCreatedEvent = ConnectionScoped<{
   };
 }>;
 
+/**
+ * This event is fired when user creates an index and it fails.
+ *
+ * @category Indexes
+ */
+type IndexCreateFailedEvent = ConnectionScoped<{
+  name: 'Index Create Failed';
+
+  payload: {
+    /**
+     * Indicates whether the index is unique.
+     */
+    unique?: boolean;
+
+    /**
+     * Specifies the time-to-live (TTL) setting for the index.
+     */
+    ttl?: any;
+
+    /**
+     * Indicates whether the index is a columnstore index.
+     */
+    columnstore_index?: boolean;
+
+    /**
+     * Indicates if the index has a columnstore projection.
+     */
+    has_columnstore_projection?: any;
+
+    /**
+     * Indicates if the index includes a wildcard projection.
+     */
+    has_wildcard_projection?: any;
+
+    /**
+     * Specifies if the index uses a custom collation.
+     */
+    custom_collation?: any;
+
+    /**
+     * Indicates whether the index is a geospatial index.
+     */
+    geo?: boolean;
+
+    /**
+     * Indicates whether the index is an Atlas Search index.
+     */
+    atlas_search?: boolean;
+
+    /**
+     * Specifies the type of the index.
+     */
+    type?: string;
+  };
+}>;
+
 /**
  * This event is fired when user updates an index.
  *
@@ -2556,6 +2612,7 @@ export type TelemetryEvent =
   | ImportErrorLogOpenedEvent
   | ImportOpenedEvent
   | IndexCreatedEvent
+  | IndexCreateFailedEvent
   | IndexCreateOpenedEvent
   | IndexDroppedEvent
   | IndexEditedEvent