Skip to content

RI-7496 Diff executed commands telemetry by their type (Workbench/Search) #5053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 10, 2025
Merged

RI-7496 Diff executed commands telemetry by their type (Workbench/Search) #5053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e6c718
fix(be): differ executed commands telemetry by their type (workbench/…
valkirilov Oct 9, 2025
c4c8f9e
fix(be): differ failed command executions telemetry by their type (w…
valkirilov Oct 9, 2025
54c328b
fix(be): differ executed info commands telemetry by their type (workb…
valkirilov Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions redisinsight/api/src/constants/telemetry-events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ export enum TelemetryEvents {
WorkbenchIndexInfoSubmitted = 'WORKBENCH_INDEX_INFO_SUBMITTED',
WorkbenchCommandErrorReceived = 'WORKBENCH_COMMAND_ERROR_RECEIVED',
WorkbenchCommandDeleted = 'WORKBENCH_COMMAND_DELETE_COMMAND',

// Events for search tool
SearchCommandExecuted = 'SEARCH_COMMAND_EXECUTED',
SearchIndexInfoSubmitted = 'SEARCH_INDEX_INFO_SUBMITTED',
SearchCommandErrorReceived = 'SEARCH_COMMAND_ERROR_RECEIVED',

// Custom tutorials
WorkbenchEnablementAreaImportSucceeded = 'WORKBENCH_ENABLEMENT_AREA_IMPORT_SUCCEEDED',
WorkbenchEnablementAreaImportFailed = 'WORKBENCH_ENABLEMENT_AREA_IMPORT_FAILED',
Expand Down
22 changes: 21 additions & 1 deletion redisinsight/api/src/modules/workbench/providers/workbench-commands.executor.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ import {
FormatterTypes,
} from 'src/common/transformers';
import { DatabaseClientFactory } from 'src/modules/database/providers/database.client.factory';
import { RunQueryMode } from 'src/modules/workbench/models/command-execution';
import {
CommandExecutionType,
RunQueryMode,
} from 'src/modules/workbench/models/command-execution';
import { WorkbenchAnalytics } from 'src/modules/workbench/workbench.analytics';

const MOCK_ERROR_MESSAGE = 'Some error';
Expand Down Expand Up @@ -85,6 +88,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: 'ft.info idx',
mode: RunQueryMode.Raw,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -99,6 +103,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
[
{
response: mockRedisFtInfoReply,
Expand All @@ -113,6 +118,7 @@ describe('WorkbenchCommandsExecutor', () => {
expect(mockAnalyticsService.sendIndexInfoEvent).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
mockFtInfoAnalyticsData,
);
});
Expand All @@ -122,6 +128,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockCreateCommandExecutionDto.command,
mode: RunQueryMode.ASCII,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -136,6 +143,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
[
{
response: mockCommandExecutionResult.response,
Expand All @@ -156,6 +164,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockCreateCommandExecutionDto.command,
mode: RunQueryMode.ASCII,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -170,6 +179,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
{
response: MOCK_ERROR_MESSAGE,
error: new CommandNotSupportedError(MOCK_ERROR_MESSAGE),
Expand All @@ -192,6 +202,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockCreateCommandExecutionDto.command,
mode: RunQueryMode.ASCII,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -206,6 +217,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
{
response: MOCK_ERROR_MESSAGE,
error: replyError,
Expand All @@ -227,6 +239,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockCreateCommandExecutionDto.command,
mode: RunQueryMode.ASCII,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -242,6 +255,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
[
{
response: mockCommandExecutionResult.response,
Expand All @@ -264,6 +278,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockCreateCommandExecutionDto.command,
mode: RunQueryMode.Raw,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -279,6 +294,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
[
{
response: mockCommandExecutionResult.response,
Expand All @@ -299,6 +315,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockCreateCommandExecutionDto.command,
mode: RunQueryMode.ASCII,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual([
Expand All @@ -313,6 +330,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
{
response: MOCK_ERROR_MESSAGE,
error: new ServiceUnavailableException(MOCK_ERROR_MESSAGE),
Expand All @@ -337,6 +355,7 @@ describe('WorkbenchCommandsExecutor', () => {
const result = await service.sendCommand(client, {
command: mockGetEscapedKeyCommand,
mode: RunQueryMode.ASCII,
type: CommandExecutionType.Workbench,
});

expect(result).toEqual(mockResult);
Expand All @@ -345,6 +364,7 @@ describe('WorkbenchCommandsExecutor', () => {
).toHaveBeenCalledWith(
mockSessionMetadata,
mockWorkbenchClientMetadata.databaseId,
CommandExecutionType.Workbench,
{
response: ERROR_MESSAGES.CLI_UNTERMINATED_QUOTES(),
error: new CommandParsingError(
Expand Down
3 changes: 3 additions & 0 deletions redisinsight/api/src/modules/workbench/providers/workbench-commands.executor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export class WorkbenchCommandsExecutor {
this.analyticsService.sendCommandExecutedEvents(
client.clientMetadata.sessionMetadata,
client.clientMetadata.databaseId,
dto.type,
result,
{ command, rawMode: mode === RunQueryMode.Raw },
);
Expand All @@ -87,6 +88,7 @@ export class WorkbenchCommandsExecutor {
this.analyticsService.sendIndexInfoEvent(
client.clientMetadata.sessionMetadata,
client.clientMetadata.databaseId,
dto.type,
getAnalyticsDataFromIndexInfo(response as string[]),
);
}
Expand All @@ -102,6 +104,7 @@ export class WorkbenchCommandsExecutor {
this.analyticsService.sendCommandExecutedEvent(
client.clientMetadata.sessionMetadata,
client.clientMetadata.databaseId,
dto.type,
{ ...errorResult, error },
{ command, rawMode: dto.mode === RunQueryMode.Raw },
);
Expand Down
Loading
Loading