feat(dashboard): add logging for query editor

awslabs · Dec 18, 2023 · d115606 · d115606
1 parent a890c7d
commit d115606
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/...itor/iotSiteWiseQueryEditor/assetModelDataStreamExplorer/assetModelDataStreamExplorer.tsx b/...itor/iotSiteWiseQueryEditor/assetModelDataStreamExplorer/assetModelDataStreamExplorer.tsx
@@ -15,12 +15,14 @@ import { createNonNullableList } from '~/helpers/lists/createNonNullableList';
 import { getAssetModelQueryInformation } from './getAssetModelQueryInformation';
 import { useModelBasedQuery } from './modelBasedQuery/useModelBasedQuery';
 import { useModelBasedQuerySelection } from './modelBasedQuery/useModelBasedQuerySelection';
+import { getPlugin } from '@iot-app-kit/core';
 
 export interface AssetModelDataStreamExplorerProps {
   client: IoTSiteWiseClient;
 }
 
 export const AssetModelDataStreamExplorer = ({ client }: AssetModelDataStreamExplorerProps) => {
+  const metricsRecorder = getPlugin('metricsRecorder');
   const { assetModelId, assetIds, clearModelBasedWidgets, updateSelectedAsset } = useModelBasedQuery();
   const { assetModels, updateAssetModels, modelBasedWidgetsSelected } = useModelBasedQuerySelection();
 
@@ -56,6 +58,10 @@ export const AssetModelDataStreamExplorer = ({ client }: AssetModelDataStreamExp
           assetModelPropertyIds: createNonNullableList(selectedAssetModelProperties.map(({ id }) => id)),
         })
       );
+      metricsRecorder?.record({
+        metricName: 'AssetModelDataStreamAdd',
+        metricValue: 1,
+      });
     }
   };
 

diff --git a/...d/src/components/queryEditor/iotSiteWiseQueryEditor/dataStreamSearch/dataStreamSearch.tsx b/...d/src/components/queryEditor/iotSiteWiseQueryEditor/dataStreamSearch/dataStreamSearch.tsx
@@ -7,13 +7,15 @@ import { WorkspaceSelector } from './workspaceSelector';
 import { SearchQueryInput } from './searchQueryInput';
 import type { SearchFields } from './types';
 import { WorkspaceErrorState } from './workspaceErrorState';
+import { getPlugin } from '@iot-app-kit/core';
 
 export interface DataStreamSearchProps {
   client: IoTTwinMakerClient;
   onSubmit: ({ workspace, searchQuery }: SearchFields) => void;
 }
 
 export const DataStreamSearch = ({ onSubmit, client }: DataStreamSearchProps) => {
+  const metricsRecorder = getPlugin('metricsRecorder');
   const { control, handleSubmit } = useForm<SearchFields>({
     defaultValues: { workspace: null, searchQuery: '' },
   });
@@ -35,6 +37,11 @@ export const DataStreamSearch = ({ onSubmit, client }: DataStreamSearchProps) =>
           void handleSubmit((data) => {
             onSubmit(data);
           })();
+
+          metricsRecorder?.record({
+            metricName: 'ModeledDataStreamSearch',
+            metricValue: 1,
+          });
         }}
       >
         <Form

diff --git a/...amQueryEditor/modeledDataStreamExplorer/modeledDataStreamTable/modeledDataStreamTable.tsx b/...amQueryEditor/modeledDataStreamExplorer/modeledDataStreamTable/modeledDataStreamTable.tsx
@@ -21,6 +21,7 @@ import { DashboardState } from '~/store/state';
 import { ResourceExplorerFooter } from '../../../footer/footer';
 import { SelectedAsset } from '../../types';
 import { ResourceExplorerErrorState } from '../../components/resourceExplorerErrorState';
+import { getPlugin } from '@iot-app-kit/core';
 import { isInValidProperty } from './util/resourceExplorerTableLabels';
 
 export interface ModeledDataStreamTableProps {
@@ -46,6 +47,7 @@ export function ModeledDataStreamTable({
   hasNextPage,
   modeledDataStreamsTitle,
 }: ModeledDataStreamTableProps) {
+  const metricsRecorder = getPlugin('metricsRecorder');
   const significantDigits = useSelector((state: DashboardState) => state.significantDigits);
   const selectedWidgets = useSelector((state: DashboardState) => state.selectedWidgets);
 
@@ -159,6 +161,10 @@ export function ModeledDataStreamTable({
           addDisabled={collectionProps.selectedItems?.length === 0 || selectedWidgets.length !== 1}
           onAdd={() => {
             onClickAddModeledDataStreams(collectionProps.selectedItems as unknown as ModeledDataStream[]);
+            metricsRecorder?.record({
+              metricName: 'ModeledDataStreamAdd',
+              metricValue: 1,
+            });
           }}
         />
       }

diff --git a/...yEditor/unmodeledDataStreamExplorer/unmodeledDataStreamTable/unmodeledDataStreamTable.tsx b/...yEditor/unmodeledDataStreamExplorer/unmodeledDataStreamTable/unmodeledDataStreamTable.tsx
@@ -18,6 +18,7 @@ import { useLatestValues } from '../../useLatestValues';
 import { DashboardState } from '~/store/state';
 import { getFormattedDateTimeFromEpoch } from '~/components/util/dateTimeUtil';
 import { ResourceExplorerFooter } from '../../footer/footer';
+import { getPlugin } from '@iot-app-kit/core';
 
 export interface UnmodeledDataStreamTableProps {
   onClickAdd: (unmodeledDataStreams: UnmodeledDataStream[]) => void;
@@ -34,6 +35,7 @@ export function UnmodeledDataStreamTable({
   client,
   hasNextPage,
 }: UnmodeledDataStreamTableProps) {
+  const metricsRecorder = getPlugin('metricsRecorder');
   const significantDigits = useSelector((state: DashboardState) => state.significantDigits);
   const selectedWidgets = useSelector((state: DashboardState) => state.selectedWidgets);
   const [preferences, setPreferences] = useExplorerPreferences({
@@ -113,7 +115,13 @@ export function UnmodeledDataStreamTable({
           resetDisabled={collectionProps.selectedItems?.length === 0}
           onReset={() => actions.setSelectedItems([])}
           addDisabled={collectionProps.selectedItems?.length === 0 || selectedWidgets.length !== 1}
-          onAdd={() => onClickAdd(collectionProps.selectedItems as unknown as UnmodeledDataStream[])}
+          onAdd={() => {
+            onClickAdd(collectionProps.selectedItems as unknown as UnmodeledDataStream[]);
+            metricsRecorder?.record({
+              metricName: 'UnmodeledDataStreamAdd',
+              metricValue: 1,
+            });
+          }}
         />
       }
       resizableColumns