Skip to content

RI-6848: add info_command_is_disabled to analytics when INFO is disabled via ACL #4390

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 6 commits into from
Feb 25, 2025
Merged

RI-6848: add info_command_is_disabled to analytics when INFO is disabled via ACL #4390

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a7ae5a
RI-6848: add info_command_is_disabled to analytics when INFO is disab…
KrumTy Feb 21, 2025
713a776
add isInfoCommandDisabled prop to RedisClient
KrumTy Feb 21, 2025
d4f4f14
preserve function signature
KrumTy Feb 21, 2025
b2d53dc
set default value for isInfoCommandDisabled
KrumTy Feb 24, 2025
b7bdf81
refactor getInfo
KrumTy Feb 25, 2025
d1d371b
update: always call HELLO if INFO fails
KrumTy Feb 25, 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
2 changes: 1 addition & 1 deletion redisinsight/api/src/modules/database/database-connection.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ describe('DatabaseConnectionService', () => {
expect(databaseInfoProvider.getClientListInfo).toHaveBeenCalled();
expect(analytics.sendDatabaseConnectedClientListEvent).toHaveBeenCalledWith(
mockSessionMetadata,
mockDatabase.id,
{
databaseId: mockDatabase.id,
clients: mockRedisClientListResult.map((c) => ({
version: mockRedisGeneralInfo.version,
resp: get(c, 'resp', 'n/a'),
Expand Down
10 changes: 7 additions & 3 deletions redisinsight/api/src/modules/database/database-connection.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { DatabaseClientFactory } from 'src/modules/database/providers/database.c
import { RedisClient, RedisClientConnectionType } from 'src/modules/redis/client';
import { FeatureService } from 'src/modules/feature/feature.service';
import { KnownFeatures } from 'src/modules/feature/constants';
import { RedisDatabaseInfoResponse } from './dto/redis-info.dto';

@Injectable()
export class DatabaseConnectionService {
Expand Down Expand Up @@ -75,20 +76,23 @@ export class DatabaseConnectionService {
);
}

this.collectClientInfo(clientMetadata, client, generalInfo?.version);
this.collectClientInfo(clientMetadata, client, generalInfo);

this.logger.debug(`Succeed to connect to database ${clientMetadata.databaseId}`, clientMetadata);
}

private async collectClientInfo(clientMetadata: ClientMetadata, client: RedisClient, version?: string) {
private async collectClientInfo(clientMetadata: ClientMetadata, client: RedisClient, generalInfo: RedisDatabaseInfoResponse) {
try {
const version = generalInfo?.server?.redis_version;
const infoCommandIsDisabled = generalInfo?.server?.info_command_is_disabled;
const intVersion = parseInt(version, 10) || 0;
const clients = await this.databaseInfoProvider.getClientListInfo(client) || [];

this.analytics.sendDatabaseConnectedClientListEvent(
clientMetadata.sessionMetadata,
clientMetadata.databaseId,
{
databaseId: clientMetadata.databaseId,
...(infoCommandIsDisabled ? { info_command_is_disabled: true } : {}),
Copy link
Collaborator

@ArtemHoruzhenko ArtemHoruzhenko Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we will add isInfoCommandDisabled flag into RedisClient we can then avoid adding custom logic here and slightly simplify this. It become { isInfoComaandDisabled: client.isInfoCommandDisabled } or something similar

Copy link
Collaborator Author

@KrumTy KrumTy Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated, however I pass no key/value in case of false

clients: clients.map((c) => ({
version: version || 'n/a',
resp: intVersion < 7 ? undefined : c?.['resp'] || 'n/a',
Expand Down
2 changes: 1 addition & 1 deletion redisinsight/api/src/modules/database/database.analytics.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,8 +326,8 @@ describe('DatabaseAnalytics', () => {
it('should emit event', () => {
service.sendDatabaseConnectedClientListEvent(
mockSessionMetadata,
mockDatabase.id,
{
databaseId: mockDatabase.id,
version: mockDatabase.version,
resp: '2',
},
Expand Down
6 changes: 1 addition & 5 deletions redisinsight/api/src/modules/database/database.analytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,17 +126,13 @@ export class DatabaseAnalytics extends TelemetryBaseService {

sendDatabaseConnectedClientListEvent(
sessionMetadata: SessionMetadata,
databaseId: string,
additionalData: object = {},
): void {
try {
this.sendEvent(
sessionMetadata,
TelemetryEvents.DatabaseConnectedClientList,
{
databaseId,
...additionalData,
},
additionalData,
);
} catch (e) {
// continue regardless of error
Expand Down
1 change: 1 addition & 0 deletions redisinsight/api/src/modules/redis/client/redis.client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ export abstract class RedisClient extends EventEmitter2 {
server_name: helloResponse.server,
redis_version: helloResponse.version,
redis_mode: helloResponse.mode,
info_command_is_disabled: true,
},
modules: helloResponse.modules,
};
Expand Down